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

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

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
commands обязательно		Список команд, которые необходимо отправить удалённому устройству aruba через настроенный поставщик. Результирующий вывод команды возвращается. Если указан аргумент wait_for, модуль не возвращается до тех пор, пока условие не будет выполнено или не истечёт количество попыток.
interval	Значение по умолчанию: 1	Настраивает интервал в секундах ожидания между повторениями команды. Если команда не удовлетворяет указанным условиям, интервал определяет, сколько времени нужно подождать, прежде чем попробовать команду снова.
match	Варианты: any all ←	Аргумент match используется совместно с аргументом wait_for для указания политики сопоставления. Допустимые значения — `all` или `any`. Если значение установлено на `all`, все условия в wait_for должны быть выполнены. Если значение установлено на `any`, достаточно выполнения только одного из условий.
provider	Значение по умолчанию: None	Объект словаря, содержащий данные подключения.
username		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_USERNAME`.
host обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение хоста используется в качестве целевого адреса для транспорта.
ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
timeout	Значение по умолчанию: 10	Указывает таймаут в секундах для взаимодействия с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку.
password	Значение по умолчанию: None	Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
port	Значение по умолчанию: 22	Указывает порт, используемый при установлении соединения с удалённым устройством.
retries	Значение по умолчанию: 10	Указывает количество попыток повторения команды, прежде чем она будет считана неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for.
wait_for	Значение по умолчанию: None	Список условий для оценки по выводу команды. Задача будет ждать, пока каждое условие не станет истинным, прежде чем переходить к следующему шагу. Если условие не выполнится в течение настроенного числа попыток, задача завершается с ошибкой. См. примеры. алиасы: 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, разбитое на список Пример: [['...', '...'], ['...'], ['...']]

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.

Автор

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.5/modules/aruba_command_module.html