Start


Use this page to navigate your way through the NSO documentation and access the NSO resources most relevant to your role.

Learn NSO

If you are new to NSO or interested in learning about NSO features, start with the following topics:

  • Solution Overview: Familiarize yourself with NSO by starting with solution overview.

  • NSO Introduction in Getting Started: Build your knowledge of core NSO concepts.

  • Hands-on Labs: Go hands-on with NSO and build further on basics by exploring NSO labs.

Work with NSO

An NSO deployment typically consists of the following roles:

Table 1. NSO Roles
Administrator Personnel who install, upgrade, or manage an NSO deployment.
Operator Personnel (e.g. network engineers) who operate and interface with an NSO deployment.
Developer Personnel who develop NSO services and packages.

Administrate and Manage NSO

If you are a system administrator looking to install and manage your NSO deployment, start here.

  • Deployment Example in Administration Guide: Plan your installation by understanding NSO deployment with examples.

  • Installation in Getting Started: Get started with installation with guided instructions to help you install NSO for evaluation or production use.

  • Upgrade in Administration Guide: Upgrade your NSO deployment to the latest and greatest version.

  • System Management in Administration Guide: Learn how to configure and manage your NSO deployment.

  • General Administration in Administration Guide: Learn how to manage users, packages, and devices in your NSO deployment.

Consult the Admin Guide for other administration topics relating to NSO alarms, AAA infrastructure, High Availability (HA), etc.

Operate NSO

If you are an NSO user looking to operate and interface with your NSO deployment, start here.

  • Basic Operations in User Guide: Learn about basic operational scenarios and get acquainted with the most common CLI commands.

  • Web UI in User Guide: Interact and perform operations on your NSO deployment using the web interface.

  • CLI in User Guide: Interact and perform operations on your NSO deployment using the command line interface.

Consult the User Guide in User Guide for topics relating to NSO usage and operation, such as NEDs, management of devices and network services, SSH keys, alarms, scripting, packages, etc.

Develop in NSO

If you are an NSO developer looking to develop NSO services and packages, start here.

  • NSO Development in Development Guide: Bring automation in your NSO deployment by creating your own services using simple XML templates or implementing custom logic with the provided API.

  • Web UI Development in Web UI: Learn about building a custom web frontend on top of your NSO deployment.

  • Layered Service Architecture in Layered Service Architecture: Learn how to design very large, scalable services to manage services for millions of users, ranging over several hundred thousand managed devices.

  • NSO Developer Studio in Development Guide: Use NSO's Visual Studio Code extensions to build your services and explore your NSO instances.

  • API Documentation: Use NSO's Northbound REST-style interface to read data or push configuration from another system, or otherwise extend the functionality of NSO with Python, Java, and Erlang APIs to add custom service code or expose data through data provider mechanism. Read more about Northbound APIs here in Northbound APIs .

  • Network Simulator (Netsim) in User Guide: Simulate a network of devices to be managed by NSO.

Get in Touch

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

Cisco NSO 6.3_240507

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.

NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS" WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: https://www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)

This product includes software developed by the NetBSD Foundation, Inc. and its contributors.

This product includes cryptographic software written by Eric Young (eay@cryptsoft.com).

This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit http://www.openssl.org/.

This product includes software written by Tim Hudson (tjh@cryptsoft.com).

U.S. Pat. No. 8,533,303 and 8,913,519