ansible.netcommon.restconf_get module – Fetch configuration/state data from RESTCONF enabled devices.
Note
This module is part of the ansible.netcommon collection (version 6.1.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install ansible.netcommon
.
To use it in a playbook, specify: ansible.netcommon.restconf_get
.
New in ansible.netcommon 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.
Parameters
Parameter |
Comments |
---|---|
The Choices:
|
|
The output of response received. Choices:
|
|
URI being used to execute API calls. |
Notes
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.
Examples
- name: get l3vpn services
ansible.netcommon.restconf_get:
path: /config/ietf-l3vpn-svc:l3vpn-svc/vpn-services
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary representing a JSON-formatted response Returned: when the device response is valid JSON Sample: |