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

Примечание

Этот модуль входит в коллекцию community.network (версия 5.0.3).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

Чтобы использовать его в книге задач, укажите: community.network.slxos_command.

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

Обзор

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

Псевдонимы: network.slxos.slxos_command

Параметры

Параметр	Комментарии
commands строка / обязательно	Список команд для отправки на удалённое устройство SLX-OS через настроенный провайдер. Результирующий вывод команды возвращается. Если аргумент wait_for указан, модуль не возвращается до тех пор, пока условие не будет выполнено или не истечёт время ожидания.
interval строка	Настраивает интервал в секундах ожидания между повторными попытками выполнения команды. Если команда не удовлетворяет заданным условиям, интервал указывает время ожидания перед повторной попыткой. По умолчанию: `1`
match строка	Аргумент match используется совместно с аргументом wait_for для указания политики соответствия. Допустимые значения: `all` или `any`. Если значение установлено в `all`, все условия в wait_for должны быть выполнены. Если значение установлено в `any`, достаточно выполнения только одного из условий. Выбор: `"any"` `"all"` ← (по умолчанию)
retries строка	Указывает количество попыток выполнения команды до её признания неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for. По умолчанию: `10`
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/slxos_command_module.html