voss_command – Выполнение команд на удалённых устройствах, работающих под управлением Extreme VOSS
Новое в версии 2.7.
Описание
- Отправляет произвольные команды на устройство Extreme VSP, работающее под управлением VOSS, и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставит модуль дождаться выполнения определённого условия перед возвратом или выдать таймаут, если условие не будет выполнено.
- Этот модуль не поддерживает выполнение команд в режиме конфигурации.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| commands - / обязательно | Список команд для отправки удалённому устройству VOSS. Результат выполнения команды возвращается. Если предоставлен аргумент wait_for, модуль не возвращается, пока условие не будет выполнено или не истечёт время ожидания. Если команда, отправленная устройству, требует ответа на приглашение, можно передать словарь, содержащий command, answer и prompt. Общие ответы — 'y' или "\r" (возврат каретки, должна быть в двойных кавычках). См. примеры. | |
| interval - | Значение по умолчанию: 1 | Настраивает интервал в секундах ожидания между повторами выполнения команды. Если команда не выполняется в соответствии с указанными условиями, интервал указывает, сколько времени ждать перед повторной попыткой выполнения команды. |
| match - |
| Аргумент 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.7/modules/voss_command_module.html
