Ian Underwood's Python RESTCONF Module
This package provides a RESTCONF class to manage interactions with network devices that use the RESTCONF protocol as defined in RFC-8040.
This document is woefully incomplete.
Module installation can be managed with PIP:
pip3 install iupy-restconf
This provides a top-level restconf import which should be imported into your project as such:
import restconf
router = restconf.RestConf()
router.connect(transport='https',
host='192.168.1.1',
un='restuser',
pw='restpass')
From there, using the module is a matter of defining the method and path that is useful for your application:
response = router.get("data/native/interfaces")Operations such as push, post, and patch use a second positional arguement as a dictionary that provides the structure required.
response = router.post("data/openconfig-interfaces:interface", newconfig_dict)
Since RESTCONF is authorized on a per-request basis, there is no connection open or close method as with a general REST API which generates an stores a session.
Routers that are RFC-8040 compliant provide a list of modules that they support. This allows a script to check for basic capabilities.
router.get_data_modules()
if router.check_data_modules("Cisco-IOS-XE-native"):
print("This supports IOS-XE Native Calls")