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

Примечание

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

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

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

Для использования в playbook укажите: cisco.iosxr.iosxr_command.

Новинка в cisco.iosxr 1.0.0

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

Описание

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

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

Параметры

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

Примечания

Примечание

Убедитесь, что пользователь получил авторизацию для выполнения команд с параметрами длины терминала 0, ширины терминала 512 и приглашения терминала exec без отметки времени.
Этот модуль работает с network_cli. См. параметры платформы IOS-XR.
Этот модуль не поддерживает netconf подключение.
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами, обратитесь к руководству по сетям 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.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 список / элементы=строка	Список условных выражений, которые не выполнились Возвращаемое значение: не выполнено Пример: `["...", "..."]`
stdout список / элементы=строка	Набор ответов от команд Возвращаемое значение: всегда, за исключением ошибок низкого уровня (таких как плагин действий) Пример: `["...", "..."]`
stdout_lines список / элементы=строка	Значение stdout, разделенное на список Возвращаемое значение: всегда, за исключением ошибок низкого уровня (таких как плагин действий) Пример: `[["...", "..."], ["..."], ["..."]]`

Авторы

Ricardo Carrillo Cruz (@rcarrillocruz)

Ссылки на сборку

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