Модуль dellemc.enterprise_sonic.sonic_command — выполняет команды на устройствах под управлением Enterprise SONiC

Примечание

Этот модуль входит в коллекцию dellemc.enterprise_sonic (версия 3.2.0).

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

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

Чтобы использовать её в плейбуке, укажите: dellemc.enterprise_sonic.sonic_command.

Добавлено в dellemc.enterprise_sonic 1.0.0

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

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

Выполняет команды на удалённых устройствах под управлением Enterprise SONiC Distribution by Dell Technologies. Отправляет произвольные команды узлу Enterprise SONiC и возвращает результаты, полученные с устройства. Этот модуль содержит аргумент, который заставляет модуль ожидать наступления определённого условия перед возвратом результата или завершаться по тайм-ауту, если условие не выполнено.
Этот модуль не поддерживает выполнение команд в режиме конфигурации. Для настройки устройств SONiC используйте dellemc.enterprise_sonic.sonic_config.

Параметры

Параметр	Комментарии
commands list / elements=string / обязательный	Список команд для отправки удалённым устройствам Enterprise SONiC через настроенный провайдер. Возвращается результат выполнения команды. Если указан аргумент wait_for, модуль не возвращает результат, пока условие не будет выполнено или не истечёт число попыток. Если для выполнения отправленной устройству команды требуется ответ на запрос, можно передать словарь, содержащий command, answer и prompt. Типичные ответы — ‘yes’ или “\r” (возврат каретки, необходимо использовать двойные кавычки). См. примеры.
interval integer	Задаёт интервал в секундах между повторными попытками выполнения команды. Если команда не соответствует указанным условиям, интервал определяет, сколько времени ждать перед повторным выполнением команды. По умолчанию: `1`
match string	Аргумент match используется вместе с аргументом wait_for для задания политики сопоставления. Допустимые значения: `all` или `any`. Если задано значение `all`, должны быть выполнены все условия в wait_for. Если задано значение `any`, достаточно выполнения только одного из условий. Варианты: `"all"` ← (по умолчанию) `"any"`
retries integer	Задаёт число попыток выполнения команды, после которого она считается неудачной. Команда выполняется на целевом устройстве при каждой попытке и проверяется на соответствие условиям wait_for. По умолчанию: `10`
wait_for list / elements=string	Список условий для проверки по результату выполнения команды. Задача ожидает выполнения каждого условия, прежде чем продолжить работу. Если условие не выполнено в пределах заданного числа попыток, задача завершается с ошибкой. См. примеры.

Примечания

Примечание

Проверено на Enterprise SONiC Distribution by Dell Technologies.
Поддерживает check_mode.

Примеры

- name: Runs show version on remote devices
  dellemc.enterprise_sonic.sonic_command:
    commands: show version

- name: Runs show version and checks to see if output contains 'Dell'
  dellemc.enterprise_sonic.sonic_command:
    commands: show version
    wait_for: result[0] contains Dell

- name: Runs multiple commands on remote nodes
  dellemc.enterprise_sonic.sonic_command:
    commands:
      - show version
      - show interface

- name: Runs multiple commands and evaluate the output
  dellemc.enterprise_sonic.sonic_command:
    commands:
      - 'show version'
      - 'show system'
    wait_for:
      - result[0] contains Dell
      - result[1] contains Hostname

- name: Runs commands that require answering a prompt
  dellemc.enterprise_sonic.sonic_command:
    commands:
      - command: 'reload'
        prompt: '[confirm yes/no]: ?$'
        answer: 'no'

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

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

Ключ	Описание
failed_conditions list / elements=string	Список невыполненных условий. Возвращается: при ошибке Пример: `["...", "..."]`
stdout list / elements=string	Набор ответов на команды. Возвращается: всегда, кроме ошибок низкого уровня (например, ошибок плагина действий) Пример: `["...", "..."]`
stdout_lines list / elements=string	Значение stdout, разбитое на список. Возвращается: всегда, кроме ошибок низкого уровня (например, ошибок плагина действий) Пример: `[["...", "..."], ["..."], ["..."]]`
warnings list / elements=string	Список предупреждений (если есть), сформированных модулем на основе аргументов. Возвращается: всегда Пример: `["...", "..."]`

Авторы

Dhivya P (@dhivayp)

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

© 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/dellemc/enterprise_sonic/sonic_command_module.html