aireos_command - Выполнение команд на удалённых устройствах Cisco WLC

Новая версия с 2.4.

Описание
Параметры
Примеры
Возвращаемые значения
Статус
- Автор

Описание

Отправляет произвольные команды узлу aireos и возвращает результаты, считанные с устройства. В этом модуле есть аргумент, который заставит модуль дождаться выполнения определённого условия перед возвратом или таймаутом, если условие не выполняется.
Этот модуль не поддерживает выполнение команд в режиме конфигурации. Используйте aireos_config для конфигурации устройств WLC.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
commands обязательно			Список команд, которые нужно отправить удалённому устройству aireos через настроенного поставщика. Результирующий вывод команды возвращается. Если указан аргумент wait_for, модуль не возвращается до тех пор, пока условие не будет выполнено или не истечёт время ожидания.
interval		По умолчанию: 1	Настраивает интервал в секундах для ожидания между повторами команды. Если команда не удовлетворяет заданным условиям, интервал указывает, сколько ждать перед повторной попыткой выполнения команды.
match		Варианты: any all ←	Аргумент 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		По умолчанию: None	Список условий, которые нужно проверить по выводу команды. Задача будет ждать, пока каждое условие не станет истинным, прежде чем продолжить. Если условие не станет истинным в течение заданного количества попыток, задача завершается с ошибкой. См. примеры. псевдонимы: 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 список	failed	Список условных операторов, которые не выполнены Пример: ['...', '...']
stdout список	всегда кроме низкоуровневых ошибок (например, плагин действия)	Набор ответов от команд Пример: ['...', '...']
stdout_lines список	всегда кроме низкоуровневых ошибок (например, плагин действия)	Значение stdout, разделённое на список Пример: [['...', '...'], ['...'], ['...']]

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.

Автор

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.5/modules/aireos_command_module.html