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. [сообщество]

Авторы

Чэд Норган (@beardymcbeards)
Сэм Доран (@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.9/modules/edgeos_command_module.html