ansible.netcommon.restconf_config – Handles create, update, read and delete of configuration data on 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_config
.
New in version 1.0.0: of ansible.netcommon
Synopsis¶
RESTCONF is a standard mechanisms to allow web applications to configure and manage data. RESTCONF is a IETF standard and documented on RFC 8040.
This module allows the user to configure data on 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: create l3vpn services
ansible.netcommon.restconf_config:
path: /config/ietf-l3vpn-svc:l3vpn-svc/vpn-services
content: |
{
"vpn-service":[
{
"vpn-id": "red_vpn2",
"customer-name": "blue",
"vpn-service-topology": "ietf-l3vpn-svc:any-to-any"
},
{
"vpn-id": "blue_vpn1",
"customer-name": "red",
"vpn-service-topology": "ietf-l3vpn-svc:any-to-any"
}
]
}
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Ganesh Nalawade (@ganeshrn)