Модуль cisco.nxos.nxos_command — выполнение произвольной команды на устройствах Cisco NXOS

Примечание

Этот модуль входит в коллекцию cisco.nxos (версия 11.2.0).

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

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

Чтобы использовать её в плейбуке, укажите: cisco.nxos.nxos_command.

Добавлено в cisco.nxos 1.0.0

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

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

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

Примечание

Этому модулю соответствует плагин действия.

Псевдонимы: command

Параметры

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

Примечания

Примечание

Ограниченная поддержка Cisco MDS
Сведения об использовании CLI и NX-API см. в руководстве :ref:`Параметры платформы NXOS <nxos_platform_options>`
Дополнительные сведения об использовании Ansible для управления сетевыми устройствами см. в :ref:`руководстве по работе с сетями Ansible <network_guide>`
Дополнительные сведения об использовании Ansible для управления устройствами Cisco см. на `странице интеграции Cisco <https://www.ansible.com/integrations/networks/cisco>`_.

Примеры

- name: run show version on remote devices
  cisco.nxos.nxos_command:
    commands: show version

- name: run show version and check to see if output contains Cisco
  cisco.nxos.nxos_command:
    commands: show version
    wait_for: result[0] contains Cisco

- name: run multiple commands on remote nodes
  cisco.nxos.nxos_command:
    commands:
      - show version
      - show interfaces

- name: run multiple commands and evaluate the output
  cisco.nxos.nxos_command:
    commands:
      - show version
      - show interfaces
    wait_for:
      - result[0] contains Cisco
      - result[1] contains loopback0

- name: run commands and specify the output format
  cisco.nxos.nxos_command:
    commands:
      - command: show version
        output: json

- name: run commands that require answering a prompt
  cisco.nxos.nxos_command:
    commands:
      - configure terminal
      - command: no feature npv
        prompt: Do you want to continue
        answer: y

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

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

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

Авторы

Peter Sprygada (@privateip)

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

© 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/cisco/nxos/nxos_command_module.html