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

Примечание

Этот модуль входит в состав коллекции cisco.nxos (версия 8.1.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 список / элементы=любые / обязательный	Команды для отправки удалённому устройству NXOS. Результирующий вывод команды возвращается. Если предоставлен аргумент wait_for, модуль не возвращается до тех пор, пока условие не будет выполнено или количество попыток не истечёт. Аргумент commands также принимает альтернативную форму, позволяющую указать сложные значения, которые определяют команду для выполнения и формат вывода. Это можно сделать для каждой команды индивидуально. Сложный аргумент поддерживает ключевые слова `command` и `output`, где `command` — это команда для выполнения, а `output` — это один из значений ‘text’ или ‘json’. Если команда, отправленная устройству, требует ответа на приглашение, можно передать словарь, содержащий команду, ответ и приглашение. Общие ответы — ‘y’ или “\r” (возврат каретки, должен быть в двойных кавычках). См. примеры.
interval целое число	Настраивает интервал в секундах ожидания между повторениями команды. Если команда не удовлетворяет указанному условию, интервал указывает, как долго ждать перед повторной попыткой. По умолчанию: `1`
match строка	Аргумент match используется совместно с аргументом wait_for для определения политики сопоставления. Допустимые значения — `all` или `any`. Если значение установлено на `all`, все условия в wait_for должны быть выполнены. Если значение установлено на `any`, должно быть выполнено только одно из значений. Варианты: `"any"` `"all"` ← (по умолчанию)
retries целое число	Указывает количество попыток выполнения команды перед тем, как считать её неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for. Команды выполняются один раз, когда retries установлено на `0`. По умолчанию: `9`
wait_for псевдонимы: waitfor список / элементы=строка	Указывает, что оценивать из вывода команды и какие условия применять. Этот аргумент заставит задачу ожидать выполнения определённого условия, прежде чем продолжить. Если условие не выполнится до истечения времени попыток, задача завершается неудачно. См. примеры.

Примечания

Примечание

Ограниченная поддержка Cisco MDS
Информация об использовании CLI и NX-API доступна в руководстве :ref:`NXOS Platform Options <nxos_platform_options>`
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве :ref:`Ansible Network Guide <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 список / элементы=строка	Список условий, которые не выполнены Возвращается: не выполнено Пример: `["...", "..."]`
stdout список / элементы=строка	Набор ответов от команд Возвращается: всегда, кроме ошибок низкого уровня (например, ошибки плагина действия) Пример: `["...", "..."]`
stdout_lines список / элементы=строка	Значение stdout, разделенное на список Возвращается: всегда, кроме ошибок низкого уровня (например, ошибки плагина действия) Пример: `[["...", "..."], ["..."], ["..."]]`

Авторы

Peter Sprygada (@privateip)

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

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