cc/td/doc/product/ong/15200/15200cli
hometocprevnextglossaryfeedbacksearchhelp
PDF

Table of Contents

General Commands

General Commands

This chapter provides detailed descriptions of the ONS 15200 Command Line Interface (CLI) general commands available through a telnet session that are supported by ONS 15200 system network elements (NEs).

Commands are sent asynchronously during active sessions. To issue ONS 15200 CLI commands, you must be connected to a Network Control Board (NCB) module in an ONS 15252 and have adequate permission.

4.1 Cd

Command

Cd

Syntax

cd
cd
<path>
cd ..

Privilege Level

operator, guest

You can use the cd (change directory) command to change the current focus of the CLI. The following cd commands are available:

You must be in one of the following modes to execute this command:

4.1.1 Input Parameters

"<path>" is a ".." or <space> separated list of tree nodes relative to the current path. Two "." characters are used to go up one level relative to the current location.

4.1.2 Normal Response


Example 4-1: Cd Command Response clip_301:#cd [clip_301] dwdm.arxpower clip_301:# -------------------------------------- clip_301:#cd .. [clip_301] dwdm clip_301:# -------------------------------------- clip_301:#cd brxpower [clip_301] dwdm.brxpower clip_301:#

4.1.3 Error Response

-- Path not found --

4.1.4 Response Parameters

None.

4.2 Commit

Command

Commit

Syntax

commit <object type> [<name>]

Privilege Level

All commit commands except commit user must be performed by a user with operator privileges. Commit user must be performed by a user with administrator privileges.

The commit command stores the current properties of an object in non-volatile memory in the system. A committed object is automatically restored after the NCB is rebooted. Operators can commit SNMP (management) properties from the initial logon level. Other entities can be committed from the following levels:

Table 4-1 shows committable objects types and the corresponding level at which they can be committed.


Table 4-1: Committable Object Types
Object Type Level

community

configure management

clip

configure clip

management

initial login (NCB:> prompt)

mcu

configure network

network

configure network

path

configure network

scu

configure network

snm

configure network

sntp

configure system; administrators only

trap

configure management

user

initial login (NCB:> prompt); administrators only

4.2.1 Input Parameters


Table 4-2: Commit Command Input Parameters
Parameter Description

<name>

The name of the individual object.

<object type>

Object types include user, clip, and management.

4.2.2 Normal Response

A normal response to the commit command is a blank command line.


Example 4-2: Commit User Response NCB:>commit user myuser NCB:>

4.2.3 Error Response

-- Unknown 'object type' 'object name' --

4.2.4 Response Parameters

None.

4.3 Configure Clip

Command

Configure Clip

Syntax

configure clip <object name>

Privilege Level

operator

Related commands

configure network

The configure clip command modifies the parameters of a CLIP module, which connects the client signal to the DWDM system. Most parameters are set when the CLIP is manufactured, and are therefore read-only. See "Configurable Parameters," for information about configurable CLIP parameters.


Note   You must be in Network Configuration mode or initial login mode to execute this command.

This command enables the following set of commands:

See the individual descriptions of these commands for more information.

4.3.1 Input Parameters


Table 4-3: Configure Clip Command Input Parameters
Parameter Description

<object name>

The name of the CLIP you want to configure.

4.3.2 Normal Response

Network:#configure clip <object name>
<Object name>:#

Example 4-3: Commit Command Response Network:#configure clip clip_340 Configure 'clip_340'
clip_340:#

4.3.3 Error Response

-- Path not found --

4.3.4 Response Parameters

This parameter is identical to the input parameter.

4.4 Configure Community

Command

Configure Community

Syntax

configure community <community name>

Privilege Level

operator

Related Command(s)

configure management, show management

The configure community command modifies the properties of an SNMP community. An SNMP community enables an SNMP manager to access the SNMP interface of an SNM by referring to a valid community name.

This command sets the focus of the CLI to the community you want to configure and enables the following subset of commands:

See the individual descriptions of these commands for more information.


Note   You must be in Management Configuration mode to execute this command.

4.4.1 Input Parameters


Table 4-4: Configure Community Command Input Parameters
Parameter Description

<community name>

The name of the community you want to configure.

4.4.2 Normal Response

Mgmt:#configure community <community name>
Configure '<community name>'
<community name>:#

Example 4-4: Configure Community Command Response Mgmt:#configure community stockholm Configure 'stockholm' stockholm:#l v stockholm: name stockholm:#name sweden stockholm:#l v stockholm: name                    sweden stockholm:#

4.4.3 Error Response

-- Path not found --

4.4.4 Response Parameters

This parameter is identical to the input parameter.

4.5 Configure Management

Command

Configure Management

Syntax

configure management

Privilege Level

operator

The configure management command allows you to access commands that you can use to configure the properties of the SNMP management interface. This command changes the focus to the element to configure and enables the following new set of commands:

See the individual descriptions of these commands for syntax and details.

4.5.1 Input Parameters

None.

4.5.2 Normal Response

NCB:#configure management
Configure management
Mgmt:#

4.5.3 Error Response

-- Path not found --

4.5.4 Response Parameters

None.

4.6 Configure MCU

Command

Configure MCU

Syntax

configure mcu <object name>

Privilege Level

operator

Related Command(s)

configure network

The configure mcu command modifies the properties of a multichannel unit (MCU) logical representation. The MCU has a number of slots that may contain CLIP or SNM objects. You can use the configure mcu command to set up the expected properties of the MCU.

The configure mcu command changes the CLI focus to the element to configure and enables the following new set of commands:

See the individual descriptions of these commands for syntax and details. Refer to the Cisco ONS 15200 Installation, Setup, and Test Manual for the procedure for configuring an MCU using the configure mcu command.


Note   You must be in Network Configuration mode to execute this command.

4.6.1 Input Parameters


Table 4-5: Configure MCU Command Parameters
Parameter Description

<object name>

The name of the object you want to configure.

4.6.2 Normal Response

Mgmt:#configure mcu <object name>
Configure '<object name>'
<object name>:#

Example 4-5: Configure MCU Command Response Network:#configure mcu osmo Configure 'osmo' osmo:#l v mcu_3_6: status critical neid 6 name osmo rack 3 alarmlocation 1,2,3,4,5 slot1 osmo_12475 slot2 clip_12477 slot3 clip_20529 slot4 clip_20522 slot5 clip_20497 slot6 slot7 slot8 slot9 slot10 slot11 slot12 slot13 slot14 slot15 slot16 slot17 snm_osmo osmo:#

4.6.3 Error Response

-- Path not found --

4.6.4 Response Parameters

None.

4.7 Configure Network

Command

Configure Network

Syntax

configure network

Privilege Level

operator

The configure network command allows you to access commands that you can use to configure the network. In network configuration mode, you can perform tasks such as creating, configuring, displaying, and deleting different network objects.

The configure network command enables the following subset of commands:

See the individual descriptions of these commands for syntax and details.

4.7.1 Input Parameters

None.

4.7.2 Normal Response

NCB:#configure network
Network:#

4.7.3 Error Response

-- Path not found --

4.7.4 Response Parameters

None.

4.8 Configure Path

Command

Configure Path

Syntax

configure path <name>

Privilege Level

operator

Related Command(s)

configure network

The configure path command allows you to modify the properties of a path. The configure path command changes the CLI focus to the configurable element and enables the following subset of commands:

See the individual descriptions of these commands for syntax and details. .


Note   You must be in Network Configuration mode to execute this command.

4.8.1 Input Parameters


Table 4-6: Configure Path Command Parameters
Parameter Description

<name>

The name of the path you want to configure.

4.8.2 Normal Response

Mgmt:#configure path <name>
Configure '<name>'
<name>:#

Example 4-6: Configure Path Command Response Network:#configure path path_18658_20535 Configure 'path_18658_20535' path_18658_20535:#l v path_18658_20535: status minor datarate          STM-16/OC-48 unit1             clip_18658 unit2             clip_20535 path_18658_20535:#

4.8.3 Error Response

-- Path not found --

4.8.4 Response Parameters

None.

4.9 Configure SCU

Command

Configure SCU

Syntax

configure scu <object name>

Privilege Level

operator

The configure scu command allows you to modify the properties of a Single-Channel unit (SCU). The SCU has one slot that can contain a CLIP module.

The configure scu command changes theCLI focus to the configurable element and enables the following subset of commands:

See the individual descriptions of these commands for syntax and details. Refer to the Cisco ONS 15200 Installation, Setup, and Test Manual to configure an SCU using the configure scu command.


Note   You must be in Network Configuration mode to execute this command.

4.9.1 Input Parameters


Table 4-7: Configure SCU Command Parameters
Parameter Description

<object name>

The name of the object you want to configure.

