NSO 6.4.1 SDK API Reference

The APIs described in this Cisco Network Services Orchestrator (NSO) SDK API reference are designed for extending the functionality of the product, such as adding custom service code or exposing data through data provider mechanism. You might think of them as a kind of a plugin API.

If you are just trying to read data or push configuration from another system, consider using one of the so-called Northbound Interfaces (NBIs) instead. NBIs were designed to let other systems interact with NSO and you might find them easier to use. One of them exposes a REST-style interface, for example. Please consult the northbound interface-specific parts of documentation for more information.

The SDK API reference is automatically generated from the programming library source code. You can also access this same information inside your Integrated Development Environment (IDE), if your IDE supports it.

Bindings are available for multiple programming languages and provide roughly the same functionality but differ in the level of abstraction on top of the core API. For example, Python bindings implement additional, higher-level classes and functions to make the API easier to use.

The reference describes individual functions and classes but provides very few complete examples. It is strongly recommended to read the Development guide first. It contains many examples and explains the data modeling and transaction concepts required for you to efficiently use the APIs described here. Development guide is available at https://developer.cisco.com/docs/nso, along with other product documentation.

A Note on Names

Cisco NSO consists of a number of tools and executables, which have evolved from the Tail-f Network Control System (NCS). The names 'ncs' and 'tail-f' are used extensively in file names, command-line command names, YANG models, application programming interfaces (APIs), etc.

Support Contact

For additional support, please refer to https://www.cisco.com/go/support.

Cisco NSO 6.4.1