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

Примечание

Этот плагин входит в коллекцию community.network (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.network.

Чтобы использовать его в книге задач, укажите: community.network.edgeos_command.

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

Обзор

Этот модуль команд позволяет выполнять одну или несколько команд на удалённом устройстве с 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
    community.network.edgeos_command:
      commands: reboot now

  - name: Show the configuration for eth0 and eth1
    community.network.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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/edgeos_command_module.html