Spec-Zone.ru › Ansible

Модуль community.network.ironware_command – Выполнение произвольных команд на устройствах Extreme IronWare

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.network.

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

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

Описание

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

Псевдонимы: network.ironware.ironware_command

Параметры

Параметр

Комментарии

authorize

boolean

Устарело

Начиная с Ansible 2.7, рекомендуется использовать connection: network_cli и become: true.

Дополнительную информацию можно найти в руководстве IronWare Platform Options.

<hr>

Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE.

Варианты:

  • false ← (по умолчанию)
  • true

commands

строка / обязательно

Список команд для отправки на удалённое устройство через настроенный поставщик. Результирующий вывод команды возвращается. Если задан аргумент wait_for, модуль не возвращается до тех пор, пока условие не будет выполнено или не истечёт количество попыток.

interval

строка

Настройка интервала в секундах ожидания между попытками выполнения команды. Если команда не удовлетворяет указанным условиям, интервал определяет, как долго нужно ждать перед повторной попыткой.

По умолчанию: 1

match

строка

Аргумент match используется совместно с аргументом wait_for для указания политики соответствия. Если значение установлено в all, все условия в wait_for должны быть выполнены. Если значение установлено в any, должно быть выполнено только одно из значений.

Варианты:

  • "any"
  • "all" ← (по умолчанию)

retries

строка

Указывает количество попыток выполнения команды перед её признанием неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for.

По умолчанию: 10

wait_for

строка

Список условий для оценки по результатам команды. Задача будет ожидать выполнения каждого условия перед продолжением. Если условие не выполняется в течение заданного количества попыток, задача завершается с ошибкой. Смотрите примеры.

Примечания

Примечание

  • Дополнительную информацию об использовании Ansible для управления сетевыми устройствами можно найти в :ref:`Руководстве по Ansible для сети <network_guide>`

Примеры

- name: Run a command
  community.network.ironware_command:
    commands:
      - show version

- name: Run several commands
  community.network.ironware_command:
    commands:
      - show interfaces brief wide
      - show mpls vll

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

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

Ключ

Описание

failed_conditions

список / элементы=строка

Невыполненные условия

Возвращается: failed

Пример: ["...", "..."]

stdout

список / элементы=строка

Набор ответов от команд

Возвращается: всегда

Пример: ["...", "..."]

stdout_lines

список / элементы=строка

Значение stdout, разделенное на список

Возвращается: всегда

Пример: [["...", "..."], ["..."], ["..."]]

Авторы

  • Paul Baker (@paulquack)

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

  • Система отслеживания задач
  • Репозиторий (источники)

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

Spec-Zone.ru

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