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

Примечание

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

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

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

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

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

Описание

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

Псевдонимы: network.eric_eccli.eric_eccli_command

Параметры

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

Примечания

Примечание

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

Примеры

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, разделенное на список Возвращено: всегда, кроме ошибок низкого уровня (таких как плагин действия) Пример: `[["...", "..."], ["..."], ["..."]]`

Авторы

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

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

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