cc/td/doc/product/wanbu/bpx8600/9_3_2
hometocprevnextglossaryfeedbacksearchhelp
PDF

Table of Contents

Command Line Fundamentals

Command Line Fundamentals

A workstation, terminal, or personal computer can function as a control terminal for an IGX or BPX node through an EIA/TIA-232 link or over an Ethernet TCP/IP LAN. All command input takes place at the terminal, and all displays appear on the terminal screen. Through displays that show status, alarm, or statistics, the terminal constantly provides a view of an individual node, a trunk, a connection, or the entire network.

The control terminal gives you the ability to control the network from any routing node. A remote access command is available for controlling the network from a node other than the node physically connected to the terminal. This command is the Virtual Terminal (vt) command. The vt command creates a communication channel for the operator to a remote node. After you access a node by using vt, you can begin executing commands at the accessed node. Most commands and tasks that you can execute at the local node are also executable at a remote node.

The WAN Manager Network Management Station provides network management capabilities for multinode networks. WAN Manager also collects and displays statistics. For access, WAN Manager operates in LAN mode or telnet mode. (As of Release 8.0, you can no longer access a node through the serial port.) Refer to the Cisco WAN Manager Operations Manual for more information.

The User Command Screen Layout

After the node receives power and correctly starts up, the terminal screen appears as shown below. If the screen is blank or does not display the initial screen, check all connections to the node, and make sure the terminal and node are receiving power. If the connections are correct, press the Delete key a few times or cycle the terminal power.

sw180 TN No User IGX 8420 9.3.g0 Oct. 20 2000 06:09 GMT Enter User ID:

The user command screen is divided into three areas:

All command screens eventually time out. This includes dynamically updated screens such as the display for the dspbob command. Furthermore, if sufficient time passes, you are logged out.

Entering a Command

This section describes how to enter a command for those who are unfamiliar with Cisco WAN switch equipment. It also describes the online help for the commands.

Each user command can have one or more access privilege levels (see Access Privileges). Entering a particular command is possible for a user at the same or higher privilege of the command. Each command definition in this manual shows the privilege or range of privileges for the command. Most commands are not case-sensitive.

When the Next Command prompt is at the bottom of the screen, the system is ready for a new command. Some commands, such as those for simply displaying information, do not require parameters. Display commands often have no required parameters but have one or more optional parameters for changing the scope of displayed information. Commands that require parameters usually prompt for each parameter.

To abort a command for any reason, press the Delete key. If you make a mistake or need to edit the command line, see To Edit a Typed Command.

The general syntax is command <parameter(s)> [optional parameter(s)]. When a command definition displays actual parameters, the required parameters appear within the arrow heads (< >). If the list of command parameters is too long, the command definition's "Syntax" field just shows "parameters," which means the parameters are available only in the parameters table for the definition. For information on the format of system resource numbering, see The Numbering of Trunks, Lines, and Channels.

Those unfamiliar with the system can use the online help feature to view the seven categories of commands and get syntax information on a command (see About Command Categories).

To enter a command from the menu:


Step 1   At the Next Command prompt, either press the Escape key or enter the word help or a question mark. A list of command categories appears as in the example below.

gamma TRM YourID:1 IGX 8420 9.3.20    Aug. 15 2000 13:47 CST All commands fall into one (or more) of the following categories: Control Terminal Configuration Lines Network Connections Cards Alarms and Failures This Command: ? Use cursor keys to select category and then hit <RETURN> key:

Step 2   Use the up/down arrow keys to select a command category, then press Return. A list of all the commands in that category appears. (The next example is from the "line" category of commands.)

Step 3   Use the cursor key to select the command you want to enter (dsptrks for example), then press Return. The selected command appears on the screen, and the system prompts you for any additional parameters needed to complete the command.


Figure 1-1: Entering a Command



A faster way to enter a command, using fewer keystrokes, is to enter the command on the command line, then press the Return key. The system prompts you for any additional parameters required to complete the command.

The fastest way to enter a command, using the fewest keystrokes, requires that you know the command along with the necessary parameters. Enter the command name and all of the required parameters in the correct format, then press the Return key.

About Command Categories

The command category menu is displayed when you press the Escape or ? or Help key. The commands are organized into seven categories. (These categories are not the categories used to organize this manual.) Table 1-1 lists and describes the command categories.


Table 1-1: Command Categories
Category Command functions

Control Terminal

Configure your password, serial port and printer functions, use the help facility, establish virtual terminal connections, and create and edit jobs.

Configuration network and line timing

Configure voice and data channels. Display network configuration.

Lines

Activate and deactivate lines. Display line status.

Network

Add and delete trunks, configure a node name. Display and print network status.

Connections

