Manual Pages

Section 1: User Commands and Programs

• ncs command to start and control the NCS daemon

• ncs-backup Command to backup and restore NCS data

• ncsc NCS YANG compiler

• ncs_cli Frontend to the NSO CLI engine

• ncs_cmd Command line utility that interfaces to common NSO library functions

• ncs-collect-tech-report Command to collect diagnostics from an NCS installation.

• ncs-installer NCS installation script

• ncs_load Command line utility to load and save NSO configurations

• ncs-maapi command to access an ongoing transaction

• ncs-make-package Command to create an NCS package

• ncs-netsim Command to create and manipulate a simulated network

• ncs-project Command to invoke NCS project commands

• ncs-project-create Command to create an NCS project

• ncs-project-export Command to create a bundle from a NCS project

• ncs-project-git For each package git repo, execute a git command

• ncs-project-setup Command to setup and maintain an NCS project

• ncs-project-update Command to update and maintain an NCS project

• ncs-setup Command to create an initial NCS setup

• ncs-uninstall Command to remove NCS installation

• nct Deprecated. Should not be used. A collection of tools that can be used to install and manage NCS nodes.

• nct-backup Deprecated. Should not be used. Perform an NCS backup on Host(s)

• nct-check Deprecated. Should not be used. Check the availability of a cluster of nodes

• nct-cli-cmd Deprecated. Should not be used. Execute a CLI command on host(s)

• nct-copy Deprecated. Should not be used. Copy a file to the specified host(s)

• nct-get-logs Deprecated. Should not be used. Get a tar-ball of the NSO log dir from the specified host(s)

• nct-ha Deprecated. Should not be used. High Availability handling using the NSO built in HA actions

• nct-hostsfile Deprecated. Should not be used. A complete list of all available options

• nct-install Deprecated. Should not be used. Install an NCS release on host(s)

• nct-load-config Deprecated. Should not be used. Load NCS configuration on host(s)

• nct-move-device Deprecated. Should not be used. Move devices between cluster device nodes

• nct-packages Deprecated. Should not be used. Install NCS packages on host(s)

• nct-patch Deprecated. Should not be used. NCS beam patch handling

• nct-ssh-cmd Deprecated. Should not be used. Execute a remote ssh command on host(s)

• nct-start Deprecated. Should not be used. Start NCS on host(s)

• nct-stop Deprecated. Should not be used. Stop NCS on host(s)

• nct-upgrade Deprecated. Should not be used. Install an NCS release on host(s)

Section 3: C Library Functions

• confd_lib C library for connecting to NSO
• confd_lib_cdb library for connecting to NSO built-in XML database (CDB)
• confd_lib_dp callback library for connecting data providers to ConfD
• confd_lib_events library for subscribing to NSO event notifications
• confd_lib_ha library for connecting to NSO HA subsystem
• confd_lib_lib common library functions for applications connecting to NSO
• confd_lib_maapi MAAPI (Management Agent API). A library for connecting to NCS
• confd_types NSO value representation in C

Section 5: File Formats and Syntax

• clispec CLI specification file format
• mib_annotations MIB annotations file format
• ncs.conf NCS daemon configuration file format
• tailf_yang_cli extensions Tail-f YANG CLI extensions
• tailf_yang_extensions Tail-f YANG extensions