Learn Tutorials - Explore use cases for getting to production quicker

Welcome to our use-case-based tutorials providing a collection of feature-rich introductory examples that span NSP's key functional areas. The tutorials describe step-by-step workflows with links to sample scripts in a variety of programming languages for each use case.

Explore NSP Usecases

API Clients can access and authenticate their applications via the NSP's REST Gateway API. This API provides the entry point for API clients to list the location of the API services and authenticate REST client requests to gain access to the various NSP modules with registered API services.

The NSP REST Gateway APIs provides the initial entry point to access registered NSP API services of NSP modules. These APIs allow OSS clients to perform the following functions:

The NSP API provides a notification interface that allows an OSS application to receive and monitor events as well as alarms that originate from NSP managed networks.  The following tutorial describes the Kafka Notification Implementation, including how an API Client can use the interface to perform API client subscription,  filtering on events, retrieving and handling network and system events.

NSP allows OSS applications to subscribe to the notification service and monitor NSP-generated events.  The NSP notification service is built on Apache Kafka, which is a distributed streaming platform.

Kafka has three main components:

OSS Inventory Management applications store information from NSP networks, so API developers need to understand how NSP network objects are modeled, how to upload those objects to their systems and how to maintain their inventory.  NSP has APIs that provides these functions in a variety of ways depending on the data that is required.  Our tutorials provide guidance on the following use cases-

  • Retrieving Basic inventory information on the physical elements of IP or Optical Networks.
  • Retrieving Basic inventory information (NEs, physical links, Services and Tunnels) on a Carrier SDN network.


The NSP REST API provides interfaces that allow OSS applications to request information about the NSP-managed network.  For this use case, the browser-based Network Supervision application has a set of REST API services that model the following object types on the network:

The NSP API includes operations that allow clients to retrieve and, where applicable create, update and delete infrastructure objects such as nodes, ports, and IGP links. 


The NSP API includes interfaces to retrieve object details using a filter and/or result filter.


This NSP API is derived from SAMO XML API.

OSS applications can use the NSP REST APIs to perform configuration and provisioning operations on NSP's Carrier SDN and IP/Optical network objects and their associated child objects. This is achieved by sending REST API requests that allow the OSS's to create, delete, or modify existing objects. Below we've highlighted Carrier SDN provisioning examples on an IP and Optical Network, using the Carrier SDN REST APIs. We also provided configuration sample requests on an IP/MPLS Network using the IP/MPLS Platform REST API.

NSP provides APIs that allows you to provision and activate ELINE services that connects two customer Ethernet ports over an IP or optical Carrier network.

NSP can be used to manage OCh and ODU optical services. 

The IP/MPLS Platform provides a set of REST north bound interfaces that allow OSS applications to retrieve, create, update, or delete information on the managed objects in an IP/MPLS managed network.

NSP allows assigning of resources, either nodes or ports, to specific tenants. Tenants are also assigned roles to manage or view their resources. This API provides mangement of tenants and their resources. 

The NSP Carrier SDN module includes APIs that exposes the optimisation functions which perform multi-domain and multi-layer WAN path computations across IP/MPLS, optical or hybrid IP/optical multi-vendor networks. The NSP APIs can be used to define the policies that are used to employ various path optimization algorithms to ensure the best path placement for services and load-balancing for path distribution across the network. The NSP APIs also exposes NSP's flow controller that is responsible for implementing SDN-based, traffic-steering-related protocols for manipulating and optimising flow-based protocols on the NEs on the network.

Optimization of the network can be achieved by using policies. This is done by enabling policy-driven behavior by managing the rules that allow the NSP API to customize network policies for routing algorithms selection and execution.

The Carrier SDN module includes API services that allows an API client to manipulate flow rules, by sending requests to NSP's openflow controller to add or delete flow rules.

NSP's Assurance capabilities are exposed by REST APIs which will enable developers to create applications that ensure Carrier SDN services and IP/MPLS and Optical networks are operational and monitored to ensure optimal performance.  This can be achieved by using NSPs Fault Management, Performance Mangement and OAM REST API services. 

NSP also provides Analytics APIs for generating reports and dashboard views of network conditions using raw and aggregated data which can be used for evaluating current conditions and identifying patterns and trends respectively.

The Tutorials described in this section provides:-

  • Assurance samples for retrieving and managing faults, performing OAM validation tests on network services and monitoring network performance
  • Guidance on how to use the Analytics APIs to embed and run reports that are generated from the NSP Analytics application on your own webpage or app.

The Fault Management application provides a list of REST API to manage alarms.  A user can acknowledge an alarm, with or without an acknowledge notes.  Also a user can unacknowledge an alarm; update an alarm with attributes changes; as well as delete an alarm.

Service Assurance is commonly achieved by performing OAM diagnostic testing and troubleshooting of network services.

The Fault Management application provides a means of investigating faults in a network. A user can view information about faults, such as their causes and impacts. Below is a list of published operations that can be used to obtain information about alarms.

Performance Management is essential for service providers to monitor network performance in real-time or to collect log data for later analysis.

The Analytics API generates reports of network conditions using raw and aggregated data. Raw data is typically used for evaluating current conditions; aggregated data helps to identify patterns and trends.

This section introduces you to more advanced NSP API use-case tutorials.

The Carrier SDN modules of NSP includes API services that allows API clients to perform traffic optimization by steering traffic on monitored routers, on a per-destination-AS-basis, to alternate next hops.