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

Примечание

Этот плагин входит в коллекцию mellanox.onyx (версия 1.0.0).

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

Для использования в книге задач укажите: mellanox.onyx.onyx_command.

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

Обзор

Отправляет произвольные команды устройству 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`, должно быть удовлетворено только одно из условий.
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, разделенное на список. Пример: [['...', '...'], ['...'], ['...']]

Авторы

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.10/collections/mellanox/onyx/onyx_command_module.html