4.9.2 Normal Response

Mgmt:#configure scu <object name>
Configure '<object name>'
<object name>:#

Example 4-7: Configure SCU Command Response Network:#configure scu hagersten Configure 'hagersten' hagersten:#l v scu_3005: status normal neid 34 slot               clip_309 hagersten:#

4.9.3 Error Response

-- Path not found --

4.9.4 Response Parameters

None.

4.10 Configure SNM

Command

Configure SNM

Syntax

configure snm <object name>

Privilege Level

operator

The configure snm command allows you to modify the properties of a Sub-Network Manager (SNM). An SNM manages all elements in its database, such as MCUs and SCUs. From the configure snm command you can differentiate two NCBs on a Control Access Network (CAN) bus by configuring the SNM's unitid parameter as snm_1 or snm_2.

The configure snm command changes the CLI focus to the configurable element and enables the following subset of commands:

See the individual descriptions of these commands for syntax and details. Refer to the Cisco ONS 15200 Installation, Setup, and Test Manual to configure an SNM using the configure snm command.


Note   You must be in Network Configuration mode or initial login mode to execute this command.

4.10.1 Input Parameters


Table 4-8: Configure SNM Command Parameters
Parameter Description

<object name>

The name of the SNM you want to configure.

4.10.2 Normal Response

Network:#conf snm snm_xxx Configure 'snm_xxx' snm_xxx:#
Example 4-8: Configure SNM Command Response Network:#conf snm snm_12316 Configure 'snm_12316' snm_12316:#list value snm_12316: dcnaddress 0xf80 unitid snm_1 label NCB-RPX-REV-3A position <uninitialised> neid 12316 inventory <node> network <node> snm_12316:#

4.10.3 Error Response

-- Path not found --

4.10.4 Response Parameters

None.

4.11 Configure System

Command

Configure System

Syntax

configure system

Privilege Level

administrator, operator

The configure system command accesses the system configuration mode. In system configuration mode, you can perform tasks such as defragmenting the file system, setting page lengths, executing command files, and other similar system functions. Table 4-9 lists and describes the commands available under the configure system command.


Table 4-9: Configure System Commands
Command Description User Levels

defrag <dev>

Defrag the file system

administrator, operator

dnsconf [<hostname> <domain> <server1> [<server2>]]

Get/set DNS server(s)

administrator

exit

Exit the system mode

administrator, operator

format <dev>

Format the file system

administrator

fschk <dev>

Check the file system

administrator, operator

ftp

Enter FTP session

administrator

host <ipaddr|hostname>

IP address to name, name to IP address

administrator, operator

ipconf [<ipaddr><mask><gateway>]

Get/set the IP address

administrator

ipfilt add|list|remove|set|commit

Update the IP filter

administrator

sntp server|timezone|freq|commit|dlst_on|dlst_off

Update SNTP server

administrator

ldboot [<dev> <filename> <count>]

View/load/unload boot

administrator, operator

list <dev>

List files

administrator, operator

macaddr

Retrieve the system MAC address

administrator, operator

page [<len>]

Get/set page length

administrator, operator

password

Set new password

administrator, operator

reboot

Reboot the system

administrator, operator

remove <dev> <filename>

Remove files

administrator

source <dev> <filename>

Execute a command file

administrator, operator

syslog

Display the system log

administrator, operator

time [<yyyy:mm:dd> <hh:mm:ss>]

Get/set system time

administrator, operator

type <dev><filename>

Types (prints) the file on the display

administrator

version

Display the software and hardware version

administrator, operator

whoami

List the current user

administrator, operator

See the individual descriptions of these commands for syntax and details.

4.11.1 Normal Response Format

NCB:>configure system NCB:=
Example 4-9: Configure System Response (Operator) NCB:>configure system NCB:=? defrag <dev> exit format <dev> fschk <dev> ipconf [<ipaddr><mask><gateway>] ipfilt add|list|remove|set|commit| ldboot [<dev> <filename> <count>] list <dev> macaddr page [<len>] password reboot remove <dev><filename> source <filename> syslog time [<yyyy:mm:dd><hh:mm:ss>] version whoami NCB:=
Example 4-10: Configure System Response (Administrator) NCB:>configure system NCB:=? defrag <dev> : Defrag file system dnsconf [<hostname> <domain> <server1> [<server2>]]: Get/Set dns server(s) exit : Exit system mode format <dev> : Format file system fschk <dev> : Check file system ftp : Enter FTP session host <ipaddr|hostname> : IP addr to name, name to ip addr ipconf [<ipaddr> <mask> <gateway>]: Get/Set ip address ipfilt add|list|remove|set|commit: Update ip filter sntp server|timezone|freq|commit|dlst_on|dlst_off: Update SNTP server ldboot [<dev> <filename> <count>]: View/Load/Unload boot list <dev> : List files macaddr : System MAC address page [<len>] : Set page length password : Set new password reboot : System reboot remove <dev> <filename> : Remove files source <dev> <filename> : Execute a command file syslog : Display system log time [<yyyy:mm:dd> <hh:mm:ss>]: Get/Set system time type <dev> <filename> : Print file version : Display sw and hw version whoami : Current user NCB:=

4.11.2 Error Response Format

-- Not enough access -- -- Path not found -- -- Insufficient size --

4.11.3 Response Parameters

None.

4.12 Configure Trap

Command

Configure Trap

Syntax

configure trap <trap name>

Privilege Level

operator

Related Command(s)

configure management, show management

The configure trap command modifies the properties of an SNMP trap. An SNMP trap enables an SNMP manager to access the SNMP interface of an SNM by referring to a valid community name.

This command sets the CLI focus to the trap you want to configure and enables the following subset of commands:

See the individual descriptions of these commands for more information.


Note   You must be in Management Configuration mode to execute this command.

4.12.1 Input Parameters

"<trap name>" represents the name of the trap you want to configure.

4.12.2 Normal Response

Mgmt:#configure trap <trap name>
Configure '<trap name>'
<trap name>:#

Example 4-11: Configure Trap Command Response Mgmt:#con trap lassep Configure 'lassep' lassep:# lassep:#l v lassep: ipaddress community lassep:#

4.12.3 Error Response

-- Path not found --

4.12.4 Response Parameters

"<trap name>" represents the name of the trap you want to configure.

4.13 Configure User

Command

Configure User

Syntax

configure user <user name>

Privilege Level

administrator

The configure user command modifies the properties of a user.

This command sets theCLI focus to the user you want to configure and enables the following subset of commands:

See the individual descriptions of these commands for more information. See "Configurable Parameters," for information on configurable user parameters.

4.13.1 Input Parameters

"<user name>" represents the name of the user you want to configure.

4.13.2 Normal Response Format

NCB:>configure '<user name>' Configure '<user name>' <user name>:#
Example 4-12: Configure User Command Response NCB:>configure user testguest Configure 'testguest' testguest:#? cd [<path>] : Change current path commit : Commit current object exit : Exit configuration mode list parameter|recursive|value upload [<path>] : Synchronise object whoami : Current user dummy1:#l v dummy1: password *** privileges guest state offline timeout 30 logintime 00:00 dummy1:#

4.13.3 Error Response Format

-- Not enough access -- -- Wrong number of arguments [configure user <user name>] -- -- Missing argument -- -- Unexpected reply code <error code> --

4.13.4 Response Parameters


Table 4-10: Configure User Command Response Parameters
Parameter Description

<user name>

The name of the user to be configured.

<error code>

Number assigned to the error code. This number should be reported to Cisco personnel.

4.14 Create Community/Trap

Command

Create Community
Create Trap

Syntax

create community <community name>
create trap <trap name>

Privilege Level

administrator

Related command(s)

configure management

The create community and create trap commands add a new SNMP community or trap. The new community or trap assumes default values for all parameters. See the "Configure Community" section and the "Configure Trap" section for more information about communities and traps.

These commands enables the following subset of commands:

See the individual descriptions of these commands for more information.


Note   You must be in Management Configuration mode or initial login mode to execute this command.

4.14.1 Input Parameters


Table 4-11: Create Community/Trap Command Parameters
Parameter Description

<community name>

The name of the community you want to create.

<trap name>

The name of the trap you want to create.

4.14.2 Normal Response Format

NCB:>create community <community name> Created '<community name>' <community name>:# ---------------------------------------- NCB:>create trap <trap name> Created '<trap name>' <trap name>:#
Example 4-13: Create Community/Trap Command Response NCB:>create community stockholm Created 'stockholm' stockholm:# ---------------------------------------- NCB:>create trap trap12 Created 'trap12' trap12:#

4.14.3 Error Response Format

-- Not enough access -- -- Path not found -- -- Insufficient size --

4.14.4 Response Parameters

None.

