Table Of Contents
Command Line Interface Overview
The Role of the CLI
Command Line Prompt
Command Syntax
Notation
Position-Dependent and Keyword-Driven Parameters
Command Entry
Contents of a Command Description
Identifying the AXSM Models
Connection Capacities of the AXSM
Identifying Physical and Logical Elements
AXSM Format
PNNI Format
List of Commands
?
bye
cc
cd
clrscrn
cmdhistory
copy
cp
del
exit
help
history
logout
ls
ping
pwd
who
whoami
Command Line Interface Overview
This chapter describes the command line interface (CLI) for the MGX 8850 and MGX 8950 nodes. In addition, the chapter describes the basic user-commands for logging on to and out of the switch, changing between the CLI of different cards, and listing files on the hard drive. This chapter includes usage examples. For information on how to configure a switch and basic network services, refer to the Cisco MGX 8850 and MGX 8950 Switch Software Configuration Guide, Release 2.1.
The chapter describes:
•
The role of the CLI on the switch
•
The information contained in the CLI prompt
•
The command syntax
•
Contents of a command description
•
Identification of the models of the ATM Switching Service Module (AXSM)
•
A logical port in the context of the Public Network-to-Network (PNNI) protocol
•
A logical port in the context of AXSM configuration
•
User-specific commands
The Role of the CLI
During normal operation, the tools for configuring, monitoring, and controlling a switch are the CiscoView application for equipment management and the Cisco WAN Manager application for connection management. However, during initial switch installation, troubleshooting, or where low-level control is important, the command line interface (CLI) provides the best access to the switch.
Each PXM45 and service module supports its own CLI. Each card has a set of commands specific to its card-type—although some commands overlap. In certain instances, this manual indicates cases where two commands with the same name produce different results on different card types. (The available command set also depends on the privilege level of the user.)
Although you can execute a command on only the card that supports that command, the target of the command can be another card when you are "on" the PXM45. (Being "on" a card means you have logged into the card and are using the CLI for that card.) On the PXM45, you can execute commands that target an XM60, the PXM45 itself, the whole node, or a service module.
To move from the CLI of one card to the CLI of another card, use the Change Card (cc) command. The description of cc appears in this chapter.
Command Line Prompt
The format of the CLI prompt is:
name.slot number.card type.card state >
where:
•
name is the name of the node ("Unknown" until a you assign name with the cnfname command).
•
slot number is the slot of the front card.
•
card type identifies the Processor Switching Module 45 (PXM45) or a service module type, such as the AXSM.
•
card state is "i" for initialized, "a" for active, or "s" for standby. For many commands, a card must be active before the command can execute, so each command description has an Attributes section that identifies the states in which the command can execute.
–
A card in the initialized state (i) is still loading application modules.
–
A card in the active (a) state either is fully configured and ready to carry out its function or is already performing its function with live traffic.
–
Typically, a card goes into the standby (s) state when it first powers up and boots or when you execute a command that puts it in the standby state. For example, the commands for a graceful upgrade of firmware on a pair of PXM45s puts the active card in the standby state and the standby card in the active state (see loadrev description for details).
An example of a CLI prompt is:
The preceding prompt shows that the
•
Name of the node is "excel."
•
Slot number is 7.
•
Card type is PXM45.
•
Card state is active.
Command Syntax
This section contains the following syntax topics:
•
Notation
•
Position-dependent parameters
•
Keyword-driven parameters
•
Logical port format
•
Command entry
Notation
The notation for command and argument parameters follows:
•
Commands and their parameters are separated by a space.
•
Variables appear in italics.
•
Keywords and commands appear in bold.
•
Required arguments appear within left and right arrowheads ("< >").
•
Optional parameters appear within square brackets ("[ ]").
•
A vertical bar ( | ) represents the logical OR function.
Position-Dependent and Keyword-Driven Parameters
A command can include parameters that are keyword-driven or position-dependent.
For position-dependent parameters, you must type parameters in the order they appear in the syntax description or on-line help. To create a logical port, for example, the position-dependent syntax is:
addport <ifNum> <bay.line> <guaranteedRate> <maxrate> <sctID> <ifType> [vpi]
For a keyword-driven parameter, a keyword must precede the value. The keyword is preceded by a dash and followed by the parameter (-timeout <secs>, for example). The order you enter keyword-driven parameters does not matter—although any preceding or succeeding, position-dependent parameters must appear as they do in the command syntax description.
In the following syntax example, the command is to delete more than one connection at a time. The mandatory, position-dependent connection identifier consist of a logical port (ifNum) and the VPI and VCI of the first connection to delete. After the connection identifier, the line shows two optional, keyword-driven parameters. These keyword-driven parameters let you enter the number of connections to delete and specify verbose mode:
delcons <ifNum> <vpi> <vci> [-num <num. conns to del>] [-verbose < 1 | 0 >]
Command Entry
When you enter a command with the current version of the product, you must type all intended arguments before you press the Return key or Enter key.
If you press the Return key or Enter key with incorrect parameters or no parameters (if the command requires parameters), a message displays the syntax and parameter ranges. The returned message may also suggest what the problem is. For example, the message may warn of too few parameters. No error messages or warnings appear until you complete the command.
Contents of a Command Description
Each command description contains:
•
An introductory paragraph that explains the function of the command. Additional paragraphs elaborate on the functionality as needed.
•
A list of cards on the CLI of which you can execute the command.
•
The syntax of the command. This manual presents parameters in a column to make them easier to read, particularly when displayed through an electronic medium.
•
A syntax description lists all the parameters. Each item in the list includes a brief definition, functional details when appropriate, the range of values for the parameter, and an applicable default value.
Note that, in many instances, the default value is not merely a basic starting value but rather the most desirable or commonly used value.
•
Occasionally, the description includes a Usage Guidelines section when the complexity of the command warrants it. The Usage Guidelines section contains important details about using the command. When needed, an additional section with a specialized focus may appear. An example is the Version Numbering description for the firmware upgrade commands (see loadrev, for example).
•
An Attributes section lists the following details:
•
Whether the switch logs each instance of command execution. Typically, the switch logs each configuration change but no display commands.
•
The state of the card required to a execute a command. The state can be active, standby, initialized (infrequently), or any of these states.
•
A Related Commands lists other commands in the typical grouping of commands (add, delete, configure, and display) or other commands that could complement the command.
•
An Example section shows one or more examples of command usage. The text for this section describes the intention of the command and may also describe an outcome. A representation of screen output usually appears. Occasionally, supplemental commands and screen samples appear in support of the example.
Identifying the AXSM Models
The model number of an AXSM identifies the line speed, line count, and number of bays (see Table 1-1.) Note that the number of lines applies to an individual back card, so the total number of lines supported by the front card equals the highest line number times the number of bays. The OC-48 card AXSM-1-2488 has the lowest number of lines—one. The highest number of lines exist on the AXSM-16-155 and AXSM-16-T3E3—16, as the name indicates.
The MGX 8850 and MGX 8950 nodes use the concept of a bay. The bay refers to the upper or lower location of a single-height card. (The switch has a double-height card cage, so a single-height back card necessarily occupies either an upper or lower position.)
The T3/E3, OC-3, and OC-12 versions of the AXSM can have two back cards, one in bay 1 (upper location of the back slot) and the second in bay 2 (lower slot). The MGX-AXSM-1-2488 (OC-48 AXSM) can have a back card in bay 1 only. For further descriptions and illustrations of the card sets, refer to Cisco MGX 8850 Routing Switch Hardware Installation Guide, Release 2.1 or Cisco MGX 8950 Hardware Installation, Release 1.0.
Table 1-1 Valid Line Numbers and Number of Bays for AXSM Card Types
Front Card
|
Speed
|
Lines
|
Bays
|
AXSM-1-2488
|
OC-48
|
1
|
1
|
AXSM-4-622
|
OC-12
|
1-4
|
1-2
|
AXSM-16-155
|
OC-3
|
1-8
|
1-2
|
AXSM-16-T3E3
|
T3, E3
|
1-8
|
1-2
|
AXSM-2-622-E
|
OC12
|
1
|
1-2
|
AXSM-8-155-E
|
OC3
|
1-4
|
1-2
|
AXSM-16-T3E3-E
|
T3, E3
|
1-8
|
1-2
|
Connection Capacities of the AXSM
The SVC and SPVC connection capacities for the front card, back card, and physical lines appear in Table 1-2 and Table 1-3. The capacity of a single AXSM card is greater than that of the node itself. Nevertheless, the tables provide these maximums when you plan the use of commands such as addrscprtn, addcon, and any other command where you may want to know the capacity of the configured item to support connections.
Table 1-2 Maximum Connections by Connection Type and Front Card
Front Card
|
SVC
|
SPVC
|
AXSM-1-2488
|
128 K
|
64 K
|
AXSM-4-622
|
128 K
|
64 K
|
AXSM-16-155
|
128 K
|
64 K
|
AXSM-16-T3E3
|
128 K
|
64 K
|
Table 1-3 Maximum Connections on Back Cards and Lines
Card Type
|
Back Card Maximum
|
Physical Line Maximum
|
OC-48c
|
128 K
|
64 K
|
OC-12c
|
64 K
|
32 K
|
OC-3c
|
64 K
|
32 K
|
T3
|
64 K
|
64 K
|
E3
|
64 K
|
64 K
|
Identifying Physical and Logical Elements
The Private Network-to-Network Interface (PNNI) control protocol and the AXSM use different formats to identify the same elements. This section describes the format of these elements in the PNNI and AXSM contexts and how they correspond to each other. When you configure or view items on the CLIs of different cards, you often need to specify it in PNNI as well as the AXSM. For example, when you configure a PNNI port on the CLI of the PXM45, you also need to configure a port on the CLI of the AXSM. Furthermore, when you display a connection on the AXSM, you identify that same connection using a different format on the PXM45 CLI. For specific examples of these parallel actions, see the Cisco MGX 8850 and MGX 8950 Software Configuration Guide, Release 2.1.

