sros_command – Выполнение команд на удалённых устройствах с Nokia SR OS
Описание
- Отправляет произвольные команды узлу SR OS и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставит модуль подождать определённого условия перед возвратом или выполнить таймаут, если условие не будет выполнено.
- Этот модуль не поддерживает выполнение команд в режиме конфигурации. Для настройки устройств SR OS используйте sros_config.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| commands - / обязательно | Список команд для отправки на удалённое устройство SR OS через настроенный поставщик. Возвращается результирующий вывод команды. Если предоставлен аргумент wait_for, модуль возвращает результат только после выполнения условия или истечения числа попыток. | ||
| interval - | Значение по умолчанию: 1 | Устанавливает интервал в секундах ожидания между попытками выполнения команды. Если команда не выполняется в соответствии с заданными условиями, интервал указывает, сколько времени ждать перед повторной попыткой выполнения. | |
| match - |
| Аргумент match используется совместно с аргументом wait_for для задания политики сопоставления. Допустимые значения — all или any. Если значение установлено в all, все условные обозначения в wait_for должны быть выполнены. Если значение установлено в any, должно быть выполнено только одно из значений. | |
| provider словарь | Объект типа dict, содержащий данные подключения. | ||
| host строка / обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задании, вместо него используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | Значение по умолчанию: 22 | Указывает порт для подключения к удалённому устройству. | |
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задании, вместо него используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. | |
| username строка | Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задании, вместо него используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| retries - | Значение по умолчанию: 10 | Указывает количество попыток выполнения команды, после которых она считается неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for. | |
| wait_for - | Список условий для проверки по выводу команды. Задание будет ожидать выполнения каждого условия до продолжения. Если условие не выполняется в течение заданного числа попыток, задание завершается ошибкой. См. примеры. псевдонимы: waitfor | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами Nokia SR OS см. на странице https://www.ansible.com/ansible-nokia.
Примеры
# Note: examples below use the following provider dict to handle
# transport and authentication to the node.
---
vars:
cli:
host: "{{ inventory_hostname }}"
username: admin
password: admin
transport: cli
---
tasks:
- name: run show version on remote devices
sros_command:
commands: show version
provider: "{{ cli }}"
- name: run show version and check to see if output contains sros
sros_command:
commands: show version
wait_for: result[0] contains sros
provider: "{{ cli }}"
- name: run multiple commands on remote nodes
sros_command:
commands:
- show version
- show port detail
provider: "{{ cli }}"
- name: run multiple commands and evaluate the output
sros_command:
commands:
- show version
- show port detail
wait_for:
- result[0] contains TiMOS-B-14.0.R4
provider: "{{ cli }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, а ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| failed_conditions список | неудачные | Список условий, которые не были выполнены Пример: ['...', '...'] |
| stdout список | всегда, кроме низкоуровневых ошибок (таких как плагин действий) | Набор ответов от команд Пример: ['...', '...'] |
| stdout_lines список | всегда, кроме низкоуровневых ошибок (таких как плагин действий) | Значение stdout, разделенное на список Пример: [['...', '...'], ['...'], ['...']] |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается партнёром Ansible. [сертифицировано]
Авторы
- Peter Sprygada (@privateip)
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/sros_command_module.html