4.15 Create MCU/SCU

Command

Create MCU
Create SCU

Syntax

create mcu <neid><rack>
create scu <neid>

Privilege Level

operator

Related command(s)

configure network, list mcu, list scu

The create mcu and create scu commands add a new MCU or SCU. The new MCU or SCU assumes default values for all parameters. See the "Configure MCU" section and the "Configure Path" section for more information about MCU and SCU parameters.

These command enables the following subset of commands:

See the individual descriptions of these commands for more information. Refer to the Cisco ONS 15200 Installation, Setup, and Test Manual to create an MCU or SCU using the create mcu and create scu commands.


Note   You must be in Network Configuration mode to execute these commands.

4.15.1 Input Parameters


Table 4-12: Create MCU/SCU Command Parameters
Parameter Description

<neid>

The network element ID.

<rack>

The backplane jumper settings of the MCU.

4.15.2 Normal Response Format

NCB:>create mcu <neid><rack> Created 'mcu_<rack>_<neid>' mcu_<rack>_<neid>:# ---------------------------------------- NCB:>create scu <neid> Created 'scu_<neid>' scu_<neid>:#
Example 4-14: Create MCU/SCU Command Response NCB:>create mcu 100 2 Created 'mcu_2_100' mcu_2_100:# ---------------------------------------- NCB:>create scu 123 Created 'scu_123' scu_123:#

4.15.3 Error Response Format

-- Path not found -- -- Insufficient size -- -- Missing argument --

4.15.4 Response Parameters


Table 4-13: Create MCU/SCU Command Parameters
Parameter Description

<neid>

The network element ID.

<rack>

The backplane jumper settings of the MCU.

4.16 Create Trap

See the "Create Community/Trap" section for information on the create trap command.

4.17 Create User

Command

Create User

Syntax

create user <user name>

Privilege Level

administrator

Related command(s)

commit, password, configure user

The create user command adds a new system user. Each user has a set of parameters. See "Configurable Parameters" for a description of the user parameters.

After you create a user, specify the password and privilege level of that user. For example, to set the password, from the <user name> prompt, type password <firstpassword>, where <firstpassword> is the password you want to set for that user. The user should change his or her password at the first login.

See the "Creating a New User" section to create and set parameters for a new user. See the "Configure User" section for more information.

This command enables the following subset of commands:

See the individual descriptions of these commands for more information.

4.17.1 Input Parameters

"<user name>" represents the name designated by the administrator for the new user. The user name can be set to any string that contains a minimum of 6 characters and a maximum of 30 characters. Valid characters are a through z, 0 through 9, A through Z, and the _ (underscore) character.


Note   The user name cannot begin with a numeral.

4.17.2 Normal Response Format

NCB:>create user <user name> Created '<user name>' <user name>:#
Example 4-15: Create User Command Response NCB:>create user barkero barkero:#l v barkero: password           **** privileges         guest state              offline timeout 30 barkero:#password ciscopass barkero:#privileges operator barkero:#l v barkero: password           **** privileges         operator state              offline timeout            30 logintime          - barkero:#

4.17.3 Error Response Format

-- Not enough access -- -- Path not found -- -- Insufficient size -- -- Wrong number of arguments [create user <name>] -- -- Missing argument -- -- Could not create 'name' -- -- User name 'name' too short; minimum 6 characters -- -- User name 'name' too long; maximum 30 characters -- -- Item named 'name' already exists -- -- Name 'name' does not follow naming convention -- -- Unexpected reply code <error code> --

4.17.4 Response Parameters

See

4.18 Defrag

Command

Defrag

Syntax

defrag <device>

Privilege Level

administrator, operator

Related command(s)

commit, password

The defrag command removes files from the file system on the NCB module. When you delete a file , it is marked for deletion but it is not removed until you run the defrag command or reboot the NCB.


Note   You must be in System Configuration mode to execute this command.

This command can take up to 30 seconds to complete.

4.18.1 Input Parameters

"<device>" is the equipment you want to defragment. Currently only Device 0 is supported.

4.18.2 Normal Response Format

NCB:=defrag 0 Defragmentation in progress... NCB:=

4.18.3 Error Response Format

None.

4.18.4 Response Parameters

None.

4.19 Delete

Command

Delete

Syntax

delete community <community name>
delete mcu <mcu name>
delete scu <scu name>
delete trap <trap name>
delete user <user name>

Privilege Level

administrator (delete user only); operator for all others

The delete command is used to remove the following objects from the system database:

4.19.1 Input Parameters


Table 4-14: Delete Input Command Parameters
Parameter Description

<community name>

The name of the community you want to delete.

<mcu name>

The name of the MCU you want to delete.

<scu name>

The name of the SCU you want to delete.

<trap name>

The name of the trap you want to delete.

<user name>

The name of the user you want to delete.

4.19.2 Normal Response Format

Mgmt:>delete community <community name> Deleted '<community name>' Mgmt:> ----------------------------------------- Mgmt:>delete trap <trap name> Deleted '<trap name>' Mgmt:> ----------------------------------------- NCB:>delete user <user name> Deleted '<user name>' NCB:>
Example 4-16: Delete Command Response Mgmt:>delete community stkcommunity Deleted 'community2' Mgmt:# --------------------------------------- Mgmt:>delete trap rcdntrap Deleted 'rcdntrap' Mgmt:# --------------------------------------- NCB:>delete user barkero Deleted 'barkero' NCB:>

4.19.3 Error Response Format

-- Not enough access -- -- Path not found -- -- Wrong number of arguments [delete community <name>] -- -- Wrong number of arguments [delete trap <name>] -- -- Wrong number of arguments [delete user <name>] -- -- Missing argument -- -- Unexpected reply code <error code> --

4.19.4 Response Parameters


Table 4-15: Delete Response Command Parameters
Parameter Description

<user name>

The name of the user to be deleted.

<error code>

Number assigned to the error code. This number should be reported to Cisco personnel.

4.20 Display

Command

Display

Syntax

display <object type> <name>

Privilege Level

guest user, operator

Related Command(s)

configure clip, configure SNM

The display command is similar to the configure command, but instead of granting read-write privileges, it grants read-only access to the parameters of the selected object, such as a CLIP module or SNM. The command automatically sets the CLI focus to the object. Use the exit command to exit this mode.

See the "Configure Clip" section and the "Configure SNM" section for more information.


Note   To display user properties using the display user command, you must be logged in as an administrator. See the "Display User" section for more information.

4.20.1 Input Parameters


Table 4-16: Display Command Response Command Parameters
Parameter Description

<object type>

The type of object to display, such as clip, snm, community, trap, and user.

<name>

The name assigned to the object that you want to display.

4.20.2 Normal Response Format

NCB:>display <object type><name> Display '<name>' <name>:
Example 4-17: Display Command Response NCB:>display clip clip_341 Display 'clip_341' clip_341:>list value clip_341: dcnaddress 0x1944 uploaded yes neid 20537 name clip_20537 status critical primary none secondary this mm none unittype clip unitappl 6 serno CEM05430279 position rack(1)_slot(4) container <node> itu 47 protection yes datarate STM-16/OC-48 pm off inuse yes client <node> dwdm <node> board <node> inventory <node> dcn <node> misc <node> clip_20537:>

4.20.3 Error Response Format

-- Not enough access -- -- Path not found -- -- Insufficient size -- -- Wrong number of arguments [%s %s <name>] -- -- Missing argument -- -- Unexpected reply code (<error code>) --

4.20.4 Response Parameters


Table 4-17: Display Command Response Command Parameters
Parameter Description

<object name>

The name assigned to the selected element

<error code>

Number assigned to the error code. This number should be reported to Cisco personnel.

4.21 Display User

Command

Display User

Syntax

display user <user name>

Privilege Level

administrator

The display user command lists user properties.

4.21.1 Input Parameters

"<user name>" is the name of the user that you want to display.

4.21.2 Normal Response Format

NCB:>display user <user name> Display '<user name>' <user name>:>
Example 4-18: Display User Response NCB:>display user sdsguest Display 'sdsguest' sdsguest:>

4.21.3 Error Response Format

-- Not enough access -- -- Insufficient size -- -- Wrong number of arguments [display user <name>] -- -- Missing argument -- -- Unexpected reply code <error code> --

4.21.4 Response Parameters


Table 4-18: Display User Command Response Parameters
Parameter Description

<user name>

The name of the user

<error code>

Number assigned to the error code. This number should be reported to Cisco personnel.

4.22 DNSconf

Command

DNSconf

Syntax

dnsconf [<hostname> <domain> <dns server X> [<dns server Y>]]

Privilege Level

administrator

The dnsconf command configures the NCB module's Domain Name System (DNS) client, which provides access to a DNS server database. After the DNS client is configured, you can use domain names instead of IP addresses.


