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

Новое в версии 2.9.

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

Описание

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

Параметры

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

Примечания

Примечание

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

Примеры

tasks:
  - name: run show version on remote devices
    icx_command:
      commands: show version

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

  - name: run multiple commands on remote nodes
    icx_command:
      commands:
        - show version
        - show interfaces

  - name: run multiple commands and evaluate the output
    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
    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
    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, разделённое на список Пример: [['...', '...'], ['...'], ['...']]

Статус

Гарантия обратной совместимости этого модуля не предоставляется. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Ruckus Wireless (@Commscope)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/icx_command_module.html