ansible.netcommon.restconf – HttpApi Plugin for devices supporting Restconf API

Note

This plugin is part of the ansible.netcommon collection (version 2.5.0).

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.

New in version 1.0.0: of ansible.netcommon

Synopsis

  • This HttpApi plugin provides methods to connect to Restconf API endpoints.

Parameters

Parameter Choices/Defaults Configuration Comments
root_path
string
Default:
"/restconf"
var: ansible_httpapi_restconf_root
Specifies the location of the Restconf root.

Authors

  • Ansible Networking Team