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 -	never ← always if-supported	Инструктирует модуль явно заблокировать хранилище данных, указанное как `source`. Если source не определен, будет заблокировано хранилище running. Установив значение опции always, произойдёт явное блокирование хранилища данных, упомянутого в `source` опции. Установив значение опции never, хранилище данных `source` не будет заблокировано. Значение if-supported позволяет лучше взаимодействовать с серверами NETCONF, которые не поддерживают операцию (раз)блокировки для всех поддерживаемых хранилищ данных.
source -	running candidate startup	Этот аргумент указывает хранилище данных, из которого должны извлекаться данные конфигурации. Допустимые значения — running, candidate и startup. Если значение `source` не установлено, и в ответе возвращаются конфигурационная и информация о состоянии, возвращаются из хранилища running.

Примечания

Примечание

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

Примеры

- 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 confiugration 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"/>

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

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

Ключ		Возвращаемое	Описание
output сложное		при формате вывода JSON возвращается как тип dict, если формат вывода xml или pretty, возвращается как строка, за исключением ошибок низкого уровня (например, плагин действия).	В зависимости от значения опции display возвращается либо набор преобразованных XML в JSON-формат из ответа RPC с типом dict, либо красивый ответ XML-строкой (удобный для чтения) или ответ со удалёнными именами пространств XML.
	formatted_output -
stdout строка		всегда за исключением ошибок низкого уровня (например, плагина действия)	Необработанная строка XML, содержащая данные конфигурации или состояния, полученные из библиотеки ncclient. Пример: ...
stdout_lines список		всегда за исключением ошибок низкого уровня (например, плагина действия)	Значение stdout, разделенное на список Пример: ['...', '...']

Статус

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

Поддержка 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.7/modules/netconf_get_module.html