Note   You must be in System Configuration mode to perform this command.

4.22.1 Input Parameters


Table 4-19: DNSconf Command Input Parameters
Parameter Description

<hostname>

The host name assigned to the NCB module.

<domain>

The default domain used by the NCB module.

<dns server 1>

The IP address of the domain name server.

<dns server 2>

The IP address of the second domain name server (optional).

4.22.2 Normal Response Format


Example 4-19: DNSconf Command Response NCB:=dnsconf ncb .cisco.com 144.254.74.7 144.254.71.184 DNS configured, please reboot NCB:= ------------------------------------------------------------------ NCB:=dnsconf Hostname: ncb Domain: .cisco.com Server1: 144.254.74.7 Server2: 144.254.71.184 NCB:=

4.22.3 Error Response Format

-- Not enough access -- -- Path not found -- -- Wrong number of arguments [delete community <name>] -- -- Wrong number of arguments [delete trap <name>] -- -- Wrong number of arguments [delete user <name>] -- -- Missing argument -- -- Unexpected reply code <error code> --

4.22.4 Response Parameters

None.

4.23 Exit

Command

Exit

Syntax

exit

Privilege Level

administrator, operator, guest user

The exit command closes the current ONS 15200 Command Line Interface mode and opens the level above. When you issue this command at the NCB:> prompt, the telnet session is terminated.

4.23.1 Input Parameters

None.

4.23.2 Normal Response Format


Example 4-20: Exit Command Response barkero:>exit NCB:> ----------------------------------------- NCB:=exit NCB:>

4.23.3 Error Response Format

None.

4.23.4 Response Parameters

None.

4.24 Format

Command

Format

Syntax

format <device>

Privilege Level

administrator

The format command reformats the specified device and erases all files on that device.


Note   You must be in System Configuration mode to execute this command.

4.24.1 Input Parameters

"<device>" is the equipment you want to format. Currently only Device 0 is supported.

4.24.2 Normal Response Format


Example 4-21: Format Command Response NCB:=format 0 Formatting in progress... NCB:=

4.24.3 Error Response Format

-- Error, no such device -- -- Wrong number of arguments [format <dev>] --

4.24.4 Response Parameters

"<dev>" is the device you wanted to format.

4.25 Fschk

Command

Fschk

Syntax

fschk <device>

Privilege Level

administrator, operator

The fschk command displays information, contents, and the status of the specified device of the file system.


Note   You must be in System Configuration mode to execute this command.

4.25.1 Input Parameters

"<device>" is the number of the file system device you want to check. Currently only Device 0 is supported.

4.25.2 Normal Response Format


Example 4-22: Fschk Command Response NCB:=fschk 0 Number of files: 5 Number of deleted files: 0 1147467 bytes used 949681 bytes left NCB:=

4.25.3 Error Response Format

-- Error, no such device -- -- Missing argument [fschk <dev>] --

4.25.4 Response Parameters

None.

4.26 FTP

Command

FTP

Syntax

ftp

Privilege Level

administrator

Related Command(s)

configure system

The ftp command initiates the File Transfer Protocol (FTP) client mode. See "FTP Commands" for more information about FTP.


Note   You must be in System Configuration mode to execute this command.

4.26.1 Input Parameters

None.

4.26.2 Normal Response Format


Example 4-23: Ftp Command Response NCB:=ftp ftp:>? open <ipaddr> : Open a FTP connection close : Close current FTP connection user <name> : Send user name cd <path> : Change working directory pwd : Print current working directory ls <path> : List file(s) ascii : Set ASCII transfer type binary : Set binary transfer type syst : Get server system get <file> : Retrieve a file from server put <file> : Send a file to the server passive : Toggle passive mode (on/off) status : Show the current status of the FTP connection quit : Terminate FTP session exit : Exit FTP mode ftp:>

4.26.3 Error Response Format

None.

4.26.4 Response Parameters

None.

4.27 Inhibit/No Inhibit

Command

Inhibit/No Inhibit)

Syntax

inhibit [<path>]
no inhibit [<path>]

Privilege Level

operator

Related Command(s)

suppress, no suppress

The inhibit command disables an alarm point on a CLIP module so that the CLIP alarm point will not detect alarms on any Subnetwork Managers (SNMs) in the network. The no inhibit command reverses the inhibit command and allows the alarm point to detect alarms. An inhibited alarm point will report the status "inhibited." A suppressed alarm cannot be inhibited unless you issue a no suppress command.


Note   You must be in CLIP Configuration mode to perform these commands.

4.27.1 Input Parameters

"<path>" is a ".." or <space> separated list of tree nodes relative to the current path.

4.27.2 Normal Response Format


Example 4-24: Inhibit Command Response NCB:=dwdm arxpower status highwarning NCB:=inhibit dwdm arxpower NCB:=dwdm arxpower status inhibited NCB:=no inhibit dwdm arxpower NCB:=dwdm arxpower status highwarning NCB:=

4.27.3 Error Response Format

-- Not an inhibitable alarm point -- -- Unable to inhibit/un-inhibit--

4.27.4 Response Parameters

None.

4.28 Insert

Command

Insert

Syntax

insert <clip name>|<snm name>

Privilege Level

operator

Related Command(s)

remove

The insert command inserts an object, such as a CLIP or an SNM, in a container, such as an MCU or SCU. This command is used to associate an object with its container. Refer to the Cisco ONS 15200 Module Handbook for the procedure used to replace a unit using the insert command.

4.28.1 Input Parameters


Table 4-20: Insert Command Input Parameters
Parameter Description

<clip name>

The name assigned to the CLIP module you want to insert.

<snm name>

The name assigned to the SNM you want to insert.

4.28.2 Normal Response Format


Example 4-25: Insert Command Response mcu_1_45:#insert clip_309 mcu_1_45:# ----------------------------------------- mcu_1_45:#insert snm_234 mcu_1_45:#

4.28.3 Error Response Format

-- Unable to determine position in container -- -- Slot '<slot>' is already occupied -- -- Slot is already occupied -- -- Wrong number of arguments [insert <name>] -- -- Unexpected reply code ('<error code>') --

4.28.4 Response Parameters


Table 4-21: Insert Command Response Parameters
Parameter Description

<rack id>

The backplane jumper. Possible values are 1 through 4.

<slot>

The position within the MCU.

<error code>

An internal error code. Report this code to Cisco personnel.

4.29 Ipconf

Command

Ipconf

Syntax

ipconf [<ip address> <subnet mask> <default gateway>]

Privilege Level

administrator

Related Command(s)

configure system

The ipconf command sets or modifies the IP properties of the Subnetwork Manager (SNM). This command assigns an IP address, a subnet mask, and a default gateway to the NCB module.You can communicate with the module via the RS-232 port using the ipconf command.


Note   You must be in System Configuration mode to execute this command.

4.29.1 Input Parameters


Table 4-22: Ipconf Command Input Parameters
Parameter Description

<ip address>

The IP address of the Sub-Network Manager (SNM)

<subnet mask>

The subnetwork mask address of the SNM

<default gateway>

The default gateway address of the SNM

4.29.2 Normal Response Format


Example 4-26: Ipconf Command Response NCB:=ipconf IP address: 10.52.18.225 Subnet mask: 255.255.255.0 Default gateway: 10.52.18.1 NCB:= ------------------------------------------------------------------------- NCB:=ipconf 192.10.23.45 255.255.255.0 192.10.23.1 IP address set, please reboot... NCB:=

4.29.3 Error Response Format

-- Error, could not read IP address parameters -- -- Error, invalid IP address -- -- Error, invalid subnet mask -- -- Error, invalid default gateway --

4.29.4 Response Parameters

None.

4.30 lpfilt

Command

Ipfilt

Syntax

ipfilt add <ipaddress>
ipfilt commit
ipfilt list
ipfilt remove
<entryno>
ipfilt set <mask> <code>

Privilege Level

administrator

Related Command(s)

configure system

The ipfilt command determines which IP addresses have access to the NCB. By default the system will allow IP packages from any host to enter the system, but open access can be insecure. The system has the ability to accept only hosts or host IP addresses that match a specified mask, as well as individual addresses. There are five subcommands related to the ipfilt command:

The filtering mechanism will not allow the presence of filters (masks) that prevent the current user from accessing the system, unless access is explicitly granted by a separate IP address entry. This safeguard prevents the user from creating a filter that blocks his or her username.


Note   You must be in System Configuration mode to execute this command.

4.30.1 Input Parameters


Table 4-23: Ipfilt Command Input Parameters
Parameter Description

<ipaddress>

The Internet protocol (IP) address of the device trying to access the NCB

<entryno>

