community.network.slxos_command – Выполнение команд на удалённых устройствах с Extreme Networks SLX-OS

Примечание

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

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

Для использования в плейбуке укажите: community.network.slxos_command.

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

Описание

Отправляет произвольные команды узлу SLX и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставит модуль ожидать выполнения определённого условия перед возвратом или вызовет таймаут, если условие не будет выполнено.
Этот модуль не поддерживает выполнение команд в режиме конфигурации. Используйте community.network.slxos_config для конфигурации устройств SLX-OS.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
commands строка / обязательный		Список команд, которые необходимо отправить удалённому устройству SLX-OS через настроенный провайдер. Возвращается результирующий вывод команды. Если указан аргумент wait_for, модуль не возвращается до тех пор, пока условие не будет выполнено или истечёт количество попыток.
interval строка	По умолчанию: 1	Настраивает интервал в секундах ожидания между повторными попытками выполнения команды. Если команда не удовлетворяет указанным условиям, интервал указывает, сколько времени подождать перед повторной попыткой выполнения команды.
match строка	Варианты: any all ←	Аргумент match используется совместно с аргументом wait_for для задания политики соответствия. Допустимые значения — `all` или `any`. Если значение установлено в `all`, все условия в wait_for должны быть выполнены. Если значение установлено в `any`, достаточно выполнения одного из условий.
retries строка	По умолчанию: 10	Указывает количество попыток выполнения команды до того, как она считается неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for.
wait_for строка		Список условий для оценки по результатам выполнения команды. Задача ожидает выполнения каждого условия перед продолжением. Если условие не выполняется в течение заданного количества попыток, задача завершается с ошибкой. См. примеры.

Примечания

Примечание

Тестировано на SLX-OS 17s.1.02
Если отправленная команде устройству команда требует ответа на запрос, можно передать словарь, содержащий command, answer и prompt. См. примеры.

Примеры

tasks:
  - name: Run show version on remote devices
    community.network.slxos_command:
      commands: show version

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

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

  - name: Run multiple commands and evaluate the output
    community.network.slxos_command:
      commands:
        - show version
        - show interface status
      wait_for:
        - result[0] contains SLX
        - result[1] contains Eth
  - name: Run command that requires answering a prompt
    community.network.slxos_command:
      commands:
        - command: 'clear sessions'
          prompt: 'This operation will logout all the user sessions. Do you want to continue (yes/no)?:'
          answer: y

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

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

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

Авторы

Lindsay Hill (@LindsayHill)

© 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/slxos_command_module.html