SUMMARY.md

Table of contents

• What's New

Administration

• Get Started
• Installation and Deployment
  • Local Install
  • System Install
  • Post-Install Actions
    • Explore the Installation
    • Start and Stop NSO
    • Create NSO Instance
    • Enable Development Mode
    • Running NSO Examples
    • Migrate to System Install
    • Modify Examples for System Install
    • Uninstall Local Install
    • Uninstall System Install
  • Containerized NSO
  • Development to Production Deployment
    • Develop and Deploy a Nano Service
    • Secure Deployment
    • Deployment Example
  • Upgrade NSO
• Management
  • System Management
    • Cisco Smart Licensing
    • Log Messages and Formats
    • Alarm Types
  • Package Management
  • High Availability
  • AAA Infrastructure
  • NED Administration
• Advanced Topics
  • Locks
  • CDB Persistence
  • IPC Connection
  • Cryptographic Keys
  • Service Manager Restart
  • IPv6 on Northbound Interfaces
  • Layered Service Architecture

Operation & Usage

• Get Started
• CLI
  • Introduction to NSO CLI
  • CLI Commands
• Web UI
  • Home
  • Devices
  • Services
  • Config Editor
  • Transactions
  • Tools
• Operations
  • Basic Operations
  • NEDs and Adding Devices
  • Manage Network Services
  • Device Manager
  • Out-of-band Interoperation
  • SSH Key Management
  • Alarm Manager
  • Plug-and-Play Scripting
  • Compliance Reporting
  • Listing Packages
  • Lifecycle Operations
  • Network Simulator

Development

• Get Started
• Introduction to Automation
  • CDB and YANG
  • Basic Automation with Python
  • Develop a Simple Service
  • Applications in NSO
• Core Concepts
  • Services
  • Implementing Services
  • Actions
  • Templates
  • Nano Services
  • Packages
  • Transactions
  • Using CDB
  • YANG
  • NSO Concurrency Model
  • Service Handling of Ambiguous Device Models
  • NSO Virtual Machines
    • NSO Python VM
    • NSO Java VM
    • Embedded Erlang Applications
  • API Overview
    • Python API Overview
    • Java API Overview
  • Northbound APIs
    • NSO NETCONF Server
    • RESTCONF API
    • NSO SNMP Agent
    • NSO MCP Server
• Advanced Development
  • Development Environment and Resources
  • Developing Services
    • Services Deep Dive
    • Service Development Using Java
    • NSO Developer Studio
  • Developing Packages
  • Developing NEDs
    • NETCONF NED Development
    • CLI NED Development
    • Generic NED Development
    • SNMP NED
  • Developing Alarm Applications
  • Kicker
  • Scaling and Performance Optimization
  • Progress Trace
  • Web UI Development
    • JSON-RPC API
• Connected Topics
  • SNMP Notification Receiver
  • Web Server
  • Scheduler
  • External Logging
  • Encrypted Strings

Resources

• Manual Pages
  • clispec
  • confd_lib
  • confd_lib_cdb
  • confd_lib_dp
  • confd_lib_events
  • confd_lib_ha
  • confd_lib_lib
  • confd_lib_maapi
  • confd_types
  • mib_annotations
  • ncs
  • ncs-backup
  • ncs-collect-tech-report
  • ncs-installer
  • ncs-maapi
  • ncs-make-package
  • ncs-netsim
  • ncs-project
  • ncs-project-create
  • ncs-project-export
  • ncs-project-git
  • ncs-project-setup
  • ncs-project-update
  • ncs-setup
  • ncs-uninstall
  • ncs.conf
  • ncs_cli
  • ncs_cmd
  • ncs_load
  • ncsc
  • tailf_yang_cli_extensions
  • tailf_yang_extensions

Developer Reference

• Python API Reference
  • ncs Module
  • ncs.alarm Module
  • ncs.application Module
  • ncs.cdb Module
  • ncs.dp Module
  • ncs.experimental Module
  • ncs.log Module
  • ncs.maagic Module
  • ncs.maapi Module
  • ncs.progress Module
  • ncs.service_log Module
  • ncs.template Module
  • ncs.util Module
  • _ncs Module
  • _ncs.cdb Module
  • _ncs.dp Module
  • _ncs.error Module
  • _ncs.events Module
  • _ncs.ha Module
  • _ncs.maapi Module
• Java API Reference
• Erlang API Reference
  • econfd Module
  • econfd_cdb Module
  • econfd_ha Module
  • econfd_logsyms Module
  • econfd_maapi Module
  • econfd_notif Module
  • econfd_schema Module
• RESTCONF API
  • Sample RESTCONF API Docs
• NETCONF Interface
• JSON-RPC API
• SNMP Agent
• XPath