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

Примечание

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

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

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

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

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

Обзор

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

Псевдонимы: network.voss.voss_command

Параметры

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

Примечания

Примечание

Проверено на VOSS 7.0.0

Примеры

tasks:
  - name: Run show sys software on remote devices
    community.network.voss_command:
      commands: show sys software

  - name: Run show sys software and check to see if output contains VOSS
    community.network.voss_command:
      commands: show sys software
      wait_for: result[0] contains VOSS

  - name: Run multiple commands on remote nodes
    community.network.voss_command:
      commands:
        - show sys software
        - show interfaces vlan

  - name: Run multiple commands and evaluate the output
    community.network.voss_command:
      commands:
        - show sys software
        - show interfaces vlan
      wait_for:
        - result[0] contains Version
        - result[1] contains Basic

  - name: Run command that requires answering a prompt
    community.network.voss_command:
      commands:
        - command: 'reset'
          prompt: 'Are you sure you want to reset the switch? (y/n)'
          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/voss_command_module.html