junos_rpc - Выполнение произвольного RPC через NetConf на устройстве Juniper JUNOS

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

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

Описание

Отправляет запрос на удалённое устройство с JUNOS для выполнения указанного RPC с использованием транспорта NetConf. Ответ затем возвращается в playbook в ключе xml. Если затребован альтернативный формат вывода, ответ преобразуется в запрошенный формат.

Требования (для хоста, на котором выполняется модуль)

ncclient (>=v0.5.2)

Параметры

параметр обязательно по умолчанию варианты комментарии

args

нет

Аргумент args предоставляет набор аргументов для вызова RPC и кодируется в сообщении запроса. Этот аргумент принимает набор аргументов вида ключ=значение.

output

нет

xml

Аргумент output определяет желаемый формат выходных данных возвращаемых данных. Этот аргумент принимает одно из значений xml, text, или json. Для json, устройство JUNOS должно использовать версию ПО, поддерживающую вывод в формате JSON.

provider

нет

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

**Объект словаря 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	Указывает порт для подключения к удалённому устройству. По умолчанию используется стандартный порт SSH 22 (для `transport=cli`) или порт 830 (для `transport=netconf`) устройства.

rpc

да

Аргумент rpc указывает вызов RPC, который необходимо отправить на удалённые устройства для выполнения. Сообщение RPC ответа разбирается, и его содержимое возвращается в playbook.

Примеры

- name: collect interface information using rpc
  junos_rpc:
    rpc: get-interface-information
    args:
      interface-name: em0
      media: True

- name: get system information
  junos_rpc:
    rpc: get-system-information

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

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

имя	описание	возвращается	тип
output	Ответ rpc, преобразованный в формат вывода.	всегда	строка
output_lines	Выходной текст, разделенный на строки для удобства чтения.	всегда	список
xml	XML-строка ответа от запроса rpc.	всегда	строка

Примечания

Примечание

Для работы этого модуля на управляемом удалённом устройстве должна быть включена системная служба netconf.
Тестировано на vSRX JUNOS версии 15.1X49-D15.4, vqfx-10000 JUNOS версии 15.1X53-D60.4.

Статус

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

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

Дополнительную информацию о поддержке этого модуля 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/junos_rpc_module.html