edgeos_command – Выполнение одной или нескольких команд на устройствах EdgeOS

Новое в версии 2.5.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Этот модуль команд позволяет выполнять одну или несколько команд на удалённом устройстве, работающем на EdgeOS, например, на маршрутизаторе Ubiquiti EdgeRouter.
Этот модуль не поддерживает выполнение команд в режиме конфигурации.
Некоторые show команды в EdgeOS генерируют большое количество строк вывода и используют пользовательскую страницу отображения, что может привести к зависанию этого модуля. Если переменная окружения ANSIBLE_EDGEOS_TERMINAL_LENGTH не задана, используется значение по умолчанию 10000.
Этот модуль является сетевым и требует connection: network_cli для корректной работы.
Дополнительную информацию можно найти в Руководстве по сети.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
commands - / обязательный		Команды или упорядоченный набор команд, которые должны быть выполнены на удалённом устройстве. Вывод команды возвращается в конфигурационный файл. Если предоставлен аргумент `wait_for`, модуль не возвращается, пока условие не будет выполнено или не будет превышено количество попыток.
interval -	Значение по умолчанию: 1	Количество секунд, которое нужно ждать между `retries` команды.
match -	Варианты: any all ←	Используется в сочетании с `wait_for` для создания политики соответствия. Если установлено значение `all`, все условия в `wait_for` должны быть выполнены. Если установлено значение `any`, должно совпасть только одно условие.
retries -	Значение по умолчанию: 10	Количество попыток выполнения команды, после которого она считается неудачной. Команда выполняется на целевом устройстве и оценивается в соответствии с `wait_for` условиями.
wait_for -		Принуждает задачу ждать выполнения определенного условия, прежде чем переходить дальше. Если условие не выполняется до превышения указанного количества попыток, задача завершится ошибкой.

Примечания

Примечание

Проверено на EdgeOS 1.9.7
Выполнение show system boot-messages all приведет к зависанию модуля, так как EdgeOS использует пользовательские настройки отображения вывода этой команды.

Примеры

tasks:
  - name: Reboot the device
    edgeos_command:
      commands: reboot now

  - name: Show the configuration for eth0 and eth1
    edgeos_command:
      commands: show interfaces ethernet {{ item }}
    loop:
      - eth0
      - eth1

Возвращаемые значения

Общие возвращаемые значения описаны в разделе здесь, а следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
stdout список	всегда, кроме ошибок низкого уровня (например, ошибки плагина действия)	Набор ответов от команд Пример: ['...', '...']
stdout_lines список	всегда	Значение stdout, разделенное на список Пример: [['...', '...'], ['...'], ['...']]

Статус

Гарантия обратной совместимости этого модуля не предоставляется. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Chad Norgan (@BeardyMcBeards)
Sam Doran (@samdoran)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/edgeos_command_module.html