More than one individual IP address is permitted at any time. They are stored in a list. Each entry in the list has an entry number, which can be used when the entry is removed.

<mask>

The mask address of the SNM. This is a 32-bit number. If a 0 is in the mask, the corresponding bit in the <ipaddress> must match the same bit in <code>. This parameter can be entered as a hexidecimal number.

<code>

This is a 32-bit number. All bits in this parameter, where the corresponding bit in the <mask> is 0, must match the bit in the <ipaddress>. This parameter can be entered as a hexidecimal number.

4.30.2 Normal Response Format


Example 4-27: Ipfilt Command Responses NCB:=ipfilt list IP filter mask: 4294967295 IP filter code: 0 0: 10.52.18.225 1: 144.254.121.137 NCB:= --------------------------- NCB:=ipfilt remove 0 NCB:= --------------------------- NCB:=ipfilt set 4294967295 0xA3412DA NCB:= -------------------------- NCB:=ipfilt commit NCB:=

4.30.3 Error Response Format

ipfilt set

-- Error, new filter will not accept your IP address -- -- Wrong number of arguments [ipfilt set <mask> <code>] --

ipfilt add

-- Wrong number of arguments [ipfilt add <ipaddr>] --

ipfilt remove

-- Wrong number of arguments [ipfilt remove <ipaddr entryno>] -- -- Error, new filter will not accept your IP address -- -- Error, IP address number out of range --

4.30.4 Response Parameters

None.

4.31 Ldboot

Command

Ldboot

Syntax

ldboot [<drive> <filename> <tries>]

Privilege Level

administrator, operator

Related Command(s)

configure system

The ldboot command specifies which application program to start when the system is booting. After setting up the NCB module, the boot software searches for an application to run. The application is specified by the ldboot command followed by a drive number and a maximum number of tries. Currently, only drive 0 is supported. The maximum number of tries prevents a malfunctioning application from blocking the system. When the number of tries has been exceeded, the system enters boot mode again and you can replace the malfunctioning database (qdbs.cfg) and binary (snm.out) files.


Note   The recommended number of tries is 10. If both LEDs on the Communication Interface Module (CIM) are blinking, the maximum number of boot attempts has been reached.

Running the ldboot command without arguments will display the current boot record settings. Running the ldboot command with arguments will update the boot record settings.


Note   You must be in System Configuration mode to execute this command.

4.31.1 Input Parameters


Table 4-24: Ldboot Command Input Parameters
Parameter Description

<drive>

The drive where the file resides. Currently only drive 0 is supported.

<filename>

The name of the application

<tries>

Number of permitted reboot attempts. Setting <tries> to -1 disables the attempt mechanism, granting an unlimited number of boot attempts. The recommended number of tries is 10.

4.31.2 Normal Response Format


Example 4-28: Ldboot Command Response NCB:=ldboot Boot image: /0/snm.out [2] NCB:= ------- NCB:=ldboot 0 snm.out 2 NCB:=

4.31.3 Error Response Format

-- Wrong number of arguments [ldboot [<drive> <filename> <tries>]] -- -- Error, no such device --

4.31.4 Response Parameters

None.

4.32 List <dev>

Command

List

Syntax

list <dev>

Privilege Level

administrator, operator

Related Command(s)

configure system

The list command displays a list of the files in the onboard file system. The NCB module has an onboard file system that contains the application and configuration files. Currently, only device 0 is available.


Note   You must be in System Configuration mode to execute this command.

4.32.1 Input Format

list <dev>

4.32.2 Input Parameters

"<dev>" represents the drive number. Currently only Drive 0 is supported.

4.32.3 Normal Response Format


Example 4-29: List Command Response NCB:=list 0 Thu Sep 4 19:47:14 1980 2582 network.cfg Thu Sep 4 17:58:25 1980 41 sys_inet.sys Fri Mar 3 20:12:49 1972 39213 qdbs.cfg Thu Sep 4 19:30:54 1980 1104832 snm.out Tue Feb 20 18:58:42 2001 599 users.cfg NCB:=

4.32.4 Error Response Format

-- Error, no such device -- -- Wrong number of arguments [list <dev>] --

4.32.5 Response Parameters

None.

4.33 List Parameter/Value/Recursive

Command

List Parameter, List Value, List Recursive

Syntax

list parameter [<path>|..]

list value [<path>|..]

list recursive [<path>|..]

Privilege Level

administrator, operator, guest

Related Command(s)

configure system

The list command has three variations. The list parameter command lists all parameters at the current focus while the list value command also displays their current values. The value '<node>' means that the parameter is a node (very similar to a directory in a file system), and not a value. The list recursive command works like list value but will recursively scan through the sub-nodes found. It is possible to specify a relative path to display other parameters than those at the current focus.

4.33.1 Input Parameters


Table 4-25: List Parameter/Value/Recursive Command Input Parameters
Parameter Description

<path>

This is a "." or <space> separated list of tree nodes relative to the current path.

..

Two "." characters are used to specify "go up one level" relative to the current location.

.

4.33.2 Normal Response Format


Example 4-30: List Parameter/Value/Recursive Command Response clip_301:#list parameter status value hat hwt lwt lat unit pmvalue clip_301:# ------------------------ clip_301:#list value status        normal value         -18.8 dbm hat           -5.3 dbm hwt           -12.6 dbm lwt           -21.0 dbm lat           -27.5 dbm unit          dbm pmvalue       - - -20.1 -18.7 -17.8 clip_301:#

4.33.3 Error Response Format

-- Path not found --

Some additional error responses indicate an error in the parameter value:

-- <out of range> -- -- <could not convert> -- -- <general failure> --

4.33.4 Response Parameters

None.

4.34 Macaddr

Command

Macaddr

Syntax

macaddr

Privilege Level

administrator, operator

Related Command(s)

configure system

The macaddr command displays the MAC address (i.e., the Ethernet address) of the NCB module. The MAC address is set when the module is manufactured and cannot be changed.


Note   You must be in System Configuration mode to execute this command.

4.34.1 Input Parameters

None.

4.34.2 Normal Response Format


Example 4-31: Macaddr Command Response NCB:=macaddr MAC address: 00-01-64-ff-c7-03 NCB:=

4.34.3 Error Response Format

-- Error, invalid MAC address --

4.34.4 Response Parameters

None.

4.35 No Inhibit

See the "Inhibit/No Inhibit" section for information on the no inhibit command.

4.36 Open Eventlog

Command

Open Eventlog

Syntax

open eventlog

Privilege Level

operator

Related Command(s)

pmlog15, pmlog24

The open eventlog command is used to open the eventlog so that you can view its contents. This command creates a filter with parameters that the user can alter to filter out events of interest in the logs. The filter parameters include eventid, event source, starttime, and endtime. The events are stored on a file in Volume #1, which can be retrieved using FTP. This command enables the following set of commands that can be used to view the contents of the event log buffer:

See the individual commands for more information.

4.36.1 Normal Response Format

NCB:>open eventlog EventLog:#

4.36.2 Error Response Format

None.

4.36.3 Response Parameters

None.

4.37 Open Pmlog15/Pmlog24

Command

Open Pmlog

Syntax

open pmlog15
open pmlog24

Privilege Level

operator

Related Command(s)

pmlog, syslog

The open pmlog15 and open pmlog24 commands are used to open the performance monitoring log so that you can view its contents. These commands create a filter with parameters that the user can alter to filter out events of interest in the logs. The filter parameters include eventid, event source, starttime, and endtime. This command enables the following set of commands that can be used to view the contents of the pm log buffer:

See the individual commands for more information.

4.37.1 Normal Response Format

NCB:>open pmlog15 PmLog15:#

4.37.2 Error Response Format

None.

4.37.3 Response Parameters

None.

4.38 Page

Command

Page

Syntax

page <len>

Privilege Level

administrator, operator

The page command sets the maximum number of rows displayed before the user is prompted. Some command replies are extensive in length. In such cases, a limited number of rows are displayed on the screen before the user is prompted. At the prompt the user can press the Enter key to obtain one more row, or the spacebar to obtain one more page. The length of a page is specified by the page command.


Note   You must be in System Configuration mode to execute this command.

4.38.1 Input Parameters

"<len>" represents the number of rows (length) displayed before the user is prompted.

4.38.2 Normal Response Format

NCB:=page -- Current page length is xx rows -- NCB:= ------------------ NCB:=page <len> -- New page length is <len> rows -- NCB:=
Example 4-32: Page Command Response NCB:=page -- Current page length is 24 rows -- NCB:= ------------------ NCB:=page 26 -- New page length is 26 rows -- NCB:=

4.38.3 Error Response Format

None.

4.38.4 Response Parameters

None.

4.39 <parameter>

Command

<parameter>

Syntax

