Модуль community.network.icx_command – Выполнение произвольных команд на удаленных коммутаторах Ruckus ICX 7000 серии

Примечание

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

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

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

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

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

Описание

Отправляет произвольные команды узлу ICX и возвращает результаты, считанные с устройства. Этот модуль включает аргумент, который заставит модуль подождать определённого условия перед возвратом или выдать таймаут, если условие не выполняется.

Псевдонимы: network.icx.icx_command

Параметры

Параметр	Комментарии
commands список / элементы=строка / обязательный	Список команд, которые необходимо отправить удалённому устройству ICX через настроенный поставщик. Результирующий вывод команды возвращается. Если аргумент wait_for указан, модуль не возвращается до тех пор, пока условие не будет выполнено или пока не истечёт число попыток. Если команда, отправленная устройству, требует ответа на запрос, проверьте все и новую строку, если есть несколько запросов, возможно передать словарь, содержащий command, answer, prompt, check_all и newline. Общие ответы — ‘y’ или “\r” (возврат каретки, должен быть в двойных кавычках). См. примеры.
interval целое число	Настраивает интервал в секундах ожидания между повторами команды. Если команда не удовлетворяет заданным условиям, интервал указывает, сколько времени ждать перед повторной попыткой. Значение по умолчанию: `1`
match строка	Аргумент match используется совместно с аргументом wait_for для указания политики сопоставления. Допустимые значения — `all` или `any`. Если значение установлено в `all`, все условия в wait_for должны быть выполнены. Если значение установлено в `any`, должно быть выполнено только одно из значений. Варианты: `"any"` `"all"` ← (по умолчанию)
retries целое число	Указывает количество попыток выполнения команды перед тем, как она будет считаться неудачной. Команда выполняется на целевом устройстве в каждой попытке и оценивается по условиям wait_for. Значение по умолчанию: `10`
wait_for псевдонимы: waitfor список / элементы=строка	Список условий, которые нужно оценить по отношению к выводу команды. Задача будет ожидать, пока каждое условие не станет истинным, прежде чем продолжать. Если условие не станет истинным в течение заданного количества попыток, задача завершается неудачей. См. примеры.

Примечания

Примечание

Проверено на ICX 10.1

Примеры

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

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

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

  - name: Run multiple commands and evaluate the output
    community.network.icx_command:
      commands:
        - show version
        - show interfaces
      wait_for:
        - result[0] contains ICX
        - result[1] contains GigabitEthernet1/1/1
  - name: Run commands that require answering a prompt
    community.network.icx_command:
      commands:
        - command: 'service password-encryption sha1'
          prompt: 'Warning: Moving to higher password-encryption type,.*'
          answer: 'y'
  - name: Run commands that require answering multiple prompt
    community.network.icx_command:
      commands:
        - command: 'username qqq password qqq'
          prompt:
            - 'User already exists. Do you want to modify:.*'
            - 'To modify or remove user, enter current password:'
          answer:
            - 'y'
            - 'qqq\
'
          check_all: true
          newline: false

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

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

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

Авторы

Ruckus Wireless (@Commscope)

Ссылки на коллекцию

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