Spec-Zone.ru › Ansible

Модуль community.ciscosmb.command – Выполнение команд на удалённых устройствах Cisco SMB

Примечание

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

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

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

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

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

Описание

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

Параметры

Параметр

Комментарии

commands

список / элементы=строка / обязательный

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

interval

целое число

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

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

match

строка

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

Варианты:

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

retries

целое число

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

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

wait_for

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

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

Примеры

- name: Run command on remote devices
  community.ciscosmb.command:
    commands: show version

- name: Run command and check to see if output contains PID
  community.ciscosmb.command:
    commands: show inventory
    wait_for: result[0] contains PID

- name: Run multiple commands on remote nodes
  community.ciscosmb.command:
    commands:
      - show version
      - show system

- name: Run multiple commands and evaluate the output
  community.ciscosmb.command:
    commands:
      - show version
      - show system
    wait_for:
      - result[0] contains Active-image
      - result[1] contains "System Up Time"

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

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

Ключ

Описание

failed_conditions

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

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

Возвращается: при неудаче

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

stdout

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

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

Возвращается: всегда, кроме ошибок низкого уровня (таких как плагин действия)

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

stdout_lines

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

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

Возвращается: всегда, кроме ошибок низкого уровня (таких как плагин действия)

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

Авторы

  • Petr Klima (@qaxi)

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

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

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

Spec-Zone.ru

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