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 -			Объект типа dict, содержащий данные подключения.
	host - / обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	password -		Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задании, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port -	По умолчанию: 22	Указывает порт, используемый при построении подключения к удалённому устройству.
	ssh_keyfile -		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации SSH-сессии. Если значение не указано в задании, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout -	По умолчанию: 10	Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку.
	username -		Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задании, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_USERNAME`.
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. [сообщество]

Авторы

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