This chapter provides detailed descriptions of the guest user-level Command Line Interface commands supported by ONS 15200 system network elements (NEs). Commands are sent asynchronously during active sessions. To issue Command Line Interface commands, the user must be connected to an NE, and must have adequate permission.

Command Line Interface commands are divided into several groups. These groups allow the user to quickly identify the type of command and the level at which the command is issued.

4.1 Display Element

COMMAND CODE:	display element <object name>
MESSAGE CATEGORY:	All Categories
TYPE:	Generic
PROTOCOL:	TCP/IP

4.1.1 Purpose

The display element command grants read-only access to the parameters of the selected element. The command automatically sets the focus to the element. Use the exit command to exit this mode. The following lists the sub-commands available under the display element command:

cd [<path>] With ".." goes up one level, or alone will print the current path

exit Exit "configure element" mode

list parameter|value|recurse Lists parameters, parameter values, or scans subnodes

no suppress|inhibit Discontinues suppress/inhibit command

inhibit [<path>] Disables alarm point

suppress [<path>] Suppress alarm

upload [<path>] Synchronize the database with the object

whoami Displays current user

4.1.2 Input Format

display element <object name>

4.1.3 Input Parameters

<element name>

The name assigned to the selected element

4.1.4 Normal Response Format

NCB:>display element <element name>
Display `<element name>'
<element name>:

4.1.5 Error Response Format

-- Not enough access --

-- Path not found --

-- Insufficient size --

-- Wrong number of arguments [display element <element name>] --

-- Missing argument --

-- Unexpected reply code (<error code>) --

4.1.6 Response Parameters

<element name>	The name assigned to the selected element
<error code>	Number assigned to this error. Report this number to Cisco personnel.

4.1.7 Normal Response Example

NCB:>display element clip_341
Display 'clip_341'
clip_341:>list value
clip_341:
dcnaddress           0x1080
status               normal
state                online
neid                 341
itu                  25
datarate             stm_16
pm                   on
unittype             clip
clippartno           800-13404-01
clipserno            HAG05010341
necpartno            17-6285-04
necrevno             1.0(1)
clei                 AAAAAAAAAA
client               <node>
dwdm                 <node>
dcn                  <node>
environment          <node>
cm                   <node>
rxtp                 <node>
txtp                 <node>
board                <node>
clip_341:>

4.2 Exit

COMMAND CODE:	exit
MESSAGE CATEGORY:	All Categories
TYPE:	Generic
PROTOCOL:	TCP/IP

4.2.1 Purpose

The exit command closes the current Command Line Interface mode. When this command is issued at the top level, the Command Line Interface session is terminated.

4.2.2 Input Format

exit

4.2.3 Normal Response Format

mycommunity:exit
NCB:>

4.2.4 Normal Response Example

mycommunity:exit
NCB:>

4.3 Password

COMMAND CODE:	password
MESSAGE CATEGORY:	All Categories
TYPE:	Generic
PROTOCOL:	TCP/IP

4.3.1 Purpose

The password command is used to change the password of the current logged-in user. The command will prompt for the new password and then will ask for a confirmation of the new password. If the two passwords are identical, the new password is automatically committed. The password can be set to any string that contains at least 6 characters and up to 30 characters. Valid characters are a through z, 0 through 9, A through Z, and the "_" (underscore) character.

4.3.2 Input Format

password

4.3.3 Normal Response Format

NCB:>password
Type new password: ******
Confirm new password: ******
NCB:>

4.3.4 Response Parameters

******

The characters that represent the new password.

4.3.5 Normal Response Example

NCB:>password
Type new password: ******
Confirm new password: ******
NCB:>

4.4 Show Alarm

COMMAND CODE:	show alarm [alarm\|warning\|summary]
MESSAGE CATEGORY:	All Categories
TYPE:	Generic
PROTOCOL:	TCP/IP

4.4.1 Purpose

The show alarm command scans all hub nodes and collector nodes controlled by NCB and reports all raised alarms.

4.4.2 Input Format

show alarm [alarm|warning|summary]

4.4.3 Input Parameters

alarm	Show only alarms with the "alarm" status
warning	Show only alarms with the "warning" status
summary	Show a summary of the status of al nodes

4.4.4 Normal Response Format

4.4.5 Response Parameters

name	The name of the node or configuration file where the source of the alarm resides
slot	If applicable, the slot in the node where the source of the error resides
alarm point	Alarm source
status	Alarm status. Possible values include: alarm—The specified alarm point is in alarm. la (low alarm)—The CLIP module recorded an event that exceeded the lower alarm threshold for the alarm point parameter. lw (low warning)—The CLIP module recorded an event that exceeded the lower warning threshold for the alarm point parameter. no_file—The file specified as the alarm point is not available. ha (high alarm)—The CLIP module recorded an event that exceeded the higher alarm threshold for the alarm point parameter. hw (high warning)—The CLIP module recorded an event that exceeded the higher warning threshold for the alarm point parameter.

4.4.6 Normal Response Example

See the "Normal Response Format" section.

4.5 Show Alias

COMMAND CODE:	show alias
MESSAGE CATEGORY:	All Categories
TYPE:	Generic
PROTOCOL:	TCP/IP

4.5.1 Purpose

The show alias command displays the assigned aliases for every element in the system.

4.5.2 Input Format

show alias

4.5.3 Normal Response Format

NCB:>show alias
--------+--------------------------------+-------------------
type    | name                           | alias
--------+--------------------------------+-------------------
mcu     | mcu_1_1                        | mcu_1_1
--------+--------------------------------+-------------------
scu     | scu_2_215                      | scu_2_215
scu     | scu_2_341                      | scu_2_341
--------+--------------------------------+--------------------
clip    | clip_340                       | clip_340
clip    | clip_208                       | clip_208
clip    | clip_215                       | clip_215
clip    | clip_341                       | clip_341
--------+--------------------------------+--------------------
path    | path_208_215                   | path_208_215
path    | path_340_341                   | path_340_341
--------+--------------------------------+-------------------

4.5.4 Response Parameters

type

Unit type. Unit types are:

mcu—Multi-channel unit
scu—Single channel unit
clip—Client Layer Interface Port (CLIP) module not associated with an MCU or SCU
path-Logical connection between two CLIP modules

name

Name of the element

alias

Pseudonym assigned to the named element

4.5.5 Normal Response Example

See the "Normal Response Format" section.

4.6 Show Discrepancy

COMMAND CODE:	show discrepancy
MESSAGE CATEGORY:	All Categories
TYPE:	Generic
PROTOCOL:	TCP/IP

4.6.1 Purpose

The show discrepancy command displays discrepancies between the intended system configuration, found in the network.cfg file, and the actual configuration.

4.6.2 Input Format

show discrepancy

4.6.3 Input Parameters

None.

4.6.4 Normal Response Format

The normal response format is a text list.

4.6.5 Error Response Format

-- No configuration file found --

4.6.6 Normal Response Example

NCB:>show discrepancy

clip.clip_301.dcnaddress: Integer is '64', should be '40'.

clip.clip_301.state: Enum is 'online', should be 'offline'.

4.7 Show Inventory

COMMAND CODE:	show inventory
MESSAGE CATEGORY:	All Categories
TYPE:	Generic
PROTOCOL:	TCP/IP

4.7.1 Purpose

The show inventory command presents a list of all network equipment in the system. It also displays inventory-related information about the equipment.

4.7.2 Input Format

show inventory

4.7.3 Normal Response Format

4.7.4 Response Parameters

type	Unit type. Unit types are: mcu - Multichannel unit scu - Single channel unit clip—Client Layer Interface Port (CLIP) module not associated with an MCU or SCU
name	Name of the unit
slot	Physical location of the unit in the subrack
itu	International Telecommunications Union (ITU) channel number (i.e. wavelength)
element type	Type of module
(name)	Name of the module

4.7.5 Normal Response Example

See the "Normal Response Format" section.

4.8 Show Management

COMMAND CODE:	show management
MESSAGE CATEGORY:	All Categories
TYPE:	Generic
PROTOCOL:	TCP/IP

4.8.1 Purpose

The show management command displays the current properties of the simple network management protocol (SNMP) interface.

4.8.2 Input Format

show management

4.8.3 Normal Response Format

NCB:>show management

------------------ SNMP Properties --------------------------
Description: ONS 15200

Contact:     <name>

Location: <address>

SNMP agent:  SNMP Research SNMP Agent Resident Module Version 15.2.1.10
---------------------+----------------------+-----------------------

trap                      | community           |   ip-address

---------------------+----------------------+-----------------------

<trap>                  | <community>      |   <ip-address>

---------------------+----------------------+-----------------------
---------------------+----------------------

community          | name

---------------------+----------------------

<community>      | <community name>

---------------------+----------------------

4.8.4 Response Parameters

name	Name of contact person
address	Address or other contact information
trap	List of traps
community	List of communities
ip-address	List of IP addresses
community name	List of community names

4.8.5 Normal Response Example

---------------------+----------------------+-----------------------

trap                      | community           |  ip-address

---------------------+----------------------+-----------------------

ala                        | public                   |  10.52.18.29

---------------------+----------------------+-----------------------
---------------------+----------------------

community          | name

---------------------+----------------------

public                   | public

---------------------+----------------------

4.9 Show Path

COMMAND CODE:	show path
MESSAGE CATEGORY:	All Categories
TYPE:	Generic
PROTOCOL:	TCP/IP

name	Name of the path or logical connection
status	The status of the unit. Possible values are: Normal: Unit is functioning normally Warning: A unit alarm is imminent Major: A major alarm has occurred
itu	International Telecommunications Union (ITU) channel number (i.e. wavelength)
element 1	The CLIP at the first end of the path
element 2	The CLIP at the second end of the path

4.9.7 Normal Response Example

See the "Normal Response Format" section.

4.10 Show Power

COMMAND CODE:	show power
MESSAGE CATEGORY:	All Categories
TYPE:	Generic
PROTOCOL:	TCP/IP

name	Name of the unit
itu	International Telecommunications Union (ITU) channel number (i.e. wavelength)
slot	The position within the rack; '-' means not applicable
dwdm A, B	The optical input power on receivers A and B, respectively
client	The optical input power on the client-side receiver

4.10.7 Normal Response Example

See the "Normal Response Format" section above.

4.11 whoami

COMMAND CODE:	whoami
MESSAGE CATEGORY:	All Categories
TYPE:	Generic
PROTOCOL:	TCP/IP

user name	The logon name of the user
user access level	The privilege level of the user

4.11.7 Normal Response Example

NCB:>whoami

opuser3             operator

Table of Contents

Commands