[<path>]* <parameter> [<new value>]

Privilege Level

guest, operator

The objects in the SNM database have tree structures that consist of nodes and leaves, where the leaves contain the parameter values. The nodes and leaves may have different access rights. Some leaves may be possible to modify while other may contain read-only values. The values and structure of the objects can be viewed by the list command described above or by simply typing the relative path (the <parameter> command). Typing the path of a leaf followed by a '?' character prints the list of possible value to write. Printing a valid value will write the value to the leaf, and omitting it will read the current value.

4.39.1 Input Parameters


Table 4-26: <parameter> Command Input Parameters
Parameter Description

<path>

This is a "." or <space> separated list of tree nodes relative to the current path.

<parameter>

The name of the leaf

<new value>

The new value that you want to assign to the selected parameter.

4.39.2 Normal Response

The value of the read parameter.


Example 4-33: <parameter> Command Response myuser:#privileges operator
myuser:# ---------------------------------------------- clip_302:#dwdm.arxpower.hat -30.1 dbm clip_302:#dwdm.-arxpower.-hat -29.0 clip_302:#dwdm.-arxpower.-hat -29.0 dbm ---------------------------------------------- clip_311:#datarate stm_4 clip_311:#datarate? [STM_1 OC_3 STM_4 OC_12 STM_16 OC_48 gbit_eth] clip_311:#datarate stm_16 clip_311:#datarate stm_16 ------------------------------------------------ myuser:#privileges operator myuser:#

4.39.3 Error Response

-- Not enough access -- -- Path not found --

4.39.4 Response Parameters

None.

4.40 Password

Command

Password

Syntax

password

Privilege Level

administrator, operator

You can use the password command to change the password of the currently logged-in user. The command will prompt you 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.


Note   You must be in System Configuration mode to execute this command.

4.40.1 Normal Response Format

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

4.40.2 Error Response Example

-- Confirmation failed, password not changed -- -- Password too short, minimum length is 6 characters -- -- Aborted, password not changed --

4.40.3 Response Parameters

"********" represent the characters of the new password.

4.41 Read

Command

Read

Syntax

read <user>
read <user> <source>
read - <source>

Privilege Level

operator

Related command(s)

open eventlog, open pmlog15, open pmlog24, rewind

The read command lists the events in the event log or performance log. You can specify certain events that you want to view using the following commands:

4.41.1 Input Parameters


Table 4-27: Read Command Input Parameters
Parameter Description

<user>

The user whose events you want the log to display.

<source>

The object or card whose events you want the log to display.

4.41.2 Normal Response Format


Example 4-34: Read Command Example EventLog:#source clitester EventLog:#read 2001-06-07 12:35:42 I 0x40020002 snmptester clitester User logged out. 2001-06-07 12:35:20 I 0x40020001 snmptester clitester User logged in. 2001-06-07 12:35:20 I 0x40020002 snmptester clitester User logged out. 2001-06-07 12:35:18 I 0x40020001 snmptester clitester User logged in. ----------------------------------------------------------------------- EventLog:#read - mcu_1_1 2001-06-07 12:17:11 I 0x40020010 system   mcu_1_1   Set status = 'normal'. 2001-06-07 12:17:11 I 0x40020010 system   mcu_1_1   Set status = 'warning'. 2001-06-07 12:09:41 I 0x40020010 system   mcu_1_1   Set status = 'normal'.

4.41.3 Error Response Format

None.

4.41.4 Response Parameters

None.

4.42 Reboot

Command

Reboot

Syntax

reboot

Privilege Level

administrator, operator

The reboot command restarts the NCB. The current Telnet or RS-232 connection is lost and must be re-established after the system restarts.


Note   You must be in System Configuration mode to execute this command.


Note   The restart takes approximately one minute. It is not traffic affecting.

4.42.1 Input Parameters

None.

4.42.2 Normal Response Format

None.

4.42.3 Error Response Format

None.

4.42.4 Response Parameters

None.

4.43 Remove

Command

Remove

Syntax

remove <drive> <file>

Privilege Level

administrator

The remove command deletes files from the NCB module file system. This command does not actually delete the file; it marks it for deletion.


Note   You must issue the defrag command or reboot the system to actually delete the file.


Note   You must be in System Configuration mode to execute this command.

4.43.1 Input Parameters


Table 4-28: Remove Command Input Parameters
Parameter Description

<drive>

The drive on which the file resides. Currently only drive 0 is supported.

<file>

The name of the file to delete

4.43.2 Normal Response Format


Example 4-35: Remove Command Example NCB:=remove 0 file.txt NCB:=

4.43.3 Error Response Format

-- Wrong number of arguments [remove <drive> <file>] -- -- Error, no such file -- -- Error, no such device --

4.43.4 Response Parameters

None.

4.44 Remove CLIP/SNM

Command

Remove CLIP/SNM

Syntax

remove <clip name>
remove <snm name>

Privilege Level

operator

Related Command(s)

insert, configure network

This command removes and uninstalls a unit, such as a CLIP module or SNM (within an NCB module), from a container such as an MCU or SCU. This command also removes all information regarding containers stored on the CLIP module or SNM and prevents alarms from being reported when you physically remove a CLIP or NCB module.


Note   You must be in Network Configuration mode or MCU Configuration mode (also under Network Configuration) to execute this command.

4.44.1 Input Parameters


Table 4-29: Remove CLIP/SNM Command Input Parameters
Parameter Description

<clip name>

The name assigned to the CLIP module you want to insert.

<snm name>

The name assigned to the SNM you want to insert.

4.44.2 Normal Response Format


Example 4-36: Remove CLIP/SNM Command Example mcu_1_45:#remove clip_309 mcu_1_45:# ------------------------------------------ mcu_1_45:#remove snm_234 mcu_1_45:#

4.44.3 Error Response Format

-- Element not found in MCU -- -- Element not found in SCU -- -- Wrong number of arguments [remove <name>] --

4.44.4 Response Parameters


Table 4-30: Remove CLIP/SNM Command Response Parameters
Parameter Description

<rack id>

The backplane strap. Possible values are 1 through 4.

<slot>

The position within the MCU.

<error code>

An internal error code. Report this code to Cisco personnel.

4.45 Rewind

Command

Rewind

Syntax

rewind

Privilege Level

operator

Related command(s)

open eventlog, open pmlog, read

The rewind command restores the view to the most recent event in the event log or performance log. This command is useful when viewing a long list of events.


Note   You must be in the event log or performance log to execute this command. See the "Open Eventlog" section and the "Open Pmlog15/Pmlog24" section on for information on accessing these logs.

4.45.1 Input Parameters

None.

4.45.2 Normal Response Format


Example 4-37: Rewind Command Response EventLog:#read - mcu_1_1 2001-06-07 12:17:11 I 0x40020010 system   mcu_1_1   Set status = 'normal'. 2001-06-07 12:17:11 I 0x40020010 system   mcu_1_1   Set status = 'warning'. 2001-06-07 12:09:41 I 0x40020010 system   mcu_1_1   Set status = 'normal'. EventLog:#rewind 2001-06-07 12:17:11 I 0x40020010 system   mcu_1_1   Set status = 'normal'. 2001-06-07 12:17:11 I 0x40020010 system   mcu_1_1   Set status = 'warning'. 2001-06-07 12:09:41 I 0x40020010 system   mcu_1_1   Set status = 'normal'. EventLog:#

4.45.3 Error Response Format

None.

4.45.4 Response Parameters

None.

4.46 Show Alarm

Command

Show Alarm

Syntax

show alarm [alarm|warning|summary]

Privilege Level

guest user, operator

The show alarm command scans all hub nodes and collector nodes controlled by the NCB and reports all raised alarms. You can choose to report all alarms, all warnings, or a summary of all containers with alarm conditions raised.

4.46.1 Input Parameters


Table 4-31: Show Alarm Command Input Parameters
Parameter Description

alarm

Show only alarms with the "alarm" status

warning

Show only alarms with the "warning" status

summary

Lists only containers with units reporting alarms or warnings

4.46.2 Normal Response Format


Example 4-38: Show Alarm Command Response NCB:>show alarm --------------------+------+------------------------+--------------- name | slot | alarm point | status --------------------+------+------------------------+--------------- Network Config | - | network.cfg | no_file --------------------+------+------------------------+--------------- mcu mcu_1_4 | 3 | client rxpower | la (-33.6 dbm) mcu mcu_1_4 | 3 | dwdm brxpower | la (-33.7 dbm) mcu mcu_1_4 | 3 | dcn qppb | alarm --------------------+------+------------------------+--------------- mcu mcu_1_1 | 4 | dwdm brxpower | la (-32.0 dbm) mcu mcu_1_1 | 4 | dwdm peltiercurrent | la (62.5 pc)

