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

Примечание

Этот плагин является частью коллекции community.network (версия 1.3.0).

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

Для использования в playbook укажите: 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 строка			Объект типа dict, содержащий данные подключения.
	host строка / обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение хоста используется в качестве адреса назначения для транспорта.
	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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/aruba_command_module.html