netconf_get – Получение данных конфигурации/состояния с сетевых устройств, поддерживающих NETCONF

Новое в версии 2.6.

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

Описание

NETCONF — это протокол управления сетями, разработанный и стандартизированный IETF. Он документирован в RFC 6241.
Этот модуль позволяет пользователю получать данные конфигурации и состояния с сетевых устройств, поддерживающих NETCONF.

Требования

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

ncclient (>=v0.5.2)
jxmlease

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
display -	Варианты: json pretty xml	Схема кодирования, используемая при сериализации вывода устройства. Параметр json сериализует вывод как данные JSON. Если значение параметра json, требуется установка jxmlease на контрольном узле. Параметр pretty аналогичен получаемому XML ответу, но использует удобочитаемый формат (пробелы, новые строки). Параметр xml аналогичен получаемому XML ответу, но удаляет все XML-пространства имён.
filter -		Этот аргумент задаёт строку XML, которая служит фильтром для ограничения частей данных, извлекаемых с удалённого устройства. Если этот параметр не задан, в результате возвращаются все данные конфигурации или состояния в зависимости от значения параметра `source`. Значение параметра `filter` может быть либо строкой XML, либо XPath, если фильтр задан в формате XPath, сервер NETCONF на удалённом узле должен поддерживать возможность XPath, иначе произойдёт ошибка.
lock -	Варианты: никогда ← всегда если_поддерживается	Инструктирует модуль явно заблокировать хранилище данных, указанное как `source`. Если source не определён, будет заблокировано хранилище running. Установка значения всегда явно заблокирует хранилище данных, упомянутое в `source` параметре. Установка значения никогда не будет блокировать хранилище `source`. Значение если_поддерживается обеспечивает лучшую работу с серверами NETCONF, которые не поддерживают операцию (раз)блокировки для всех поддерживаемых хранилищ данных.
source -	Варианты: running candidate startup	Этот аргумент задаёт хранилище данных, из которого должны быть извлечены данные конфигурации. Допустимые значения — running, candidate и startup. Если значение `source` не задано, в ответ возвращаются информация о конфигурации и состоянии из хранилища running.

Примечания

Примечание

Для работы этого модуля требуется, чтобы служба NETCONF была включена на удалённом управляемом устройстве.
Этот модуль поддерживает использование connection=netconf
Этот модуль поддерживается на платформах сети ansible_network_os. Подробности см. в Параметры платформы сети.

Примеры

- name: Get running configuration and state data
  netconf_get:

- name: Get configuration and state data from startup datastore
  netconf_get:
    source: startup

- name: Get system configuration data from running datastore state (junos)
  netconf_get:
    source: running
    filter: <configuration><system></system></configuration>

- name: Get configuration and state data in JSON format
  netconf_get:
    display: json

- name: get schema list using subtree w/ namespaces
  netconf_get:
    display: json
    filter: <netconf-state xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring"><schemas><schema/></schemas></netconf-state>
    lock: never

- name: get schema list using xpath
  netconf_get:
    display: xml
    filter: /netconf-state/schemas/schema

- name: get interface configuration with filter (iosxr)
  netconf_get:
    display: pretty
    filter: <interface-configurations xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg"></interface-configurations>
    lock: if-supported

- name: Get system configuration data from running datastore state (junos)
  netconf_get:
    source: running
    filter: <configuration><system></system></configuration>
    lock: if-supported

- name: Get complete configuration data from running datastore (SROS)
  netconf_get:
    source: running
    filter: <configure xmlns="urn:nokia.com:sros:ns:yang:sr:conf"/>

- name: Get complete state data (SROS)
  netconf_get:
    filter: <state xmlns="urn:nokia.com:sros:ns:yang:sr:state"/>

Статус

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

Поддержка Red Hat

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

Авторы

Ganesh Nalawade (@ganeshrn)
Sven Wisotzky (@wisotzky)

Подсказка

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

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