Add, delete, and display circuit (voice and data) and FastPacket data channel connections. Configure network routing and connection characteristics (Frame Relay and ATM). Perform connection.

Cards

Activate, deactivate, and reset printed circuit cards. Display power supply status.

Alarms and Failures

Display, print, and clear alarms, errors, and network history. Configure alarm thresholds.

Aborting a Command

To abort any command, press Delete

On terminals without a Delete key, you might need to press Shift-Backspace or other keys to perform the Delete function.

The Next Command: prompt appears at the bottom of the screen indicating that you can enter another command. The command you aborted appears in low intensity letters on the screen after the Last Command: prompt.

Command Shortcuts

When you enter a command, it is displayed next to the Last Command: prompt at the bottom of the screen. To copy the command to the new command line, press the Ctrl and A keys simultaneously.

To execute the previous command:

For example, to repeat the dspcons command:

Last Command: dspcons

Next Command: !dsp

Press the Return key. You can use the Display Command History (.) command to display the 12 most recently executed commands:


Step 1   Type . (a period) and press Return. A numbered list of commands displays. In the following example, the most recently executed command is number 1.

12:
11:
10:
9:
8:
7: prtscrn
6: addcon 12.1 alpha 12.1 v
5: delcon 12.1
4: cnfport a 1200 n 8 1 x x n
3: cnftime 17 19 34
2: redscrn
1: help

Step 2   Type the number of the command you want to re-execute, then press the Return key. The command is displayed after the Next Command: prompt. Press the Return key to execute the command, or edit the command line and then press the Return key. Whenever you end a terminal session by signing off (with the bye command), the command list is cleared.


To Edit a Typed Command

Before you press Return, you can use control keys to edit a typed command. Table 1-2 lists the control key to edit information on the command line. Not all terminals have the same key characters. If the exact key is not available, determine which alternate key performs the function.


Table 1-2: Keys for Editing the Command Line
Function Keys Cursor Movement

Move the cursor

Ctrl-B

Moves the cursor left one word.

Ctrl-F

Moves the cursor right one word.

Ctrl-L

Moves the cursor right one character.

Ctrl-G

Moves the cursor left one character.

Arrows

Moves the cursor in the direction of the arrow.

Delete

Ctrl-W

Deletes a character.

CHAR DEL

Deletes a character.

Ctrl-H

Moves the cursor left one character and deletes that character.

Ctrl-D

Deletes all characters from the cursor position to the end of the line.

Ctrl-X

Deletes a line.

BACKSPACE

Moves the cursor left one character and deletes that character.

Insert

Ctrl-I

Toggles insert mode.

TAB

Toggles insert mode.

CHAR INSERT

Toggles insert mode.

Ctrl-^

Inserts line.

Miscellaneous

*

Leaves the data in this field as it is displayed and goes to the next field.

DELETE

Aborts command.

Ctrl-M

Carriage return.

RETURN

Carriage return.

Ctrl-S

Stops the data flow from the node to the terminal screen.

Ctrl-Q

Restarts the flow of data from the IGX.

Ctrl-A

Copies the last command line.

! (..)

(The exclamation mark followed by the first characters or character of a command, brings that command back to the command line.)

Access Privileges

Access to the commands is password protected. To access the commands, type your user ID and user password at the log-in prompts. Each user is assigned a privilege level by the System Manager that determines which commands you can use.

The six user privilege levels follow this basic convention:

Level 0 is the SuperUser access level permitting use of SuperUser commands. See SuperUser Commands. SuperUser commands are identified in the Attributes table of the command definition.

Level 1 has access to all the commands.

Level 6 has access to the fewest commands.

A given privilege level has access to all levels below it. For example, level 3 has access to levels 3 through 6. The privilege level for each command is part of the command summary.

Help

The system software provides a help function for commands. The help command gives you access to a general help menu or to information on a specific command.

To access the Command Category menu, enter either help or ?.

Either of these commands displays the Command Category menu listing all commands and command syntax. You are prompted to make a selection. Use the arrow keys to move the cursor to the correct category, then press the Return key.

The Command Category Menu:

For information on a specific command, enter help or ? followed by a command name. For example, enter the following for information on adding a trunk:

help addtrk

Press Return to display the information.

Enter help or ? followed by a character string to display all those commands containing the character string. For example, for a list of all commands that contain the string "fr," enter the following:

? fr

You can then select a particular command from this list for help information.

The Online Help feature of WAN Manager provides more detailed command information. Hypertext links allow you to navigate through command category lists, alphabetical indexes, and the command descriptions. Refer to the Cisco WAN Manager Operations manual for more information.

About Command Names

