Модуль cisco.iosxr.iosxr_command — модуль для выполнения команд на удалённых устройствах.

Примечание

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

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

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

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

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

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

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

Отправляет произвольные команды узлу IOS XR и возвращает результаты, полученные с устройства. Этот модуль включает аргумент, который заставляет модуль ожидать выполнения определённого условия перед возвратом результата или завершаться по тайм-ауту, если условие не выполнено.
Этот модуль не поддерживает выполнение команд в режиме конфигурации. Для настройки устройств iosxr используйте cisco.iosxr.iosxr_config.

Примечание

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

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

Параметры

Параметр	Комментарии
commands list / elements=any / обязательный	Список команд, отправляемых удалённому устройству iosxr через настроенный провайдер. Возвращается результат выполнения команды. Если указан аргумент wait_for, модуль не возвращает результат, пока условие не будет выполнено или не истечёт число повторных попыток. Если для отправленной устройству команды требуется ответ на запрос, можно передать словарь, содержащий 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. По умолчанию: `10`
wait_for псевдонимы: waitfor list / elements=string	Список условий для проверки результата выполнения команды. Задача будет ожидать выполнения каждого условия, прежде чем продолжить. Если условие не будет выполнено за заданное количество повторных попыток, задача завершится с ошибкой. См. примеры.

Примечания

Примечание

Убедитесь, что пользователю разрешено выполнять команды terminal length 0, terminal width 512 и terminal exec prompt no-timestamp.
Этот модуль работает с network_cli. См. параметры платформы IOS-XR.
Этот модуль не поддерживает подключение netconf.
Дополнительные сведения об использовании Ansible для управления сетевыми устройствами см. в :ref:`руководстве по работе Ansible с сетевыми устройствами <network_guide>`
Дополнительные сведения об использовании Ansible для управления устройствами Cisco см. на `странице интеграции Cisco <https://www.ansible.com/integrations/networks/cisco>`_.

Примеры

- name: run show version on remote devices
  cisco.iosxr.iosxr_command:
    commands: show version

- name: run show version and check to see if output contains iosxr
  cisco.iosxr.iosxr_command:
    commands: show version
    wait_for: result[0] contains IOS-XR

- name: run multiple commands on remote nodes
  cisco.iosxr.iosxr_command:
    commands:
      - show version
      - show interfaces
      - {command: example command that prompts, prompt: expected prompt, answer: true}

- name: run multiple commands and evaluate the output
  cisco.iosxr.iosxr_command:
    commands:
      - show version
      - show interfaces
    wait_for:
      - result[0] contains IOS-XR
      - result[1] contains Loopback0

- name: 'multiple prompt, multiple answer (mandatory check for all prompts)'
  cisco.iosxr.iosxr_command:
    commands:
      - command: key config-key password-encryption
        prompt:
          - 'Enter old key :'
          - 'Enter new key :'
          - 'Enter confirm key :'
        answer:
          - test1234
          - test12345
          - test12345
        check_all: true

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

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

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

Авторы

Ricardo Carrillo Cruz (@rcarrillocruz)

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

© 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/iosxr/iosxr_command_module.html