community.network.eric_eccli_command – Выполнение команд на удалённых устройствах с ERICSSON ECCLI

Примечание

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

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

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

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

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

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

Параметры

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

Примечания

Примечание

Проверено на IPOS 19.3
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по Ansible для сетей.
Дополнительную информацию об использовании Ansible для управления устройствами Ericsson см. в документации Ericsson.
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Для получения дополнительной информации, см. руководство ERIC_ECCLI по вариантам платформы.

Примеры

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

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

  - name: Run multiple commands on remote nodes
    community.network.eric_eccli_command:
      commands:
        - show version
        - show running-config interfaces

  - name: Run multiple commands and evaluate the output
    community.network.eric_eccli_command:
      commands:
        - show version
        - show running-config interfaces
      wait_for:
        - result[0] contains IPOS
        - result[1] contains management

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

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

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

Авторы

Команда OAM Ericsson IPOS (@itercheng)

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