cisco-nso-restconf 1.0.0

A Python client library for interacting with the Cisco NSO RESTCONF API

cisco-nso-restconf

Overview

This Python library provides an interface for interacting with the Cisco Network Services Orchestrator (NSO) RESTCONF API.

Features

• RESTCONF API Access: Use the NSORestconfClient class to make raw GET, POST, & DELETE requests to any RESTCONF /data resource.
• Utility Classes: Use pre-built helper classes, such as the Devices class, to simplify common operations, like fetching all device NED ID's.

Requirements

• NSO RESTCONF Configuration
  • To use this library, RESTCONF must be enabled in NSO. Please refer to the documentation specific to the NSO version being used to determine how to enable RESTCONF in NSO.

Installation

You can install the library using pip:

pip install cisco-nso-restconf

Client Class

Use the NSORestconfClient class to interact with the NSO RESTCONF API /data resource

Methods Supported

• GET, POST, DELETE

Utility Classes

To make the process easier, the library also provides utility classes for specific tasks. For example, the Devices class simplifies interaction with tailf-ncs:devices RESTCONF resources.

Available Utility Classes

Class	Description
Devices	Interact with the NSO tailf-ncs:devices resource

Closing Sessions

When using the NSORestconfClient, it’s important to close the session when you’re done to free up resources. You can do this using the close() method, as shown in the examples above.

Examples

There are a number of examples provided for utilizing the Client classes and various Helper classes, such as the Devices class. The examples are intended to showcase basic use cases/workflows for acheiving a specific function in NSO, such as retreiving NED ID's, device groups, life cycle of a VLAN resource, life cycle of a service, and so on.

Contributing

We welcome contributions! Feel free to open issues or submit pull requests. For development, we recommend using Poetry to manage dependencies and packaging.

poetry install

License

This project is licensed under the MIT License.