Модуль community.network.nos_command — Выполнение команд на удалённых устройствах с Extreme Networks NOS

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: community.network.nos_command.

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

Описание

Отправляет произвольные команды устройству NOS и возвращает результаты, считанные с устройства. В этом модуле есть аргумент, который заставит модуль ожидать определённого условия перед возвратом или вызовет таймаут, если условие не будет выполнено.
Этот модуль не поддерживает выполнение команд в режиме конфигурации. Для настройки устройств NOS используйте community.network.nos_config.

Псевдонимы: network.nos.nos_command

Параметры

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

Примечания

Примечание

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

Примеры

tasks:
  - name: Run show version on remote devices
    community.network.nos_command:
      commands: show version

  - name: Run show version and check to see if output contains NOS
    community.network.nos_command:
      commands: show version
      wait_for: result[0] contains NOS

  - name: Run multiple commands on remote nodes
    community.network.nos_command:
      commands:
        - show version
        - show interfaces

  - name: Run multiple commands and evaluate the output
    community.network.nos_command:
      commands:
        - show version
        - show interface status
      wait_for:
        - result[0] contains NOS
        - result[1] contains Te
  - name: Run command that requires answering a prompt
    community.network.nos_command:
      commands:
        - command: 'clear sessions'
          prompt: 'This operation will logout all the user sessions. Do you want to continue (yes/no)?:'
          answer: y

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

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

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

Авторы

Lindsay Hill (@LindsayHill)

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

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