4.46.3 Response Parameters


Table 4-32: Show Alarm Command Response Parameters
Parameter Description

name

The unit type and 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 identifier

status

Current alarm status. Possible values include:

  • alarm—The specified location is in alarm.

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

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

  • mismatch—There are discrepancies between the actual network configuration and the network configuration file.

  • no_file—No network configuration file was found.

4.47 Show Discrepancy

Command

Show Discrepancy

Syntax

show discrepancy

Privilege Level

guest user, operator

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


Note   This command can take several minutes to execute.

4.47.1 Input Parameters

None.

4.47.2 Normal Response Format

The normal response format is a text list containing the discrepancies.


Example 4-39: Show Discrepancy Command Response NCB:>show discrepancy
clip.clip_301.dcnaddress: Integer is '64', should be '40'.
clip.clip_301.state: Enum is 'online', should be 'offline'.

4.47.3 Error Response Format

-- No configuration file found --

4.47.4 Response Parameters

None.

4.48 Show Inventory

Command

Show Inventory

Syntax

show inventory

Privilege Level

guest user, operator

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

4.48.1 Input Parameters

None.

4.48.2 Normal Response Format


Example 4-40: Show Inventory Command Response NCB:>show inventory -----+--------------------------------+------+-----+-------------|----- type | name                           | slot | itu | serial no   | mgr -----+--------------------------------+------+-----+-------------|----- mcu  | mcu_4_15                       |      |     |             | ncb  | snm_12316                      |  17  |     | CEM05070007 | -----+--------------------------------+------+-----+-------------|----- mcu  | mcu_1_1                        |      |     |             | clip | clip_301                       |   1  |  0  | CEM03010000 | p clip | clip_302                       |   2  |  0  | CEM03020000 | p clip | clip_303                       |   3  |  0  | CEM03030000 | s clip | clip_304                       |   4  |     | CEM03040000 | ncb  | snm_456                        |  17  |     | CEM04560000 | -----+--------------------------------+------+-----+-------------|----- mcu  | mcu_1_2                        |      |     | clip | clip_101                       |   1  |     | CEM01010000 | clip | clip_102                       |   2  |     | CEM01020000 | -----+--------------------------------+------+-----+-------------|----- clip | clip_103                       |      |     | CEM01030000 | -----+--------------------------------+------+-----+-------------|----- NCB:>

4.48.3 Response Parameters


Table 4-33: Show Inventory Command Response Parameters
Parameter Description

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

  • ncb—Network Control Board (NCB) unit

name

Name of the unit

slot

Physical location of the unit in the subrack

itu

International Telecommunications Union (ITU) channel number (i.e. wavelength)

serial no

Serial number (assigned during manufacturing)

mgr

SNM that manages that CLIP module. The following options are available:

  • p—the SNM you are logged into is the primary manager of this CLIP module.

  • s—the SNM you are logged into is the secondary manager of this CLIP module.

  • A blank field means that the SNM you are logged into is neither the primary nor the secondary manager of this CLIP module.

4.49 Show Management

Command

Show Management

Syntax

show management

Privilege Level

guest user, operator

The show management command displays the current properties of the Simple Network Management Protocol (SNMP) interface.

4.49.1 Input Parameters

None.

4.49.2 Normal Response Format


Example 4-41: Show Management Command Response 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

4.49.3 Error Response

None.

4.49.4 Response Parameters


Table 4-34: Show Management Command Response Parameters
Parameter Description

name

Name of contact person

address

Address or other contact information

4.50 Show Name

Command

Show Name

Syntax

show name

Privilege Level

guest user, operator

The show name command displays the assigned names for every element in the system.

4.50.1 Input Parameters

None.

4.50.2 Normal Response Format


Example 4-42: Show Name Command Response NCB:>show name --------+--------------------------------+------------------- type | identity                       | name --------+--------------------------------+------------------- mcu | mcu_1_1 | heimdal --------+--------------------------------+------------------- scu | scu_2_215 | tor scu | scu_2_341 | loke --------+--------------------------------+-------------------- clip | clip_340 | clip_340 clip | clip_208 | clip_208 clip | clip_215 | clip_215 clip | clip_341 | clip_341 --------+--------------------------------+----------------------------------- snm | snm_12327 | snm_12327 --------+--------------------------------+-------------------- path | path_208_215 | path_208_215 path | path_340_341 | path_340_341 --------+--------------------------------+-------------------

4.50.3 Error Response

None.

4.50.4 Response Parameters


Table 4-35: Show Name Command Response Parameters
Parameter Description

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

  • snm—Subnetwork Manager

  • path—Logical connection between two CLIP modules

identity

Original name of the element

name

Pseudonym assigned to the named element

4.51 Show Path

Command

Show Path

Syntax

show path

Privilege Level

guest user, operator

The show path command lists all logical connections in the network. A path is formed by two network elements communicating over a particular wavelength.

4.51.1 Input Parameters

None.

4.51.2 Normal Response Format


Example 4-43: Show Path Command Response NCB:>show path ----------------+--------------+-----+-----------------+---------------- name | status | itu | element 1 | element 2 ----------------+--------------+-----+-----------------+---------------- path_361_360 | major | 33 | clip_361 | clip_360 path_363_362 | normal | 53 | clip_363 | clip_362 path_365_364 | normal | 55 | clip_365 | clip_364 path_171_178 | warning | 23 | clip_171 | clip_178 path_305_405 | normal | 27 | clip_305 | clip_405 ----------------+--------------+-----+-----------------+----------------

4.51.3 Error Response Format

None.

4.51.4 Response Parameters


Table 4-36: Show Path Command Response Parameters
Parameter Description

name

Name of the path or logical connection

status

The status of the unit. Possible values are:

Normal: Unit is functioning normally

Warning: Operation is functioning close to alarm thresholds

Critical: A critical alarm has occurred

Major: A major alarm has occurred

itu

International Telecommunications Union (ITU) channel number (i.e. wavelength)

clip 1

The CLIP at the end of the first path

clip 2

The CLIP at the end of the second path

4.52 Show Power

Command

Show Power

Syntax

show power

Privilege Level

guest user, operator

The show power command reads all optical power levels at the network element receivers and displays the current status of the read value.

4.52.1 Input Parameters

None.

4.52.2 Normal Response Format


Example 4-44: Show Power Command Response NCB:>show power --------------------+------+-----+---------------------+---------- name | slot | itu | dwdm A, B | client --------------------+------+-----+----------+----------+---------- mcu mcu_1_4 | 1 | 23 | -5.0 hw | -11.0 | -34.4 mcu mcu_1_4 | 3 | 33 | -12.0 | -17.0 lw | -33.6 la mcu mcu_1_4 | 5 | 53 | -11.3 | -12.3 | -33.8 la mcu mcu_1_4 | 7 | 55 | -10.2 | -11.2 | -33.4

4.52.3 Error Response Format

None.

4.52.4 Response Parameters


Table 4-37: Show Power Command Response Parameters
Parameter Description

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 and any threshold warnings or alarms caused by that power level. See the "Show Alarm" section for more information on warnings and alarms.

4.53 Show User

Command

Show User

Syntax

show user [<name>]

Privilege Level

administrator, operator

The show user command lists all users in the network. Information about privilege level and logon status (i.e. online, offline, suspended, or disabled) also appears. If only a specific user is of interest, that user's name can be specified as a parameter.

See "Configurable Parameters" for more information on user parameters.

4.53.1 Input Parameters

None.

4.53.2 Normal Response Format


Example 4-45: Show User Command Response NCB:>show user -------------------------------+-----------------+----------- name | privileges | state -------------------------------+-----------------+----------- tokarlss | administrator | online KalleKula | guest | offline kaller | guest | suspended snmptester | operator | disabled -------------------------------+-----------------+-----------

4.53.3 Error Response Format

None.

4.53.4 Response Parameters


Table 4-38: Show User Command Response Parameters
Parameter Description

name

The logon name of the user

privileges

The privilege level of the user (administrator, operator, guest).

state

Condition of a selected user. Possible states are:

Online—The user is currently logged on.

Offline—The user is not currently logged on.

Disabled—The user is not allowed to log on.

Suspended—Attempts to login exceeded the maximum allowable number of attempts (5).

4.54 Sntp

Command

Sntp

Syntax

sntp server [<ipaddr>|<dnsname>|none]

sntp timezone [<zone>]

sntp dlst_on [<day:mon hour:min>]

sntp dlst_off [<day:mon hour:min>]

sntp freq [<freq>]

sntp commit

Privilege Level

administrator

The sntp command uses Simple Network Timing Protocol (SNTP) to synchronize the clocks of all of the 15201/15252 NEs in the network in real time. The following sntp commands are available:

