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

Примечание

Этот плагин входит в сборку community.network (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.network.

Для использования в плейбуке укажите: community.network.aireos_command.

Обзор
Параметры
Примеры
Возвращаемые значения

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
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
    community.network.aireos_command:
      commands: show sysinfo

  - name: Run show sysinfo and check to see if output contains Cisco Controller
    community.network.aireos_command:
      commands: show sysinfo
      wait_for: result[0] contains 'Cisco Controller'

  - name: Run multiple commands on remote nodes
    community.network.aireos_command:
      commands:
        - show sysinfo
        - show interface summary

  - name: Run multiple commands and evaluate the output
    community.network.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, разделенное на список Пример: [['...', '...'], ['...'], ['...']]

Авторы

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.10/collections/community/network/aireos_command_module.html