Software Description

This chapter provides a general overview of the ONS 15200 Command Line Interface.

1.1 Features

The following list describes the features of the ONS 15200 Command Line Interface:

Remote system visibility—The ONS 15200 Command Line Interface can be used at any computer connected to the ONS 15200 network.
Requires no local software—Because the ONS 15200 Command Line Interface runs via a Telnet connection, the user can establish a command prompt on a personal computer (PC).
User levels—The ONS 15200 Command Line Interface offers three different user levels: guest user, operator, and administrator. Each user level has its own set of commands.
Real-time—The ONS 15200 Command Line Interface provides a real-time view of the network. Changes to the system are reported immediately.
Ethernet connection—The ONS 15200 Command Line Interface connects to the ONS 15200 network through an Ethernet connection. It can be connected directly to the Network Control Board (NCB) module or indirectly through any computer connected to the ONS 15200 network.

The ONS 15200 Command Line Interface uses a UNIX-style, character-based user interface that allows users to communicate directly with the NCB module. The Command Line Interface 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

<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 commands.

1.2.2 Syntax

Many commands available in the ONS 15200 Command Line Interface have parameters that allow the user to configure specific aspects of a given command. These parameters are often required, but some are optional and can be omitted. 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:

A parameter enclosed by square brackets ([ and ]) is optional and can be omitted from the command.
Angle brackets (< and >) indicate a required parameter.
A plus sign (+) indicates that there is one or more occurrences of the parameter.
An asterisk (*) indicates that there are zero or more occurrences of the specifier.

1.2.3 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 access privileges of the current user may prevent the user from entering read-and-write mode.

1.2.4 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 is a means to group related leaves (i.e., values) together in a tree structure. When many values on a certain level should be manipulated or monitored, it is necessary to 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.

NCB:>configure user testadm
Configure 'testadm'
testadm:#exit
NCB:>

Table of Contents