ansible.netcommon.restconf_get – Fetch configuration/state data from RESTCONF enabled devices.
ansible.netcommon.restconf_get – Fetch configuration/state data from RESTCONF enabled devices.
Note
This plugin is part of the ansible.netcommon collection (version 1.5.0).
To install it use: ansible-galaxy collection install ansible.netcommon
.
To use it in a playbook, specify: ansible.netcommon.restconf_get
.
New in version 1.0.0: of ansible.netcommon
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 | Choices/Defaults | Comments |
---|---|---|
content string |
|
The |
output string |
|
The output of response received. |
path string / required |
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 | 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" } ] } } |
Authors
- Ganesh Nalawade (@ganeshrn)
© 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