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.8/modules/edgeos_command_module.html