aruba_command – Выполнение команд на удалённых устройствах с Aruba Mobility Controller

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

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

Описание

Отправляет произвольные команды на узел aruba и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставит модуль ожидать выполнения определённого условия до возврата или выхода по таймауту, если условие не выполняется.
Этот модуль не поддерживает выполнение команд в режиме конфигурации. Используйте aruba_config для конфигурации устройств Aruba.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
commands - / обязательно			Список команд для отправки на удалённое устройство aruba через настроенный поставщик. Возвращается результат выполнения команды. Если указан аргумент 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 version on remote devices
    aruba_command:
      commands: show version

  - name: run show version and check to see if output contains Aruba
    aruba_command:
      commands: show version
      wait_for: result[0] contains Aruba

  - name: run multiple commands on remote nodes
    aruba_command:
      commands:
        - show version
        - show interfaces

  - name: run multiple commands and evaluate the output
    aruba_command:
      commands:
        - show version
        - show interfaces
      wait_for:
        - result[0] contains Aruba
        - 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/aruba_command_module.html