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

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

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
commands обязательно		Команды или упорядоченный набор команд, которые должны быть выполнены на удаленном устройстве. Вывод команды возвращается в playbook. Если предоставлен аргумент `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, разделенное на список Пример: [['...', '...'], ['...'], ['...']]

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет совместим с предыдущими версиями.

Автор

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