netconf_get – Извлечение данных конфигурации/состояния из устройств сети с поддержкой NETCONF
Новая версия с 2.6.
Описание
- NETCONF — это протокол управления сетью, разработанный и стандартизированный IETF. Он документирован в RFC 6241.
- Этот модуль позволяет пользователю извлекать данные конфигурации и состояния из устройств сети с поддержкой NETCONF.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ncclient (>=v0.5.2)
- jxmlease
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| display - |
| Схема кодирования для сериализации вывода устройства. Вариант 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. Если значение 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"/>
Возвращаемые значения
Общие возвращаемые значения документированы в этом разделе, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое | Описание | |
|---|---|---|---|
| output complex | при отображении в формате JSON возвращается значение типа dict, если отображается в формате XML или pretty, возвращается строка, кроме ошибок низкого уровня (например, плагин действия). | В зависимости от параметра display будет возвращено либо набор преобразованных XML в формат JSON (тип 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.8/modules/netconf_get_module.html
