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

Примечание

Этот плагин входит в сборку ansible.netcommon (версия 1.5.0).

Для его установки используйте: ansible-galaxy collection install ansible.netcommon.

Для использования в книге задач укажите: ansible.netcommon.restconf_get.

Добавлена в версии 1.0.0: of ansible.netcommon

Обзор

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

Параметр	Варианты/Значения по умолчанию	Комментарии
content строка	Варианты: config nonconfig all	Параметр запроса, определяющий, как будут обрабатываться дочерние узлы запрашиваемых узлов данных в `path`, в ответе. Если значение равно config, возвращаются только дочерние узлы данных конфигурации для значения в `path`. Если значение равно nonconfig, возвращаются только дочерние узлы данных, не относящиеся к конфигурации, для значения в `path`. Если значение равно all, возвращаются все дочерние узлы данных для значения в `path`.
output строка	Варианты: json ← xml	Вывод полученного ответа.
path строка / обязательно		URI, используемый для выполнения API-вызовов.

Примечание

Для данного модуля требуется, чтобы служба RESTCONF была включена на удалённом управляемом устройстве.
Этот модуль поддерживается со значением ansible_connection равным ansible.netcommon.httpapi и значением ansible_network_os равным ansible.netcommon.restconf.
Этот модуль протестирован с Cisco IOSXE версии 16.12.02.

- name: get l3vpn services
  ansible.netcommon.restconf_get:
    path: /config/ietf-l3vpn-svc:l3vpn-svc/vpn-services

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

Ключ	Возвращаемое значение	Описание
response словарь	при валидном JSON ответе от устройства	Словарь, представляющий ответ в формате JSON Пример: { "vpn-services": { "vpn-service": [ { "customer-name": "red", "vpn-id": "blue_vpn1", "vpn-service-topology": "ietf-l3vpn-svc:any-to-any" } ] } }

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/netcommon/restconf_get_module.html