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 | Объект словаря, содержащий детали подключения. | ||
| 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
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 список | всегда | Список предупреждений (если есть) сгенерированных модулем на основе аргументов Пример: ['...', '...'] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. Для получения дополнительной информации см. Техническое обслуживание модулей и поддержка.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/dellos10_command_module.html
