Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: community.ciscosmb.command.

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

Краткое описание

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

Параметры

Параметр

Комментарии

commands

list / elements=string / обязательный

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

interval

integer

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

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

match

string

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

Варианты:

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

retries

integer

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

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

wait_for

list / elements=string

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

Примеры

- 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

list / elements=string

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

Возвращается: при ошибке

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

stdout

list / elements=string

Набор ответов, полученных от команд.

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

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

stdout_lines

list / elements=string

Значение stdout, разбитое на список.

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

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

Авторы

  • Petr Klima (@qaxi)

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

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/ciscosmb/command_module.html

Spec-Zone.ru

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