exos_command – Выполнение команд на удалённых устройствах с Extreme EXOS
Новая версия с 2.6.
Описание
- Отправляет произвольные команды на устройство Extreme EXOS и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставит модуль ожидать определённого условия перед возвратом или истечения времени ожидания, если условие не выполнено.
- Этот модуль не поддерживает выполнение команд конфигурации. Используйте exos_config для конфигурации устройств EXOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| commands - / обязательно | Список команд для отправки на удалённое устройство EXOS через настроенный поставщик. Возвращается результат выполнения команды. Если указан аргумент wait_for, модуль не возвращает значение, пока условие не будет выполнено или истечёт количество попыток. | |
| interval - | По умолчанию: 1 | Настраивает интервал в секундах ожидания между попытками выполнения команды. Если команда не удовлетворяет указанным условиям, интервал определяет время ожидания перед повторной попыткой выполнения команды. |
| match - |
| Аргумент match используется совместно с аргументом wait_for для указания политики соответствия. Допустимые значения — all, или any. Если значение установлено в all, все условия в wait_for должны быть выполнены. Если значение установлено в any, достаточно выполнения одного из условий. |
| retries - | По умолчанию: 10 | Устанавливает количество попыток выполнения команды перед её признанием неудачной. Команда выполняется на целевом устройстве при каждой попытке и проверяется на соответствие условиям wait_for. |
| wait_for - | Список условий, которые проверяются на основе результата выполнения команды. Задача ожидает выполнения каждого условия перед продолжением. Если условие не выполняется в течение заданного количества попыток, задача завершается неудачно. См. примеры. |
Примечания
Примечание
- Если для отправленной на устройство команды требуется ввод с запросом, можно передать словарь, содержащий команду, ответ и запрос. См. примеры.
Примеры
tasks:
- name: run show version on remote devices
exos_command:
commands: show version
- name: run show version and check to see if output contains ExtremeXOS
exos_command:
commands: show version
wait_for: result[0] contains ExtremeXOS
- name: run multiple commands on remote nodes
exos_command:
commands:
- show version
- show ports no-refresh
- name: run multiple commands and evaluate the output
exos_command:
commands:
- show version
- show ports no-refresh
wait_for:
- result[0] contains ExtremeXOS
- result[1] contains 20
- name: run command that requires answering a prompt
exos_command:
commands:
- command: 'clear license-info'
prompt: 'Are you sure.*'
answer: 'Yes'
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| failed_conditions список | неудачные | Список условий, которые не выполнены Пример: ['...', '...'] |
| stdout список | всегда кроме ошибок низкого уровня (таких как плагин действия) | Набор ответов от команд Пример: ['...', '...'] |
| stdout_lines список | всегда кроме ошибок низкого уровня (таких как плагин действия) | Значение stdout, разделенное на список Пример: [['...', '...'], ['...'], ['...']] |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Rafael D. Vencioneck (@rdvencioneck)
Подсказка
Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/exos_command_module.html