dellos9_command - Выполнение команд на удалённых устройствах с Dell OS9
Новая в версии 2.2.
Описание
- Отправляет произвольные команды на узел Dell OS9 и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставит модуль ждать определённого условия перед возвратом или сработает таймаут, если условие не выполняется.
- Этот модуль не поддерживает выполнение команд в режиме конфигурации. Используйте модуль dellos9_config для конфигурирования устройств Dell OS9.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| commands обязательно | Список команд для отправки на удалённое устройство dellos9 через настроенный провайдер. Результат выполнения команды возвращается. Если указан аргумент 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) | Список условий для оценки по результатам выполнения команды. Задача ожидает выполнения каждого условия перед продолжением. Если условие не выполняется в течение заданного количества попыток, задача завершается с ошибкой. См. примеры. | ||
Примечания
Примечание
- Этот модуль требует Dell OS9 версии 9.10.0.1P13 или выше.
- Этот модуль требует увеличения лимита скорости подключения ssh. Используйте следующую команду ip ssh connection-rate-limit 60 для настройки. Это также можно сделать с помощью модуля dellos9_config.
- Дополнительную информацию об использовании Ansible для управления устройствами Dell EMC Network см. на сайте https://www.ansible.com/ansible-dell-networking.
Примеры
tasks:
- name: run show version on remote devices
dellos9_command:
commands: show version
- name: run show version and check to see if output contains OS9
dellos9_command:
commands: show version
wait_for: result[0] contains OS9
- name: run multiple commands on remote nodes
dellos9_command:
commands:
- show version
- show interfaces
- name: run multiple commands and evaluate the output
dellos9_command:
commands:
- show version
- show interfaces
wait_for:
- result[0] contains OS9
- result[1] contains Loopback
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| failed_conditions список | неудачно | Список условных выражений, которые не выполнены Пример: ['...', '...'] |
| stdout список | всегда, кроме ошибок низкого уровня (таких как плагин действия) | Набор ответов от команд Пример: ['...', '...'] |
| stdout_lines список | всегда, кроме ошибок низкого уровня (таких как плагин действия) | Значение stdout, разбитое на список Пример: [['...', '...'], ['...'], ['...']] |
| warnings список | всегда | Список предупреждений (если есть) выданных модулем на основе аргументов Пример: ['...', '...'] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно обратной совместимости.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Dhivya P (@dhivyap)
Подсказка
Если вы обнаружите проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/dellos9_command_module.html
