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

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

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

Описание

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

Требования

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

ncclient (>=v0.5.2)

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
args -			Аргумент `args` предоставляет набор аргументов для вызова RPC и кодируется в сообщении запроса. Этот аргумент принимает набор аргументов вида ключ=значение.
attrs - добавлено в 2.5			Аргументы `attrs` определяют список атрибутов и их значений для установки при вызове RPC. Принимает словарь ключ-значение.
output -		По умолчанию: "xml"	Аргумент `output` определяет желаемый формат выходных данных возвращаемых данных. Этот аргумент принимает одно из значений `xml`, `text`, или `json`. Для `json`, устройство JUNOS должно использовать версию программного обеспечения, поддерживающую вывод в формате JSON.
provider -			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli` или `connection: netconf`. Для получения дополнительной информации см. руководство Junos OS Platform Options. Объект словаря, содержащий данные подключения.
	host - / обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение параметра host используется в качестве целевого адреса для транспорта.
	password -		Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port -	По умолчанию: 22	Указывает порт для подключения к удалённому устройству. Значение порта по умолчанию равно общеизвестному порту SSH 22 (для `transport=cli`) или порту 830 (для `transport=netconf`) устройства.
	ssh_keyfile -		Указывает SSH ключ для аутентификации подключения к удалённому устройству. Это путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout -	По умолчанию: 10	Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истечёт до завершения операции, модуль выдаст ошибку.
	username -		Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
rpc - / обязательно			Аргумент `rpc` указывает вызов RPC, который необходимо отправить удалённым устройствам для выполнения. Сообщение с ответом RPC анализируется, и содержимое возвращается в плейбук.

Примечания

Примечание

Этот модуль требует, чтобы служба netconf была включена на управляемом удалённом устройстве.
Проверено на vSRX JUNOS версии 15.1X49-D15.4, vqfx-10000 JUNOS Версии 15.1X53-D60.4.
Рекомендуемое подключение netconf. См. руководство Junos OS Platform Options.
Этот модуль также работает с подключением local для устаревших плейбуков.
Для получения информации об использовании CLI и netconf см. руководство Junos OS Platform Options
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. руководство Ansible по сети
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами Juniper см. https://www.ansible.com/ansible-juniper.

Примеры

- 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

- name: load configuration
  junos_rpc:
    rpc: load-configuration
    attrs:
      action: override
      url: /tmp/config.conf

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

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

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

Статус

Для этого модуля не гарантируется обратная совместимость интерфейса. [превью]
Этот модуль поддерживается командой Ansible Network. [сеть]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний Red Hat.

Авторы

Peter Sprygada (@privateip)

Подсказка

Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

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