community.network.voss_command – Выполнение команд на удалённых устройствах, работающих под управлением Extreme VOSS

Примечание

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

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

Для использования в playbook, укажите: community.network.voss_command.

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
commands строка / обязательно		Список команд, которые нужно отправить удалённому устройству VOSS. Результаты выполнения команды возвращаются. Если указан аргумент wait_for, модуль не возвращает значение, пока условие не будет выполнено или не истечёт время ожидания. Если команда, отправленная на устройство, требует ответа на запрос, можно передать словарь, содержащий command, answer и prompt. Общие ответы – 'y' или "\r" (возврат каретки, должно быть в двойных кавычках). См. примеры.
interval строка	Значение по умолчанию: 1	Настраивает интервал в секундах, через который нужно ждать между повторными попытками выполнения команды. Если команда не удовлетворяет указанным условиям, интервал определяет, сколько времени нужно подождать перед повторной попыткой выполнения команды.
match строка	Варианты: any all ←	Аргумент match используется совместно с аргументом wait_for для определения политики сопоставления. Допустимые значения – `all` или `any`. Если значение установлено на `all`, все условия в wait_for должны быть выполнены. Если значение установлено на `any`, достаточно выполнения одного из условий.
retries строка	Значение по умолчанию: 10	Указывает количество попыток выполнения команды перед тем, как она будет считаться неудачной. Команда выполняется на целевом устройстве при каждой попытке и проверяется на соответствие условиям wait_for.
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/voss_command_module.html