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

Примечание

Этот модуль входит в коллекцию community.network (версия 5.0.3).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

Для использования в плейбуке укажите: community.network.edgeos_command.

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

Описание

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

Псевдонимы: network.edgeos.edgeos_command

Параметры

Параметр	Комментарии
commands строка / обязательно	Команды или упорядоченный набор команд, которые необходимо выполнить на удалённом устройстве. Вывод команды возвращается в плейбук. Если указан аргумент `wait_for`, модуль не вернётся, пока не будет выполнено условие или не будет превышено число попыток.
interval строка	Количество секунд ожидания между `retries` выполнения команды. По умолчанию: `1`
match строка	Используется совместно с `wait_for` для создания политики соответствия. Если установлено значение `all`, все условия в `wait_for` должны быть выполнены. Если установлено значение `any`, должно совпасть хотя бы одно условие. Выбори: `"any"` `"all"` ← (по умолчанию)
retries строка	Количество попыток выполнения команды перед признанием её неудачной. Команда выполняется на целевом устройстве и оценивается по условиям `wait_for`. По умолчанию: `10`
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/edgeos_command_module.html