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 | По умолчанию: None | Объект типа dict, содержащий детали подключения. | |
| username | Имя пользователя для аутентификации SSH-сессии с удаленным устройством. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| 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 | Список условий, которые должны быть проверены на основе вывода команды. Задача будет ожидать выполнения каждого условия перед выполнением дальнейших действий. Если условие не выполнено в течение заданного числа retries, задача завершается с ошибкой. См. примеры. | |
Примечания
Примечание
- Данный модуль требует версию 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 список | failed | Список условий, которые не были выполнены. Пример: ['...', '...'] |
| stdout список | всегда, за исключением ошибок низкого уровня (таких как плагин действия) | Набор ответов от команд. Пример: ['...', '...'] |
| stdout_lines список | всегда, за исключением ошибок низкого уровня (таких как плагин действия) | Значение stdout разбито на список. Пример: [['...', '...'], ['...'], ['...']] |
| warnings список | всегда | Список предупреждений (если таковые имеются), сгенерированных модулем на основе аргументов. Пример: ['...', '...'] |
Статус
Этот модуль помечен как экспериментальный, что означает, что он не гарантирует обратную совместимость.
Автор
- 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.5/modules/dellos9_command_module.html
