slxos_command – Выполнение команд на удалённых устройствах Extreme Networks SLX-OS
Новая версия с 2.6.
Описание
- Отправляет произвольные команды узлу SLX и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставит модуль ожидать выполнения определённого условия перед возвратом или истечением времени ожидания, если условие не выполнено.
- Этот модуль не поддерживает выполнение команд в режиме конфигурации. Используйте slxos_config для настройки устройств SLX-OS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| commands - / обязательно | Список команд, которые нужно отправить на удалённое устройство SLX-OS через настроенного поставщика. Возвращается результат выполнения команды. Если указан аргумент wait_for, модуль возвращает результат только после выполнения условия или истечения времени ожидания. | |
| interval - | Значение по умолчанию: 1 | Настраивает интервал в секундах ожидания между повторами команды. Если команда не выполняет указанных условий, интервал определяет, сколько времени ждать перед повторной попыткой. |
| match - |
| Аргумент match используется совместно с аргументом wait_for для определения политики соответствия. Допустимые значения — all или any. Если значение установлено в all, все условия в wait_for должны быть выполнены. Если значение установлено в any, должно быть выполнено хотя бы одно из условий. |
| retries - | Значение по умолчанию: 10 | Указывает количество попыток выполнения команды перед тем, как считать её неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for. |
| wait_for - | Значение по умолчанию: null | Список условий для оценки по результатам выполнения команды. Задача ожидает выполнения каждого условия перед продолжением. Если условие не выполняется в течение заданного количества попыток, задача завершается неудачей. См. примеры. |
Примечания
Примечание
- Проверено на SLX-OS 17s.1.02
- Если команда, отправленная на устройство, требует ответа на запрос, можно передать словарь, содержащий command, answer и prompt. См. примеры.
Примеры
tasks:
- name: run show version on remote devices
slxos_command:
commands: show version
- name: run show version and check to see if output contains SLX
slxos_command:
commands: show version
wait_for: result[0] contains SLX
- name: run multiple commands on remote nodes
slxos_command:
commands:
- show version
- show interfaces
- name: run multiple commands and evaluate the output
slxos_command:
commands:
- show version
- show interface status
wait_for:
- result[0] contains SLX
- result[1] contains Eth
- name: run command that requires answering a prompt
slxos_command:
commands:
- command: 'clear sessions'
prompt: 'This operation will logout all the user sessions. Do you want to continue (yes/no)?:'
answer: y
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| failed_conditions список | неудача | Список условий, которые не были выполнены Пример: ['...', '...'] |
| stdout список | всегда, за исключением ошибок низкого уровня (например, плагин действий) | Набор ответов от команд Пример: ['...', '...'] |
| stdout_lines список | всегда, за исключением ошибок низкого уровня (например, плагин действий) | Значение stdout, разделенное на список Пример: [['...', '...'], ['...'], ['...']] |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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/slxos_command_module.html
