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

Примечание

Этот плагин входит в сборку community.network (версия 1.3.0).

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

Чтобы использовать его в плейбуке, укажите: 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/voss_command_module.html