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

Примечание

Этот плагин является частью коллекции community.network (версия 2.0.1).

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

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

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

Краткое описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/slxos_command_module.html