aireos_command - Выполнение команд на удалённых устройствах Cisco WLC, работающих под управлением AireOS
Новая в версии 2.4.
Описание
- Отправляет произвольные команды на узел aireos и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставляет модуль ожидать выполнения определённого условия перед возвратом или таймаутом, если условие не выполняется.
- Этот модуль не поддерживает выполнение команд в режиме конфигурации. Используйте aireos_config для конфигурирования устройств WLC.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| commands обязательно | Список команд для отправки на удалённое устройство aireos через настроенный поставщик. Результат выполнения команды возвращается. Если указан аргумент wait_for, модуль не возвращается, пока условие не будет выполнено или истечёт время ожидания. | ||
| interval | По умолчанию: 1 | Настраивает интервал в секундах для ожидания между повторами команды. Если команда не удовлетворяет указанным условиям, интервал определяет время ожидания перед повторной попыткой выполнения команды. | |
| match |
| Аргумент 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. | ||
| timeout | По умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством, либо для подключения, либо для отправки команд. Если время ожидания истекает до завершения операции, модуль выдаст ошибку. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| retries | По умолчанию: 10 | Указывает количество попыток выполнения команды до её признания неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for. | |
| wait_for | Список условий для проверки по выводу команды. Задача будет ждать выполнения каждого условия перед продолжением. Если условие не выполняется в течение указанного количества попыток, задача завершается ошибкой. См. примеры. псевдонимы: waitfor | ||
Примеры
tasks:
- name: run show sysinfo on remote devices
aireos_command:
commands: show sysinfo
- name: run show sysinfo and check to see if output contains Cisco Controller
aireos_command:
commands: show sysinfo
wait_for: result[0] contains 'Cisco Controller'
- name: run multiple commands on remote nodes
aireos_command:
commands:
- show sysinfo
- show interface summary
- name: run multiple commands and evaluate the output
aireos_command:
commands:
- show sysinfo
- show interface summary
wait_for:
- result[0] contains Cisco Controller
- result[1] contains Loopback0
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для этого модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| failed_conditions список | неуспех | Список условий, которые не выполнены Пример: ['...', '...'] |
| stdout список | всегда, кроме ошибок низкого уровня (таких как плагин действия) | Набор ответов от команд Пример: ['...', '...'] |
| stdout_lines список | всегда, кроме ошибок низкого уровня (таких как плагин действия) | Значение stdout, разделённое на список Пример: [['...', '...'], ['...'], ['...']] |
Статус
Этот модуль помечен как превью, что означает отсутствие гарантии обратной совместимости интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- James Mighion (@jmighion)
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать его, чтобы улучшить его.
© 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/aireos_command_module.html
