Spec-Zone.ru › Ansible

Модуль community.network.aruba_command — Выполнение команд на удалённых устройствах с Aruba Mobility Controller

Примечание

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

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

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

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

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

Описание

  • Отправляет произвольные команды на узел Aruba и возвращает результаты, считанные с устройства. В этом модуле есть аргумент, который заставит модуль ожидать определённого условия перед возвратом или таймаутом, если условие не выполнено.
  • Этот модуль не поддерживает выполнение команд в режиме конфигурации. Для конфигурации устройств Aruba используйте community.network.aruba_config.

Псевдонимы: network.aruba.aruba_command

Параметры

Параметр

Комментарии

commands

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

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

interval

строка

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

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

match

строка

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

Выбор:

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

retries

строка

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

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

wait_for

псевдонимы: waitfor

строка

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

Примеры

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

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

  - name: Run multiple commands on remote nodes
    community.network.aruba_command:
      commands:
        - show version
        - show interfaces

  - name: Run multiple commands and evaluate the output
    community.network.aruba_command:
      commands:
        - show version
        - show interfaces
      wait_for:
        - result[0] contains Aruba
        - result[1] contains Loopback0

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

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

Ключ

Описание

failed_conditions

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

Список условий, которые не выполнены

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

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

stdout

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

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

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

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

stdout_lines

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

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

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

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

Авторы

  • James Mighion (@jmighion)

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

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

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

Spec-Zone.ru

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