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

Note

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

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

Comments

root_path

string

Specifies the location of the Restconf root.

Default: “/restconf”

Configuration:

  • Variable: ansible_httpapi_restconf_root

Authors

  • Ansible Networking Team (@ansible-network)

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.