ansible.netcommon.restconf_get

Fetch configuration/state data from RESTCONF enabled devices.

Version added: 1.0.0

Synopsis

RESTCONF is a standard mechanisms to allow web applications to access the configuration data and state data developed and standardized by the IETF. It is documented in RFC 8040.
This module allows the user to fetch configuration and state data from RESTCONF enabled devices.

Parameter	Choices/Defaults	Comments
content string	Choices: config nonconfig all	The `content` is a query parameter that controls how descendant nodes of the requested data nodes in `path` will be processed in the reply. If value is config return only configuration descendant data nodes of value in `path`. If value is nonconfig return only non-configuration descendant data nodes of value in `path`. If value is all return all descendant data nodes of value in `path`
output string	Choices: json ← xml	The output of response received.
path string / required		URI being used to execute API calls.

Note

This module requires the RESTCONF system service be enabled on the remote device being managed.
This module is supported with ansible_connection value of ansible.netcommon.httpapi and ansible_network_os value of ansible.netcommon.restconf.
This module is tested against Cisco IOSXE 16.12.02 version.

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

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
response dictionary	when the device response is valid JSON	A dictionary representing a JSON-formatted response Sample: { "vpn-services": { "vpn-service": [ { "customer-name": "red", "vpn-id": "blue_vpn1", "vpn-service-topology": "ietf-l3vpn-svc:any-to-any" } ] } }