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