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¶
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:
Authors¶
Ganesh Nalawade (@ganeshrn)