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

Примечание

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

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

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

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

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

Описание

Отправляет произвольные команды на устройство Extreme EXOS и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставит модуль ждать выполнения определённого условия перед возвратом или сработает таймаут, если условие не выполнится.
Этот модуль не поддерживает выполнение команд конфигурации. Используйте community.network.exos_config для конфигурации устройств EXOS.

Псевдонимы: network.exos.exos_command

Параметры

Параметр	Комментарии
commands строка / обязательный	Список команд для отправки на удалённое устройство EXOS через настроенный провайдер. Результирующий вывод команды возвращается. Если предоставлен аргумент wait_for, модуль не возвращается до тех пор, пока условие не будет выполнено или не истечёт количество попыток.
interval строка	Настраивает интервал в секундах для ожидания между повторными попытками выполнения команды. Если команда не удовлетворяет заданным условиям, интервал указывает, как долго ждать перед повторной попыткой. По умолчанию: `1`
match строка	Аргумент match используется совместно с аргументом wait_for для указания политики сопоставления. Допустимые значения: `all` или `any`. Если значение установлено в `all`, все условные операторы в wait_for должны быть выполнены. Если значение установлено в `any`, достаточно выполнения одного из условий. Доступные значения: `"any"` `"all"` ← (по умолчанию)
retries строка	Указывает количество попыток выполнения команды, прежде чем она считается неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for. По умолчанию: `10`
wait_for строка	Список условий для проверки с выводом команды. Задача будет ждать, пока каждое условие не станет истинным, прежде чем продолжить. Если условие не станет истинным в течение настроенного количества попыток, задача завершается неудачей. Смотрите примеры.

Примечания

Примечание

Если команда, отправленная на устройство, требует ответа на вопрос, можно передать словарь, содержащий command, answer и prompt. Смотрите примеры.

Примеры

tasks:
  - name: Run show version on remote devices
    community.network.exos_command:
      commands: show version
  - name: Run show version and check to see if output contains ExtremeXOS
    community.network.exos_command:
      commands: show version
      wait_for: result[0] contains ExtremeXOS
  - name: Run multiple commands on remote nodes
    community.network.exos_command:
      commands:
        - show version
        - show ports no-refresh
  - name: Run multiple commands and evaluate the output
    community.network.exos_command:
      commands:
        - show version
        - show ports no-refresh
      wait_for:
        - result[0] contains ExtremeXOS
        - result[1] contains 20
  - name: Run command that requires answering a prompt
    community.network.exos_command:
      commands:
        - command: 'clear license-info'
          prompt: 'Are you sure.*'
          answer: 'Yes'

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
failed_conditions список / элементы=строка	Список условных операторов, которые завершились неудачей Возвращается: неудача Пример: `["...", "..."]`
stdout список / элементы=строка	Набор ответов от команд Возвращается: всегда, кроме ошибок низкого уровня (например, плагин действия) Пример: `["...", "..."]`
stdout_lines список / элементы=строка	Значение stdout, разделенное на список Возвращается: всегда, кроме ошибок низкого уровня (например, плагин действия) Пример: `[["...", "..."], ["..."], ["..."]]`

Авторы

Rafael D. Vencioneck (@rdvencioneck)

Ссылки на коллекцию

© 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/exos_command_module.html