Software Description

This chapter provides a general overview of the Cisco ONS 15200 Command Line Interface (CLI).

1.1 Features

The following list describes the features of the ONS 15200 CLI:

Remote system visibility—You can use the ONS 15200 CLI at any computer connected to a Network Control Board (NCB) module in the ONS 15200 network.
Requires no local software—Because the ONS 15200 CLI runs via a telnet connection, you can establish a command prompt on any device with a telnet client, such as a PC or UNIX workstation.
User levels—The ONS 15200 CLI offers three user levels: guest user, operator, and administrator. Some commands can only be performed by one user level, while others can be performed by multiple user levels.
Real-time—The ONS 15200 CLI provides a real-time view of the network. Changes to the system are reported immediately.
Ethernet connection—The ONS 15200 CLI connects to the ONS 15200 network through an Ethernet connection. The CLI can connect directly to the Network Control Board (NCB) module or indirectly through any computer connected to an ONS 15200 network.

The ONS 15200 CLI uses a UNIX-style, character-based user interface that allows you to communicate directly with the NCB module and provides commands that allows users to add, delete, and configure objects, alarms, and parameters.

1.2.1 Command Line Editing

The UNIX-style command line interpreter uses features specific to the ONS 15200 Command Line Interface. Table 1-1 lists the command line editing features.

Table 1-1: Command Line Editing Features

Command	Result
<Ctrl> a	Go to the beginning of the line.
<Ctrl> e	Go to the end of the line.
<Ctrl> f	Go forward one character.
<Ctrl> b	Go backward one character.
<Ctrl> d	Delete one character at the cursor.
<Ctrl> k	Delete from the cursor to the end of the line.
<Ctrl> n	Scan command history forward.
<Ctrl> p	Scan command history backward.
?	List available commands.

1.2.2 Command Syntax

Many commands available in the ONS 15200 Command Line Interface have parameters that allow you to configure specific aspects of a given command. Command parameter syntax follows rules that help the user identify which parameters are optional, which are required, which need to be repeated, and so on. These rules follow:

Table 1-2: Command Conventions

Convention	Description
bold text	Command or keyword that you must enter.
italic text	Parameter or argument for which you supply a value.
[x]	Optional keyword or argument that you may enter.
{ x \| y \| z }	Choice or alternate values (select only one).
[x {y\|z}]	A required choice within an optional element.
<x>	A required parameter

1.0.1 Access Modes

The ONS 15200 Command Line Interface has three operating modes. One mode grants read-and-write access to the parameters; the second mode grants read-only access; and the third grants access to the system commands. The command line prompt indicates the current mode.

> indicates read-only mode
# indicates read-and-write mode
= indicates system command mode

Some commands, such as the configure command, automatically enter read-and-write mode. The prompt indicates the current mode, regardless of how the modes were entered or exited. The user's access privileges may prevent the user from entering read-and-write mode.

1.0.2 Focus

The network database has a structure similar to a file system. The data is structured hierarchically, with nodes and leaves. A leaf is a container for a value, and a node groups related leaves (i.e., values) together in a tree structure. When you need to manipulate or monitor many values on a certain level, you must set the current focus to a local top-node rather than the database top-node. Some commands, such as the create and configure commands, may also change the focus. A new focus also changes the command line prompt.