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. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом 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.6/modules/edgeos_command_module.html