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

Новое в версии 2.7.

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

Описание

Отправляет произвольные команды на устройство Extreme VSP, работающее под управлением VOSS, и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставит модуль дождаться выполнения определённого условия перед возвратом или таймаутом, если условие не выполняется.
Этот модуль не поддерживает выполнение команд в режиме конфигурации. Пожалуйста, используйте 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
    voss_command:
      commands: show sys software

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

  - name: run multiple commands on remote nodes
    voss_command:
      commands:
        - show sys software
        - show interfaces vlan

  - name: run multiple commands and evaluate the output
    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
    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, разделенное на список Пример: [['...', '...'], ['...'], ['...']]

Статус

Интерфейс этого модуля не гарантирует обратной совместимости. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.9/modules/voss_command_module.html