onyx_command – Выполнение команд на удалённых устройствах с Mellanox ONYX

Новое в версии 2.5.

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
commands - / обязательно			Список команд для отправки удалённому сетевому устройству Mellanox ONYX. Результирующий вывод команды возвращается. Если предоставлен аргумент wait_for, модуль не возвращается, пока условие не будет выполнено или не истечёт время ожидания.
interval -		По умолчанию: 1	Настраивает интервал в секундах ожидания между повторами команды. Если команда не удовлетворяет указанным условиям, интервал указывает, сколько времени ждать перед повторной попыткой выполнения команды.
match -		Варианты: any all ←	Аргумент match используется совместно с аргументом wait_for для определения политики соответствия. Допустимые значения — `all` или `any`. Если значение установлено в `all`, все условные выражения в wait_for должны быть выполнены. Если значение установлено в `any`, должно быть выполнено только одно из значений.
provider -			Объект типа dict, содержащий детали подключения.
	auth_pass -		Указывает пароль, который необходимо использовать, если требуется зайти в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean	Варианты: no ← yes	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
	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 -			Список условий для оценки по результатам выполнения команды. Задача ожидает, чтобы каждое условие стало истинным, прежде чем двигаться дальше. Если условие не выполнится в течение заданного числа попыток, задача завершается ошибкой. См. примеры.

Примечания

Примечание

Проверено на ONYX 3.6.4000

Примеры

tasks:
  - name: run show version on remote devices
    onyx_command:
      commands: show version

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

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

  - name: run multiple commands and evaluate the output
    onyx_command:
      commands:
        - show version
        - show interfaces
      wait_for:
        - result[0] contains MLNXOS
        - result[1] contains mgmt1

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие являются полями, уникальными для этого модуля:

Ключ	Возвращено	Описание
failed_conditions список	неудачно	Список условных выражений, которые не выполнены Пример: ['...', '...']
stdout список	всегда, за исключением ошибок низкого уровня (таких как плагин действия)	Набор ответов от команд Пример: ['...', '...']
stdout_lines список	всегда, за исключением ошибок низкого уровня (таких как плагин действия)	Значение stdout, разделенное на список Пример: [['...', '...'], ['...'], ['...']]

Статус

Гарантия обратной совместимости интерфейса этого модуля не предоставляется. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Samer Deeb (@samerd)

Подсказка

Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать его, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/onyx_command_module.html