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

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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 компании Dell Technologies. Отправляет произвольные команды узлу Enterprise SONiC и возвращает результаты, считанные с устройства. В этом модуле есть аргумент, который заставляет модуль ожидать выполнения определённого условия перед возвратом или выполнить таймаут, если условие не выполняется.
Этот модуль не поддерживает выполнение команд в режиме конфигурации. Для конфигурации устройств SONiC используйте dellemc.enterprise_sonic.sonic_config.

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

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

Примечания

Примечание

Проверено на Enterprise SONiC Distribution компании 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 список / элементы=строка	Список условных выражений, которые не были выполнены. Возвращается: при ошибке Пример: `["...", "..."]`
stdout список / элементы=строка	Набор ответов на команды. Возвращается: всегда, кроме ошибок низкого уровня (таких как плагин действий) Пример: `["...", "..."]`
stdout_lines список / элементы=строка	Значение stdout, разбитое на список. Возвращается: всегда, кроме ошибок низкого уровня (таких как плагин действий) Пример: `[["...", "..."], ["..."], ["..."]]`
warnings список / элементы=строка	Список предупреждений (если таковые имеются), сгенерированных модулем на основе аргументов. Возвращается: всегда Пример: `["...", "..."]`

Авторы

Dhivya P (@dhivayp)

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

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