Most of the command names use the convention of a descriptive verb and noun. For example, the addcon command adds a connection, the delcon command deletes a connection, and the dspcon command displays information about a connection. Table 1-3 lists the command-related abbreviations.


Table 1-3: Command-Related Abbreviations
Format Mnemonic Descriptor

Verb

add

Add

bye

Bye

clr

Clear

cnf

Configure

cpy

Copy

del

Delete

dn

Down

dsp

Display

edit

Edit

grp

Group

help

Help

prt

Print

red

Redraw

reset

Reset

run

Run

stop

Stop

switch

Switch

tst

Test

Noun

adv

Adaptive voice

ait

AIT

alm(s)

Alarms

bob

Breakout box

bus(es)

Bus(es)

cd(s)

Card(s)

ch

Channel

clk

Clock

cln(s)

Circuit line(s)

cls

Class

cnf

Configuration

con(s)

Connection(s)

congrp

Connection group

cond

Conditioning

cos

Class of service (COS)

d

Data

date

Date

dfm

DFM

dial

Dial

dl

Dial type

eia

EIA

errs

Errors

extlp

External loop

fp

FastPAD

fr

Frame Relay

ftc

FTC

func

Function

gn

Gain insertion

grp(s)

Group(s)

ict

Interface control template

Nouns (continued)

ip

IP

job(s)

Job(s)

lcn

Logical connection

ln(s)

Line(s)

load

Load

loclp

Local loop

log

Log

mc

Multicast

msg

Message

name

Name

nw

Network

ospace

Open space

parm(s)

Parameter(s)

port

Port

pref

Preference

prt

Printer

pwr

Power

rcv

Receiver

red

Redundant

rmtlp

Remote loop

rts

Routes

scr

Screen

seg

Segment

sig

Signal

slot

Slot

snmp

SNMP

src(s)

Source(s)

st

Status

stats

Statistics

stby

Standby

sys

System

term

Terminal

tmzn

Time zone

tp

Type

trig

Trigger

trk(s)

Trunk(s)

Nouns (continued)

user

User

utl

Utilization

xmt

Transmit

yred

Y-cable redundancy

The Numbering of Trunks, Lines, and Channels

The information contained in this manual allows you to set up, configure, and maintain traffic on trunks and lines. Table 1-4 lists the format conventions for the names of trunks, lines, and channels.


Table 1-4: Formats of System Resource Names
Trunk, line, or channel Description

CDP/CVM Circuit Line and
NTC/NTM Trunk

The number assigned to a CDP or CVM line (CLN) or an NTC or NTM trunk (TRK) is the slot number of the BC-T1 or BC-E1 back card in the physical slot where the CLN or TRK is connected to the IGX node. In the case of redundant pairs, it is the slot associated with the primary back card.

AIT Trunk

The number assigned to the backslot of the BC-T3 or BC-E3 back card.

BPX Trunk Numbers

The number assigned to a BPX trunk (TRK) is the backslot number and port (1 - 3) of the BNI (slot.port; example, 2.1) card to which the T3 trunk cable is attached.

Voice Channel Numbers

A voice channel is specified by "SLOT.CH". Sets of voice channels are specified by "SLOT.CH-CH". The notation "SLOT" refers to the back slot number of a circuit line and "CH" refers to a channel (1-24 for T1 or 1-31 for E1). For example, "12.1" indicates channel 1 on circuit line 12, and "12.1-9" indicates channels 1-9 on circuit line 12.

Data Channel Numbers

Data channels are specified by "SLOT.PORT", where "SLOT" refers to the slot number of a data card, and "PORT" refers to a port on that data card. For example, "9.3" specifies port 3 on the data card in slot 9. The notation "9.1-4" refers to ports 1-4 on that card. The range of port numbers is from 1 to 4 for SDI and DDS data cards. An appended "a", for example; 11.1-5a, indicates the channels are configured to use the super-rate alternating channel feature.

Frame Relay channel
numbers (local addressing)

In the local addressing convention, Frame Relay channels are specified by "SLOT.PORT.DLCI", where "SLOT" refers to the slot number of an FRP, "PORT" refers to a port on the FRP card, and "DLCI" is the local data link connection identifier. The range of port numbers is from 1 to 4. For example, the following addcon command at node alpha:

addcon 6.1.101 beta 4.1.102 2

The command adds a connection between alpha and beta. The user device at alpha refers to this connection using the local DLCI of 101. The user device at beta refers to this connection using the local DLCI of 102. The DLCIs have local significance only. With local addressing, the same DLCI can be used again, but not for more than one destination from the same port. For example, the following adds another connection from alpha port 6.1:

addcon 6.1.100 gamma 6.2.102 2

