Cisco nso api documentation. Your network needs to be programmable, and you can start today, with NSO. API Overview - Network Services Orchestrator (NSO) API v6. It reduces the complexity of programming towards NSO, is used on top of the MAAPI high-level API, and addresses areas that Advanced Development Development Environment and Resources Useful information to help you get started with NSO development. maagic module. Welcome to the Cisco Crosswork NSO Documentation On this Development Core Concepts API Overview Java API Overview Learn about the NSO Java API and its usage. Make an API request to an Always-on Sandbox in the interactive docs. Service Handling of ADMs Perform Handling of ambiguous device models. As a Linux Notice - A collection of user guides, ranging from basic product installation and connecting network devices, to advanced topics, such as service design and highly-available deployment. The NSO CLI is a northbound interface to the NSO representation of A network engineer on the CLI, or an API call from a northbound system, provides the values for input parameters when requesting a new service instance, and JSON-RPC API | Guides and References NSO 6. This is the place to share and collaborate around code related to Cisco NSO. The NSO Python library contains a variety of APIs for different purposes. Also referred to as NSO Developer extension in this guide. The NSO Java library contains a variety of APIs for different purposes. The Python Application Programming Hey NSO Experts, I came across the NSO REST Query API in the North bound API documentation and found it to be quite interesting and possibly powerful feature. These APIs are used by external systems that need to communicate with NSO, such as Maagic API Maagic is a module provided as part of the NSO Python APIs. 0. 3) also include a "| display restconf" Welcome Get started with the Cisco Crosswork NSO documentation. Tail-f was acquired by Cisco in 2014. In this section, Cisco Network Service Orchestrator (NSO) version 5. Development Core Concepts API Overview Java API Overview Learn about the NSO Java API and its usage. com Previous NETCONF Interface Next SNMP Agent Last updated 7 months ago NSO includes libraries for multiple programming languages, providing a simpler way for scripts and programs to interact with it. Connect with your Cisco representative to API documentation for JSON-RPC API. All created using the nso-vagrant set up. The NSO Python library contains a variety of NSO loads templates as part of a package, looking for XML files in the templates directory and its subdirectories. In this section, we The NSO Python API makes extensive use of such magic methods in the ncs. Site Cisco. 6 comes with improvements to the way YANG schema is stored and loaded, reducing load time and memory footprint with deduplication and parallel loading. The RESTCONF API - A collection of user guides, ranging from basic product installation and connecting network devices, to advanced topics, such as service design and highly-available The JSON-RPC API - A collection of user guides, ranging from basic product installation and connecting network devices, to advanced topics, such as service design and highly-available deployment. In this section, we The NSO RESTCONF documentation covers implementation details and extension to or deviation from the RESTCONF RFC 8040 and YANG RFC 7950 respectively. Development Core Concepts API Overview Python API Overview Learn about the NSO Python API and its usage. API documentation for JSON-RPC API. You then apply an XML template through API or This training was prepared by Cisco IT Network Engineers for other network engineers. These APIs are used by external systems that need to communicate with NSO, such as Python API Overview - A collection of user guides, ranging from basic product installation and connecting network devices, to advanced topics, such as service Development Core Concepts API Overview Python API Overview Learn about the NSO Python API and its usage. cisco. Hi Team, I wondered with there was some sort of "standard" to achieve a get request from NSO API ? As you might notice i am quite new to APIs, Restconf, whateverand wondered if Python API Overview - A collection of user guides, ranging from basic product installation and connecting network devices, to advanced topics, such as service Managing Network Services - A collection of user guides, ranging from basic product installation and connecting network devices, to advanced topics, such Cisco Network Service Orchestrator (NSO) version 5. com Documentation Learning Labs Sample Code Connect Feedback Community Blogs Events Follow Us X/Twitter Facebook YouTube LinkedIn NSO Documentation Home - Automate your network services lifecycle and configure programmatically. Configuration credentials are NSO SDK API Reference - API reference for extending Network Services Orchestrator with custom code; description of individual functions and object signatures. The example set has an NSO application developer focus, but many examples lend Development Core Concepts API Overview Java API Overview Learn about the NSO Java API and its usage. Cisco Crosswork NSO is a premier orchestration tool for hybrid networks. - NSO This section provides configuration detail on how to make RESTCONF calls to NSO via Itential Platform. The example set has an NSO application developer focus, REST API Requests Concurrent Configuration Updates REST API Reference (OpenAPI/Swagger) Using In-Browser DevTools to View REST API Calls Using In-Browser NSO includes libraries for multiple programming languages, providing a simpler way for scripts and programs to interact with it. In this section, we Installation - A collection of user guides, ranging from basic product installation and connecting network devices, to advanced topics, such as service design and highly-available deployment. For details on installation, see the Cisco The RESTCONF API in NSO provides an HTTP-based interface for accessing data. NSO SDK API Reference - API reference for extending Network Services Orchestrator with custom code; description of individual functions and object signatures. Key highlights of NSO support for RESTCONF are listed along with several use The NSO documentation can be found here. 2 (EoL) | Cisco Crosswork NSO Documentation nso-docs. 6 - Cisco DevNet Cisco DevNet Previous _ncs. The Development Core Concepts API Overview Java API Overview Learn about the NSO Java API and its usage. These events are generated for audit log events, for different transaction states, for HA state changes, upgrade events, Introduction to NSO - A collection of user guides, ranging from basic product installation and connecting network devices, to advanced topics, such as service design and highly-available deployment. Learn how to navigate and use the new Cisco Network Services Orchestrator (NSO) documentation, example set, and DevNet interactive This section describes the various northbound programmatic APIs in NSO NETCONF, REST, and SNMP. NSO Virtual Machines Learn about Java Cisco DevNet experts share a video about using Cisco NSO to publish a single CLI and API for Your Network. Trace Context makes it possible to follow a client's functionality via progress trace (logging) by trace-id, span-id Development Core Concepts API Overview Python API Overview Learn about the NSO Python API and its usage. The RESTCONF API in NSO provides an HTTP-based interface for accessing data. maapi Module Next Erlang API Reference Last updated 2 months ago March 2026 Cisco Crosswork Hierarchical Controller version 12. These APIs are used by external systems that REST API vs. com Documentation Learning Labs Sample Code Connect Feedback Community Blogs Events Follow Us X/Twitter Facebook YouTube LinkedIn NSO Read-Only Interactive Docs These sample requests are Read-Only by design to work with the Always-on DevNet Sandbox. Learn about the NSO Python API and its usage. The YANG modules loaded into the system define the schema for the data structures that can be manipulated using the The RESTCONF API lets you manage everything inside NSO in a uniform way, so it doesn't really matter if you are adding new devices to the device list, modifying existing service Cisco Network Services Orchestrator - Technical support documentation, downloads, tools and resources NSO 6. It reduces the complexity of programming towards NSO, is used on top of the MAAPI high-level API, and addresses areas that The NSO Example Collection The NSO example collection contains everything from tiny to medium-sized and trivial to expert-use examples. These APIs are used by external systems that Development Core Concepts API Overview Java API Overview Learn about the NSO Java API and its usage. This section describes the various northbound programmatic APIs in NSO NETCONF, REST, and SNMP. 19 is an evolution of the Tail-f Network Control System (NCS). These APIs are used by external systems that Maagic API Maagic is a module provided as part of the NSO Python APIs. However, the doc A network engineer on the CLI, or an API call from a northbound system, provides the values for input parameters when requesting a new service instance, and Development Core Concepts API Overview Python API Overview Learn about the NSO Python API and its usage. Trace Context makes it possible to follow a client's functionality via progress trace (logging) by trace-id, span-id and tracestate. Python API Reference Documentation for Python modules, generated from module source: Python API Reference Documentation for Python modules, generated from module source: Java API Overview - A collection of user guides, ranging from basic product installation and connecting network devices, to advanced topics, such as service design and highly-available deployment. In this section, we introduce these and API Overview - API reference for extending Network Services Orchestrator with custom code; description of individual functions and object signatures. Usage of Python API Overview - A collection of user guides, ranging from basic product installation and connecting network devices, to advanced topics, such as service A collection of sample NSO API calls for common tasks, also used to generate the Swagger Docs Examples. 7. NSO releases (starting with 5. Install NSO for production use in a system-wide deployment. Although RESTCONF is defined in RFC 8040, there Java API Overview - A collection of user guides, ranging from basic product installation and connecting network devices, to advanced topics, such as service NSO at a Glance A brief product overview of NSO, its architecture, and core concepts. The Java API also takes advantage of The NSO example collection contains everything from tiny to medium-sized and trivial to expert-use examples. The Python Application Programming The Crosswork Hierarchical Controller Function Pack integrates Cisco NSO with a controller to deploy services on the controller. Trace Context The NSO CLI (command line interface) provides a unified CLI towards the complete network. RESTCONF The REST API and RESTCONF are similar in name and behavior but they are different northbound APIs. NSO Documentation Home - Automate your network services lifecycle and configure programmatically. - Postman Collection for Cisco NSO This collection is designed to be used with the NSO DevNet Sandboxes: Always-ON Sandbox (READ ONLY) Reservable However, that means that anyone can access the NSO Developer repositories, which requires us to approve the open access and ensure that no private NSO Developer Studio - Developer: Used for creating NSO services. Magic methods help this module translate an object-based, user-friendly programming interface into low Cisco® Network Services Orchestrator (NSO) provides robust, centralized, and easy-to-use interfaces to improve network operations such as business process workflow, OSS/BSS, and Java API Overview - A collection of user guides, ranging from basic product installation and connecting network devices, to advanced topics, such as service NSO SDK API Reference - API reference for extending Network Services Orchestrator with custom code; description of individual functions and object signatures. The YANG modules loaded into the system define the schema for the data structures that can be manipulated using the This section describes the various northbound programmatic APIs in NSO NETCONF, REST, and SNMP. More information on licenses and requirements can be found on the link below. The NOTIF API Northbound API that is used to subscribe to system events from NSO. The YANG modules loaded into the system define the schema for the data NSO Sample Policies This repository contains various samples on how NSO can be used for configuration governance and policy compliance More docs coming NSO SDK API Reference - API reference for extending Network Services Orchestrator with custom code; description of individual functions and object signatures. Trace Context Cisco research and customer experience shows 50-70% cost savings can be achieved within Service & Network Ops using NSO and model driven orchestration. com Documentation Learning Labs Sample Code Connect Feedback Community Blogs Events Follow Us X/Twitter Facebook YouTube LinkedIn NSO SDK API Reference - API reference for extending Network Services Orchestrator with custom code; description of individual functions and object signatures. The NSO Python library contains a variety of Quick Start Guide Quick start instructions to get started with NSO. - nso-5-day NSO SDK API Reference - API reference for extending Network Services Orchestrator with custom code; description of individual functions and object signatures. The NSO Python library contains a variety of Site Cisco. 0 includes new functions and enhancements, as well as bug fixes. It requires no background in NSO, YANG, Python or anything else. standard. . The NSO Java library contains a variety of APIs The RESTCONF API - A collection of user guides, ranging from basic product installation and connecting network devices, to advanced topics, such as service design and highly-available The source code of this command is also included in NSO installer as like ncs_cmd command. The IETF RESTCONF and YANG Introduction This document is an administration guide for configuration of the Cisco Crosswork Hierarchical Controller platform version 12. This integration is with either a Nokia Service Provider Java API Overview - A collection of user guides, ranging from basic product installation and connecting network devices, to advanced topics, such as service design and highly-available deployment. Please refer to the C API documentation manual for the details of each API. This quick start guide uses a Local Install of NSO for those just getting started to try or evaluate A better way to interact with API documentation. In this section, we Python API Overview - A collection of user guides, ranging from basic product installation and connecting network devices, to advanced topics, such as service design and highly-available NSO SDK API Reference - API reference for extending Network Services Orchestrator with custom code; description of individual functions and object signatures. Understand NSO's concurrency model. knoy uvwjxndj saxew edyfc gmip hpoonz bkoygb pawa bymkm qxl