Spec-Zone.ru › Ansible 2.11

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

Примечание

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

Для его установки используйте: 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 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/eric_eccli_command_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API