dellos10_command - Выполнение команд на удалённых устройствах с Dell OS10
Новая версия с 2.2.
Синопсис
- Отправляет произвольные команды узлу Dell OS10 и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставит модуль ожидать выполнения определённого условия перед возвратом или таймаутом, если условие не выполнено.
- Этот модуль не поддерживает выполнение команд в режиме конфигурации. Пожалуйста, используйте dellos10_config для конфигурации устройств Dell OS10.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| commands обязательно | Список команд, которые необходимо отправить удалённому устройству dellos10 через настроенный поставщик. Результирующий вывод команды возвращается. Если указан аргумент wait_for, модуль не возвращается, пока условие не будет выполнено или не истечёт время ожидания. | ||
| interval | По умолчанию: 1 | Настраивает интервал в секундах для ожидания между попытками выполнения команды. Если команда не удовлетворяет указанным условиям, интервал определяет, сколько времени ожидать перед повторной попыткой выполнения команды. | |
| match (добавлен в 2.5) |
| Аргумент match используется совместно с аргументом wait_for для указания политики сопоставления. Допустимые значения являются all, или any. Если значение установлено в all, все условия в wait_for должны быть выполнены. Если значение установлено в any, достаточно выполнения только одного из условий. | |
| provider | По умолчанию: None | Объект типа dict, содержащий данные подключения. | |
| username | Пользователь для аутентификации SSH-сессии с удалённым устройством. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение хоста используется в качестве адреса назначения для транспорта. | ||
| ssh_keyfile | Путь к SSH-ключу, используемому для аутентификации SSH-сессии с удалённым устройством. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout | По умолчанию: 10 | Указывает таймаут бездействия (в секундах) для подключения. Полезно, если консоль зависает перед продолжением. Например, при сохранении конфигураций. | |
| password | По умолчанию: None | Пароль для аутентификации SSH-сессии с удалённым устройством. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | |
| port | По умолчанию: 22 | Указывает порт, который следует использовать при создании подключения к удалённому устройству. | |
| retries | По умолчанию: 10 | Указывает количество попыток выполнения команды до того, как она будет считана неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for. | |
| wait_for (добавлен в 2.2) | По умолчанию: None | Список условий, которые необходимо проверить по отношению к выводу команды. Задача будет ожидать выполнения каждого условия, прежде чем двигаться дальше. Если условие не выполняется в течение заданного количества попыток, задача завершается неудачей. См. примеры. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Dell EMC Network см. на https://www.ansible.com/ansible-dell-networking.
Примеры
tasks:
- name: run show version on remote devices
dellos10_command:
commands: show version
- name: run show version and check to see if output contains OS10
dellos10_command:
commands: show version
wait_for: result[0] contains OS10
- name: run multiple commands on remote nodes
dellos10_command:
commands:
- show version
- show interface
- name: run multiple commands and evaluate the output
dellos10_command:
commands:
- show version
- show interface
wait_for:
- result[0] contains OS10
- result[1] contains Ethernet
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| failed_conditions список | неудача | Список условий, которые не были выполнены Пример: ['...', '...'] |
| stdout список | всегда, кроме ошибок низкого уровня (например, плагина действия) | Набор ответов от команд Пример: ['...', '...'] |
| stdout_lines список | всегда, кроме ошибок низкого уровня (например, плагина действия) | Значение stdout, разделенное на список Пример: [['...', '...'], ['...'], ['...']] |
| warnings список | всегда | Список предупреждений (при наличии), сгенерированных модулем на основе аргументов Пример: ['...', '...'] |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- Senthil Kumar Ganesan (@skg-net)
Подсказка
Если вы заметите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/dellos10_command_module.html