In this case, a DLCI of 100 is used at alpha. A DLCI of 102 can be used at gamma as well as at beta, because the DLCIs have only local significance.

Frame Relay channel numbers (Global Addressing)

In the global addressing, the format for Frame Relay channel specification is "SLOT.PORT.DLCI." However, each FRP or FRM port (and associated user device) is identified by a unique DLCI. No two ports in the network can have the same DLCI. For example, alpha port 6.1, gamma port 6.2, and beta port 4.1 could be assigned unique DLCIs of 79, 80, and 81 when adding connections, as in the following example:

addcon 6.1.80 gamma 6.2.79 2 (at alpha)
addcon 6.1.81 beta 4.1.79 1 (at alpha)
addcon 4.1.80 gamma 6.2.81 5 (at beta)


The user device at alpha refers to the connection between alpha and gamma, using the DLCI of 80 assigned to gamma. The user device at gamma refers to this connection using the DLCI of 79 assigned to alpha. The user device at alpha refers to the connection between alpha and beta using the DLCI of 81 assigned to beta. The user device at beta refers to this connection using the DLCI of 79 assigned to alpha. The user device at beta refers to the connection between beta and gamma using the DLCI of 80 assigned to gamma. The user device at gamma refers to this connection using the DLCI of 81 assigned to beta.

For information on adding Frame Relay connections through a FastPAD, refer to the command descriptions in the online version of the 8.2 FastPAD User's Guide.

User Interface Commands

The user interface commands:

These commands are all simple to use and have no command parameters except the virtual terminal command (vt), in which you must specify the node name, and the help commands, in which you must enter a command character string.

See the section Basic User Interface Commands in Chapter 2 for a list of these commands linked to their full command definitions.

Signing On

Signing on to the system is a two-step process requiring you to enter both a User ID and a password. The system administrator can provide a User ID and password for the network. Only the system administrator can assign and change User IDs. Once a password is assigned, you can change your own password. For security reasons, users should periodically change their passwords.

Note: User ID and passwords are case-sensitive.

When the following prompt appears at the bottom of the initial screen, the system is ready for you to log in:

Enter User ID:

Entering a User ID and password gives access at a particular level of user privilege. (Each command has one or more levels of associated user privilege.) User IDs can have up to twelve (12) characters. At the prompt, enter the User ID. The system responds with the following prompt:

Enter Password:

When you initially sign on, enter the password. (The password does not appear on the screen.) Upon receiving the correct User ID and password, the log-in is recorded by the event log, and the screen displays the following prompt:

Next Command:

The system is ready to receive commands.

Logging Out

To log out, enter bye. When the terminal connection is local, this returns you to the initial screen.

To log out completely from a remote (virtual terminal) session, enter bye twice.

Clearing and Redrawing the Screen

To clear the screen, use the Clear Terminal Screen (clrscrn). The clrscrn command clears any information displayed in the top portion of the screen. This information could consist of status displays on lines and connections or Help text.

To clear and redraw the screen, use the Redraw Terminal Screen (redscrn) command. The redscrn command redraws the screen and updates the status lines. To make sure the status lines have been updated, enter the redscrn command. For example, to redraw a screen's display with the latest statistics before printing the screen, enter redscrn.

Printing Screens

Use the Print Terminal Screen (prtscrn) command prints the current screen display. Verify that the node printer is correctly configured before attempting to print a screen. Upon entering the prtscrn command, the screen display goes to either a local or remote printer. To print all the information in a screen, enter prtscrn.

Accessing Physically Remote Nodes

The Make Virtual Terminal Connection (vt) command establishes a virtual terminal connection to a remote node. Once the connection is established, entering and executing commands takes place as if the terminal were the local terminal on the remote node. The vt command lets network configuration take place from a central site. The only command that cannot run remotely is the vt command itself.

The privilege of user commands available through a vt connection is the same as that of the user who logged into a node with vt. To establish a virtual terminal connection with a remote node, enter vt and the name of the node name. For example, to vt to node "alpha," enter:

vt alpha

The words Virtual Terminal appear on the screen at the lower left corner to indicate that a virtual terminal connection exists. The remote node name appears at the upper left corner of the screen. To terminate the virtual terminal connection and return to your local terminal connection, enter the bye command.

The bye command has two separate functions:

To log out of the system during a remote (vt) session, enter the bye command twice. Note that after a default period of four minutes of inactivity, the vt session automatically ends, and the connection reverts back to being local. The timeout is configurable.

If the multiple vt feature has been purchased, multiple users can log into a node with the vt command. Cisco personnel must activate this feature.


hometocprevnextglossaryfeedbacksearchhelp
Posted: Thu Aug 1 15:39:38 PDT 2002
All contents are Copyright © 1992--2002 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.