Note
Apart from the way PNNI and the lower levels of logic identify the same element, the issue of configuration sequence needs explanation. When you configure logical ports—as just one example—you must complete certain tasks on the AXSM CLI before and after related PNNI tasks. This manual describes prerequisites for certain commands, but refer to the Cisco MGX 8850 and MGX 8950 Software Configuration Guide, Release 2.1, for more details of this sequence.
AXSM Format
The AXSM items that you identify for addressing purposes are:
•
Slot
•
Bay
•
Line
•
Logical port
A logical port on an AXSM (and its CLI) always uses the label ifNum. For a UNI and NNI interface, a one-to-one correspondence exists between a logical port and a physical line. For virtual trunks, you can configure multiple ports for a line.
The maximum number of logical ports on an AXSM is 60 regardless of the AXSM model or the number of AXSM back cards. The range of logical ports (ifNum) is 1-60 for the AXSM and 1-32 for the AXSM-E regardless of whether the interface type is UNI, NNI, or VNNI.
PNNI Format
The PNNI controller requires the following format to identify a physical port:
[shelf.]slot:subslot.port:subport
The PNNI physical port identifier (physical port ID) consists of a series of mandatory elements. Note the period or colon associated with each element inside the square brackets. The elements of the physical port ID are as follows:
•
The shelf is always 1 for the current product and so is usually omitted.
•
The slot number of the front card.
•
Subslot is the number of the bay where the back card resides. This number is 1 or 2.
•
Port is the physical line.
•
Subport corresponds to the resource partition on the AXSM. For a UNI or NNI, this resource partition is the same number as the logical port number (ifNum) on the AXSM. For a virtual network-to-network interface (VNNI), these numbers do not directly correspond to each other.
For each physical port number, PNNI also generates a logical port number as an encrypted form of the physical port number. The logical port number appears as an unformatted numerical string. For example, a PNNI physical port ID may have the form 1:1.2:2, so the PNNI logical port number would be 16848898. Where needed, the descriptions in the PNNI command chapter define the need for this logical port number. (This section does not define a PNNI logical port number, nor does it describe the correspondence between an AXSM port and a PNNI logical port number.) For the correspondence between a PNNI physical port and the port identifier on an AXSM, see Table 1-4.
Table 1-4 Mapping PNNI Port ID to AXSM Elements
PNNI port
|
AXSM
|
Shelf
|
N/A
|
Slot
|
Slot
|
Subslot
|
Bay (for upper or lower back card)
|
Port
|
Line
|
Subport
|
Logical interface (or port)
|
As the table shows, a port from the PNNI side is a line on the AXSM, and a subport from the PNNI side is a logical interface (or logical port) on an AXSM. An example of a PNNI physical port identifier is 1:2.1:1. This portid corresponds to an AXSM, with the following particulars:
Slot 1
Bay 2
Line 1
Logical interface 1 (or logical port 1).
List of Commands
The commands in this chapter appear in Table 1-5. It shows the name and function of each command.
Table 1-5 List of User-Commands
Command
|
Description
|
? or Help
|
Help (list of commands available on the card).
|
bye
|
End current user-session.
|
cc
|
Change card
|
cd
|
Change directory.
|
clrscrn
|
Clear terminal screen.
|
cmdhistory
|
List last 10 commands entered.
|
copy
|
Copy one file to another on the hard drive.
|
cp
|
Copy one file to another on the hard drive.
|
del
|
Delete a file on the hard drive.
|
exit
|
Exit the current user-session (and log out).
|
help or ?
|
List of commands per card.
|
history
|
List recent command entries.
|
logout
|
Log out of the node (and end current user-session).
|
ls
|
List files on the hard drive.
|
ping
|
Send ICMP packet to far end station to determine if it is operational.
|
pwd
|
Identify current working directory on the hard drive.
|
who
|
List current user on the PXM45.
|
whoami
|
List details about the current user.
|
?
Help
Use help to view all commands you can execute on the current card and at the current privilege level. The display does not show commands with a privilege level that is higher than that of the current user.
If you follow the ? with part of a command name, the output shows all commands that contain that string. If you follow the ? with the complete name of one command, the output simply states whether that command is available.
If you can enter two parameter strings, help provides information for each of the two strings separately (not a single, two-part string).
Cards on Which This Command Runs
PXM45, AXSM, AXSM-E
Syntax
?
[command]
Syntax Description
command
|
Full or partial name of a command.
|
Related Commands
help
Attributes
Log: no log
|
State: active, standby, init
|
Privilege: ANYUSER
|
Examples
View all commands associated with a partial command entry string.
bye
Bye
Exit the current CLI session.
Cards on Which This Command Runs
PXM45, AXSM, AXSM-E
Syntax
bye
Related Commands
logout, exit
Attributes
Log: log
|
State: active, standby, init
|
Privilege: ANYUSER
|
Exit the current CLI shell.
cc
Change Card
Use cc to change from the current CLI to the CLI of another card. Follow cc with a slot number.
Cards on Which This Command Runs
PXM45, AXSM, AXSM-E
Syntax
cc <slot number>
Syntax Description
slot number
|
The number of the destination card slot.
|
Related Commands
None
Attributes
Log: log
|
State: active, standby, init
|
Privilege: ANYUSER
|
Change from the command line of the AXSM in slot 12 to the command line of the PXM45 in slot 8.
If the slot is empty or the card is unreachable, the system displays an applicable message.
cd
Change Directory
Use cd to change to another directory on the PXM45 hard disk.
Cards on Which This Command Runs
PXM45
Syntax
cd <directory_name>
Syntax Description
directory_name
|
Name of the destination directory.
|
Related Commands
ls, pwd, rename, rm/rmdir, copy
Attributes
Log: log
|
State: active, standby, init
|
Privilege: ANYUSE
|
Change directory to FW, then check the result by executing pwd.
Verify the current directory by using the pwd command.
Go back to Root directory, then check the result by executing pwd.
clrscrn
Clear Screen
Use clrscrn to clear the control terminal screen. After this command runs, only the current command line prompt appears on the screen.
Cards on Which This Command Runs
PXM45, AXSM, AXSM-E
Syntax
clrscrn
Related Commands
None
Attributes
Log: no log
|
State: active, standby, init
|
Privilege: ANYUSER
|
Example
Clear the screen.
MGX8850.11.AXSM.a > clrscrn
cmdhistory
Display Command History
Use cmdhistory to list the last 10 commands executed on the current card. To execute a previous command with parameters, type an exclamation mark and the associated number and no spaces, then press Enter or Return.
Cards on Which This Command Runs
PXM45, AXSM, AXSM-E
Syntax
cmdhistory
Syntax Description
This command takes no parameters.
Related Commands
history
Attributes
Log: no log
|
State: active, standby, init
|
Privilege: ANYUSER
|
Example
Display the previous commands executed on the PXM45. Repeat dspcd.
MGX8850.7.PXM.a > cmdhistory
Size of cmdHistory is currently 10 line(s)
MGX8850 System Rev: 02.01 Sep. 09, 2001 16:58:23 GMT
MGX8850 (MGX8850) Node Alarm: MAJOR
Slot Number 7 Redundant Slot: 8
Front Card Upper Card Lower Card
---------- ---------- ----------
Inserted Card: PXM45 UI Stratum3 PXM HardDiskDrive
Reserved Card: PXM45 UI Stratum3 PXM HardDiskDrive
State: Active Active Active
Serial Number: SAK0401006C SHELFMGMGRP SAK03520058
Prim SW Rev: 2.0(1)D --- ---
Sec SW Rev: 2.0(1)D --- ---
Cur SW Rev: 2.0(1)D --- ---
Boot FW Rev: 2.0(233)A1 --- ---
Orderable Part#: 800-06147-01 800-03145-07 800-05052-03
CLEI Code: 0000000000 CISCO__INC 0000000000
Reset Reason: On Reset From Shell
Miscellaneous Information:
Type <CR> to continue, Q<CR> to stop:
copy
Copy
Use copy to copy a file to a new file on the disk on the PXM45-HD. This command is the same as the cp command.
Cards on Which This Command Runs
PXM45
Syntax
copy <source file name> <destination file name>
Syntax Description
source file name
|
The name of the file you intend to copy.
|
destination file name
|
The name of the new file resulting from copy or the name of the existing file that is over-written as a result of copy.
|
Related Commands
cp, cd, ls, rm, pwd, rename
Attributes
Log: log
|
State: active, standby, init
|
Privilege: GROUP1
|
Example
Create a new firmware file without the image's suffix by copying the file named pxm_1.0.00Ef.fw to pxm_1.0.00.fw.
MGX8850.8.PXM.a > copy pxm_1.0.00Ef.fw pxm_1.0.00.fw
cp
Copy
Use cp to copy a file to a new file on the disk on the PXM45-HD. This command is the same as the copy command.
Cards on Which This Command Runs
PXM45
Syntax
cp <source file name> <destination file name>
Syntax Description
source file name
|
The name of the file you intend to copy.
|
destination file name
|
The name of the new file resulting from cp or the name of the existing file that is over-written as a result of cp.
|
Related Commands
cd, ls, rm, pwd, rename
Attributes
Log: log
|
State: active, standby, init
|
Privilege: GROUP1
|
Example
Create a new firmware file without the image's suffix by copying the file named pxm_1.0.00Ef.fw to pxm_1.0.00.fw.
MGX8850.8.PXM.a > cp pxm_1.0.00Ef.fw pxm_1.0.00.fw
del
Delete
Use del to remove a file or directory from the PXM45 hard drive.
Cards on Which This Command Runs
PXM45
Syntax
del <path_name>
Syntax Description
path_name
|
Name of an existing file or directory.
|
Related Commands
None
Attributes
Log: log
|
State: active, standby, init
|
Privilege: GROUP1
|
exit
Exit from User Session
Use exit to exit the current user session and log out. To start another session, you must log in by using telnet (for example).
Cards on Which This Command Runs
PXM45, AXSM, AXSM-E
Syntax
exit
Related Commands
bye, logout
Attributes
Log: log
|
State: active, standby, init
|
Privilege: ANYUSER
|
Example
Exit from the current user session.
help
Help
Use help to view commands associated with the current card. The help command is case-sensitive. Its behavior with or without parameters is:
•
With no parameter string, it lists all commands on the card.
•
With part of a command name, it lists all commands that contain that string.
•
With the entire command name, the output shows only whether the command is available.
Cards on Which This Command Runs
PXM45, AXSM, AXSM-E
Syntax
Help
[string]
Related Commands
?
Attributes
Log: no log
|
State: active, standby, init
|
Privilege: ANYUSER
|
history
Command History
Use history to display the last 10 commands executed on the current card. To repeat a command with its parameters, type an exclamation mark followed by the associated number and no spaces.
Cards on Which This Command Runs
PXM45, AXSM, AXSM-E
Syntax
history
Syntax Description
This command takes no parameters.
Related Commands
cmdhistory
Attributes
Log: no log
|
State: active, standby, init
|
Privilege: ANYUSER
|
Example
Display the last 10 commands executed on the PXM45. Repeat the previous execution of dspdate.
MGX8850.7.PXM.a > dspdate
MGX8850.7.PXM.a > history
Size of cmdHistory is currently 10 line(s)
logout
Log Out
Use logout to end the current user session.
Cards on Which This Command Runs
PXM45, AXSM, AXSM-E
Syntax
logout
Syntax Description
This command takes no parameters.
Related Commands
bye, exit
Attributes
Log: log
|
State: active, standby, init
|
Privilege: ANYUSER
|
Example
Log out of the current CLI shell.
ls
List
Use ls to list the contents of the working directory. The filename is listed for each entry. The total space of the file system and free space is also summarized at the end of the output.
Cards on Which This Command Runs
PXM45
Syntax
ls
[dir]
Syntax Description
You can specify an optional directory or path to list.
Related Commands
cd, pwd, rename, copy
Attributes
Log: no log
|
State: active, standby, init
|
Privilege: ANYUSER
|
Examples
For the first example, list all the files at the highest level of the disk.
total space : 819200 K bytes
free space : 700583 K bytes
Change to the SCT directory. List all files in the SCT directory, then list the files in the AXSM directory.
MGX8850.7.PXM.a > cd /SCT
total space : 819200 K bytes
free space : 660582 K bytes
MGX8850.7.PXM.a > ls AXSM
total space : 819200 K bytes
free space : 660582 K bytes
ping
Ping
Use ping to determine if a host is operational. The command causes the switch to send an ICMP packet to a destination address.
Cards on Which This Command Runs
PXM45
Syntax
ping <IP_Addr>
[<Num_Packets>]
Syntax Description
IP_Addr
|
IP address of the destination host in dotted decimal format.
|
Num_Packets
|
Number of packets, in the range 0-65535.
• 0=infinite
• 3=default
|
Related Commands
None
Attributes
Log: no log
|
State: active, standby
|
Privilege: ANYUSER
|
Example
Ping IP address 172.29.23.148.
MGX8850.7.PXM.a > ping 172.29.23.148
PING 172.29.23.148: 56 data bytes
64 bytes from 172.29.23.148: icmp_seq=0. time=0. ms
64 bytes from 172.29.23.148: icmp_seq=1. time=0. ms
64 bytes from 172.29.23.148: icmp_seq=2. time=0. ms
----172.29.23.148 PING Statistics----
3 packets transmitted, 3 packets received, 0% packet loss
round-trip (ms) min/avg/max = 0/0/0
pwd
Present Working Directory
Use pwd to identify the current working directory on the PXM45.
Cards on Which This Command Runs
PXM45
Syntax
pwd
Syntax Description
This command takes no parameters.
Related Commands
cd, rmdir, rm, ls, copy
Attributes
Log: no log
|
State: active, standby, init
|
Privilege: ANYUSER
|
Example
Identify the present working directory.
who
Who
Use who to see details about the user currently logged into a card. The information consists of the:
•
Type of port where you logged into the card
•
Slot number of the current card
•
Idle time in hours, minutes, and seconds
•
Current username
•
IP address of the device that accessed the card (not the IP address of the card or node)
Cards on Which This Command Runs
PXM45, AXSM, AXSM-E
Syntax
who
Syntax Description
This command takes no parameters.
Related Commands
adduser, deluser, whoami
Attributes
Log: no log
|
State: active, standby
|
Privilege: ANYUSER
|
Example
Display information about the user currently logged into the card.
Port Slot Idle UserId From
-------------------------------------------------------------
telnet.01 * 7 0:00:00 admin 171.71.25.240
whoami
Who Am I
View the current login ID, access level, and associated terminal port of the current user.
Cards on Which This Command Runs
PXM45, AXSM, AXSM-E
Syntax
whoami
Syntax Description
This command takes no parameters.
Related Commands
adduser, deluser, who
Attributes
Log: no log
|
State: active, standby
|
Privilege: ANYUSER
|
Example
Display information about the user of the current terminal session.