iosxr_command - Выполнение команд на удалённых устройствах с Cisco IOS XR

Новая в версии 2.1.

Описание
Параметры
Примеры
Возвращаемые значения
Примечания
- Статус
- Информация о техническом обслуживании

Описание

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

Параметры

Параметр Обязательный Значение по умолчанию Варианты Комментарии

commands

да

Список команд для отправки удалённому устройству iosxr через настроенный провайдер. Результирующий вывод команды возвращается. Если предоставлен аргумент wait_for, модуль не возвращается, пока условие не будет выполнено или не истечёт время ожидания.

interval

нет

Настраивает интервал в секундах для ожидания между повторными попытками выполнения команды. Если команда не удовлетворяет указанным условиям, интервал указывает, сколько времени ждать, прежде чем снова попробовать выполнить команду.

match

(добавлен в 2.2)

нет

all

Аргумент match используется совместно с аргументом wait_for для указания политики соответствия. Допустимые значения — all или any. Если значение установлено в all, все условия в wait_for должны быть выполнены. Если значение установлено в any, должно быть выполнено только одно из условий.

provider

нет

Объект словаря, содержащий данные подключения.

**Объект словаря provider**
Параметр	Обязательный	Значение по умолчанию	Комментарии
username	нет		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
host	да		Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение параметра host используется в качестве адреса назначения для транспорта.
ssh_keyfile	нет		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
timeout	нет	10	Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания превышено до завершения операции, модуль вернёт ошибку.
password	нет		Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
port	нет	22	Указывает порт для подключения к удалённому устройству.

retries

нет

Указывает количество попыток выполнения команды до её признания неудачной. Команда выполняется на целевом устройстве при каждой попытке и оценивается по условиям wait_for.

wait_for

(добавлен в 2.2)

нет

Список условий для оценки по выводу команды. Задача будет ожидать, пока каждое условие не станет истинным, прежде чем продолжить. Если условие не станет истинным в течение заданного количества попыток, задача завершается ошибкой. См. примеры.

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

Примеры

tasks:
  - name: run show version on remote devices
    iosxr_command:
      commands: show version

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

  - name: run multiple commands on remote nodes
    iosxr_command:
      commands:
        - show version
        - show interfaces

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

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

Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие — специфичные для этого модуля:

Имя	Описание	Возвращается	Тип	Пример
failed_conditions	Список условий, которые не выполнены	при ошибке	список	['...', '...']
stdout	Набор ответов от команд	всегда, кроме ошибок низкого уровня (например, ошибки плагина действий)	список	['...', '...']
stdout_lines	Значение stdout, разбитое на список	всегда, кроме ошибок низкого уровня (например, ошибки плагина действий)	список	[['...', '...'], ['...'], ['...']]

Примечания

Примечание

Тестировалось с IOS XR 6.1.2

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.

Информация о техническом обслуживании

Для получения дополнительной информации о поддержке этого модуля Red Hat, обратитесь к этому knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

Для получения помощи в разработке модулей, если вы заинтересованы, прочитайте Информацию о сообществе и участие, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/iosxr_command_module.html