You can view the current sntp setting of each of the commands by typing the command without the argument following it.


Note   You must be in System Configuration mode to execute this command.

4.54.1 Input Parameters


Table 4-39: Sntp Command Input Parameters
Parameter Description

<zone>

The time zone in hours (and minutes) from GMT. This value can be an integer or in the form of hours and minutes (hh:mm).

<ipaddr>

The IP address of the node that you want use as the synchronization source for the network.

<day:mon hour:min>

The date and time that the Daylight Savings Time mode is turned on or off.

<freq>

The minutes (from 1 - 60) between synchronizations of the clock.

<dnsname>

The name of the server you want to use as the synchronization source for the network.

4.54.2 Normal Response Format


Example 4-46: Sntp Command Response NCB:=sntp server 10.52.18.21 NCB:=sntp timezone GMT+1 DayLight Saving Time is not active NCB:=sntp freq 1 min NCB:=sntp freq 5 NCB:=sntp dlst_on 13:03 02:00 NCB:=sntp dlst_off 28:10 03:00 NCB:=sntp dlst_on Daylight saving time date ON [13 Mar 2:00] NCB:=sntp dlst_off Daylight saving time date OFF [28 Oct 3:00] NCB:=

4.54.3 Error Response Format

-- Error, not a valid address -- -- Error, update frequency should be between 1 and 720 -- -- Error, time zone should be between -12:00 and +12:00 --

4.54.4 Response Parameters

None.

4.55 Source

Command

Source

Syntax

source <dev> <file name>

Privilege Level

administrator, operator

The source command changes the input stream and enables the CLI to read commands from a file specified by the <file name> parameter. When the CLI reads an end-of-file (EOF) character, it automatically switches back to the original input stream.


Note   You must be in System Configuration mode to execute this command.

4.55.1 Input Parameters


Table 4-40: Source Command Input Parameters
Parameter Description

<device>

Represents the drive number. Currently only Device 0 is supported.

<file name>

Represents the name of the file used as the new input stream

.

4.55.2 Normal Response Format

The individual printouts from the commands in the specified file.


Example 4-47: Source Command Response NCB:=source 0 myfile.cmd
NCB:=

4.55.3 Error Response Format

-- Error, no such file --
-- Wrong number of arguments [source <file>] --

4.55.4 Response Parameters

None.

4.56 Suppress/No Suppress

Command

Suppress/No Suppress

Syntax

suppress [<path>]
no suppress [<path>]

Privilege Level

operator

Related Command(s)

suppress, no suppress

The suppress command suppresses an alarm so that changes in alarm status are not reported to the management interface that ordered the suppression (SNM or Maintenance Manager), but are still reported to the other interfaces present in the system. The no suppress command reverses the suppress command and allows changes in alarm status to be reported. An suppressed alarm point will report the status "suppressed." All users logged into that SNM will be unable to receive alarms from the suppressed alarm point until the no suppress command is issued.


Note   You must be in CLIP Configuration mode to perform these commands.

4.56.1 Input Parameters

"<path>" is a ".." or <space> separated list of tree nodes relative to the current path.

4.56.2 Normal Response Format


Example 4-48: Suppress/No Suppress Command Response NCB:=dwdm arxpower status highwarning NCB:=suppress dwdm arxpower NCB:=dwdm arxpower status suppressed NCB:=no suppress dwdm arxpower NCB:=dwdm arxpower status highwarning NCB:=

4.56.3 Error Response Format

-- Not an suppressible alarm point -- -- Unable to suppress/unsuppress--

4.56.4 Response Parameters

None.

4.57 Syslog

Command

Syslog

Syntax

syslog

Privilege Level

administrator, operator

Related Command(s)

configure system

The syslog command shows the internal low-level system log. The internal low-level system log contains low-level system events and errors that are specific to the cards. The syslog can be used to troubleshoot conditions that may cause the application to fail or boards to reboot.


Note   You must be in System Configuration mode to execute this command.

4.57.1 Input Parameters

None.

4.57.2 Normal Response Format


Example 4-49: Syslog Command Response NCB:=syslog Thu Jul 22 17:58:24 2000 Booted NMS 1.0(0.4) Sat Feb 3 01:02:02 2001 New time: 2001:02:03 01:02:02 Tue Feb 20 15:45:00 2001 New time: 2001:02:20 15:45:00 NCB:=

4.57.3 Error Response Format

None.

4.57.4 Response Parameters

None.

4.58 Time

Command

Time

Syntax

time [<yyyy:mm:dd> <hh:mm:ss>]

Privilege Level

administrator, operator

The time command is used to read and set the current system time. When the time command is issued without parameters, the current time is presented. Both the date and time must be specified in order to set the current time.


Note   You must be in System Configuration mode to execute this command.

4.58.1 Input Parameters


Table 4-41: Time Command Input Parameters
Parameter Description

<yyyy:mm:dd>

The year, month, and date to which the system will be set. The year must be in 4-digit format, and the month and date must be in 2-digit format.

<hh:mm:ss>

The hour, minute, and second to which the system will be set.

4.58.2 Normal Response Format

If you specify the time parameter, the normal response is a blank command line. If no parameters are specified, the response is the current system time, in <yyy:mm:dd><hh:mm:ss> format.


Example 4-50: Time Command Response NCB:=time Thu Feb 22 13:59:01 2001 NCB:= ---------------------- NCB:=time 2001:02:22 13:44:00 NCB:=

4.58.3 Error Response Format

-- Syntax error -- -- Wrong number of arguments [time or time <yyyy:mm:dd> <hh:mm:ss>] --

4.58.4 Response Parameters

None.

4.59 Type

Command

Type

Syntax

type <dev> <filename>

Privilege Level

administrator

The type command displays the content of the specified text file.


Note   You must be in System Configuration mode to execute this command.

4.59.1 Input Parameters


Table 4-42: Type Command Input Parameters
Parameter Description

<dev>

Represents the drive number. Currently only Device 0 is supported.

<filename>

The name of the file for which you want to display its contents.

.

4.59.2 Normal Response Format

The individual printouts from the commands in the specified file.


Example 4-51: Type Command Response NCB:=type 0 sntp.cfg 1 10.52.18.21 2 1 3 10 4 13:03, 05:00 5 28:10,03:00 NCB:=

4.59.3 Error Response Format

-- Error, no such file --

4.59.4 Response Parameters

None.

4.60 Upload

Command

Upload

Syntax

upload [<path>]

Privilege Level

operator, guest

Related Command(s)

suppress, no suppress

The upload command synchronizes the database with an external device. When an object is created in the database, its parameters assume default values. Database objects, which reflect physical objects, may need to be synchronized in case the reading is unsuccessful. The upload command provides a way to resynchronize an object without knowing its parameters or structure. An optional path may be specified to partially re-synchronize an object. The upload process may take some time.


Note   You must be in CLIP or SNM Configuration mode to perform this command.

4.60.1 Input Parameters

"<path>" is a ".." or <space> separated list of tree nodes relative to the current path.

4.60.2 Normal Response Format


Example 4-52: Upload Command Response NCB:= upload dwdm NCB:=

4.60.3 Error Response Format

-- Not an suppressible alarm point -- -- Unable to suppress/unsuppress--

4.60.4 Response Parameters

None.

4.61 Version

Command

Version

Syntax

version

Privilege Level

administrator, operator

The version command displays the following:

4.61.1 Input Parameters

None.

4.61.2 Normal Response Format

NCB:=version NCB Part No: xxx-xxxxx-xx NCB Revision No: xx NCB Serial No: xxxxxxxxxxx SNM Part No: xxxxxxx SNM Version No: x.x(x.x) NCB:=
Example 4-53: Version Command Response NCB:=version NCB Part No: 800-09474-01 NCB Revision No: 01 NCB Serial No: QEY05100217 SNM Part No: 36A0012 SNM Version No: 1.1(0.7) NCB:=

4.61.3 Error Response Format

None.

4.61.4 Response Parameters

None.

4.62 Whoami

Command

Whoami

Syntax

whoami

Privilege Level

administrator, guest user, operator

The whoami command displays the current user and user privilege (administrator, operator, guest user).

4.62.1 Input Parameters

None.

4.62.2 Normal Response Format

NCB:>whoami <user name>         <user access level>
Example 4-54: Whoami Command Response NCB:>whoami my user         operator

4.62.3 Error Response Format

None.

4.62.4 Response Parameters


Table 4-43: Whoami Command Response Parameters
Parameter Description

user name

The logon name of the current user

user access level

The privilege level of the current user (administrator, operator, guest)


hometocprevnextglossaryfeedbacksearchhelp
Posted: Mon Sep 30 20:33:35 PDT 2002
All contents are Copyright © 1992--2002 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.