community.network.exos_command – Выполнение команд на удалённых устройствах, работающих под управлением Extreme EXOS
Примечание
Этот плагин входит в состав коллекции community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в плейбуке укажите: community.network.exos_command.
Обзор
- Отправляет произвольные команды на устройство Extreme EXOS и возвращает результаты, полученные с устройства. В этом модуле есть аргумент, который заставит модуль дождаться выполнения определённого условия перед возвратом или выдать ошибку таймаута, если условие не выполнено.
- Этот модуль не поддерживает выполнение команд конфигурации. Пожалуйста, используйте community.network.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 строка | Список условий для оценки по результатам выполнения команды. Задача ожидает, пока каждое условие не станет истинным, прежде чем продолжить. Если условие не выполняется в течение заданного количества попыток, задача завершается с ошибкой. См. примеры. |
Примечания
Примечание
- Если команда, отправленная на устройство, требует ответа на запрос, можно передать словарь, содержащий command, answer и prompt. См. примеры.
Примеры
tasks:
- name: Run show version on remote devices
community.network.exos_command:
commands: show version
- name: Run show version and check to see if output contains ExtremeXOS
community.network.exos_command:
commands: show version
wait_for: result[0] contains ExtremeXOS
- name: Run multiple commands on remote nodes
community.network.exos_command:
commands:
- show version
- show ports no-refresh
- name: Run multiple commands and evaluate the output
community.network.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
community.network.exos_command:
commands:
- command: 'clear license-info'
prompt: 'Are you sure.*'
answer: 'Yes'
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| failed_conditions список / элементы=строка | неудачно | Список условий, которые не были выполнены Пример: ['...', '...'] |
| stdout список / элементы=строка | всегда, за исключением ошибок низкого уровня (таких как плагин действия) | Набор ответов от команд Пример: ['...', '...'] |
| stdout_lines список / элементы=строка | всегда, за исключением ошибок низкого уровня (таких как плагин действия) | Значение stdout, разделенное на список Пример: [['...', '...'], ['...'], ['...']] |
Авторы
- 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.10/collections/community/network/exos_command_module.html
