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

Примечание

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

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

Для использования в книге задач укажите: community.network.aruba_command.

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

Описание

Отправляет произвольные команды на узел Aruba и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставит модуль дождаться выполнения определённого условия перед возвратом или выхода с ошибкой по таймауту, если условие не выполнено.
Этот модуль не поддерживает выполнение команд в конфигурационном режиме. Используйте community.network.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
    community.network.aruba_command:
      commands: show version

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

  - name: Run multiple commands on remote nodes
    community.network.aruba_command:
      commands:
        - show version
        - show interfaces

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