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 -			Объект словаря, содержащий данные подключения.
	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.8/modules/aireos_command_module.html