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

Примечание

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

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

Чтобы использовать его в плейбуке, укажите: community.network.aireos_command.

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

Обзор

Отправляет произвольные команды узлу aireos и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставляет модуль ожидать выполнения определённого условия перед возвратом или таймаутом, если условие не выполняется.
Команды, выполняемые в режиме конфигурации с этим модулем, не являются идемпотентными. Используйте community.network.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
    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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/aireos_command_module.html