eric_eccli_command – Выполнение команд на удалённых устройствах, работающих на ERICSSON ECCLI
Новое в версии 2.9.
Описание
- Отправляет произвольные команды на узел ERICSSON eccli и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставит модуль ожидать определённого условия перед возвратом или выполнить таймаут, если условие не выполняется.
- Этот модуль также поддерживает выполнение команд в режиме конфигурации в стиле прямых команд.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| commands список / обязательный | Список команд, которые нужно отправить на удалённое устройство ECCLI через настроенного провайдера. Возвращается результат выполнения команды. Если предоставлен аргумент wait_for, модуль не возвращается, пока условие не будет выполнено или не истечёт количество попыток. Если команда, отправленная устройству, требует ответа на запрос, можно передать словарь, содержащий команда, ответ и запрос. Распространённые ответы — 'y' или "\r" (возврат каретки, в двойных кавычках). См. примеры. | |
| interval целое число | Значение по умолчанию: 1 | Настраивает интервал в секундах ожидания между повторными попытками выполнения команды. Если команда не удовлетворяет указанным условиям, интервал указывает, сколько времени ждать перед повторной попыткой выполнения команды. |
| match строка |
| Аргумент match используется совместно с аргументом wait_for для указания политики сопоставления. Допустимые значения — all или any. Если значение установлено на all, должны выполняться все условия в wait_for. Если значение установлено на any, достаточно выполнения только одного из условий. |
| retries целое число | Значение по умолчанию: 10 | Указывает количество попыток выполнения команды перед тем, как она будет считана неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for. |
| wait_for список | Список условий, которые нужно оценить по результатам выполнения команды. Задача будет ожидать выполнения каждого условия перед продолжением. Если условие не выполняется в течение заданного количества попыток, задача завершается неудачно. См. примеры. псевдонимы: waitfor |
Примечания
Примечание
- Проверено с IPOS 19.3
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по Ansible для сетей
- Дополнительную информацию об использовании Ansible для управления устройствами Ericsson см. в документации Ericsson.
- Начиная с Ansible 2.5, рекомендуется использовать
connection: network_cli. - Дополнительную информацию см. в руководстве по платформам ERIC_ECCLI.
Примеры
tasks:
- name: run show version on remote devices
eric_eccli_command:
commands: show version
- name: run show version and check to see if output contains IPOS
eric_eccli_command:
commands: show version
wait_for: result[0] contains IPOS
- name: run multiple commands on remote nodes
eric_eccli_command:
commands:
- show version
- show running-config interfaces
- name: run multiple commands and evaluate the output
eric_eccli_command:
commands:
- show version
- show running-config interfaces
wait_for:
- result[0] contains IPOS
- result[1] contains management
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| failed_conditions список | неудача | Список условий, которые не выполнены Пример: ['...', '...'] |
| stdout список | всегда, кроме ошибок низкого уровня (например, ошибки плагина действия) | Набор ответов от команд Пример: ['...', '...'] |
| stdout_lines список | всегда, кроме ошибок низкого уровня (например, ошибки плагина действия) | Значение stdout, разделенное на список Пример: [['...', '...'], ['...'], ['...']] |
Статус
- Не гарантируется обратная совместимость интерфейса модуля. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Команда Ericsson IPOS OAM (@itercheng)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете изменить этот документ для улучшения.
© 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/eric_eccli_command_module.html
