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

Table of Contents

Basic Commands

Basic Commands

The user interface commands let you access an IGX or BPX system through the control terminal. These commands provide help on how to use the commands, display the twelve most recent commands entered into the system, connect to another node, and sign you off. These commands also give you a way to clear, print, or redraw the screen. 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.

Getting Help

Entering help or ? displays command information. The help command gives you access to a general help menu or to information on a specific command. To access the general help menu, enter either help or ?. Either of these commands displays the command category menu on the screen and prompts you to make a selection. Use the arrow keys to move the cursor to the correct category, then press the Return key.

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. Entering help or ? followed by a character string displays all those commands containing the character string. For example, for a list of all commands that contain the string "fr," enter the following:

  ? fr

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. 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.) For information on access privileges and passwords, refer to "Managing the Network". 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

Use the Clear Terminal Screen (clrscrn) to clear the screen. Use the Redraw Terminal Screen (redscrn) command to clear and redraw the screen. 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 the screen, enter clrscrn.

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

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.

List of Basic Commands

Table 2-1 lists the commands discussed in the previous sections. Descriptions of these commands make up the rest of this chapter.


Table 2-1: List of Basic Commands
Mnemonic Description Page

.

Display command history

2-3

help or ?

Help

2-5

bye

End user session

2-8

clrscrn

Clear screen

2-10

prtscrn

Print screen

2-11

redscrn

Redraw screen

2-12

vt

Make a virtual terminal connection

2-13

. (a period)

Displays the twelve (12) most recently used commands. To re-use one of these commands, enter the associated number. The command appears on the command entry line, where you can re-enter or re-execute a command. Editing in this case means back-spacing through the command's arguments and typing in a new value or backspacing without typing a new value to restart the command at the cursor position.

Full Name

Display command history

Syntax

. (A period)

Related Commands

None

Attributes

Privilege Jobs Log Node Lock

1-6

No

No

IGX, BPX

No

Example 1

. (A period)

Description

Display the command history.

System Response
gamma TRM YourID:1 IGX 8420 9.2 Aug. 15 1998 13:47 CST Command history 12: dspcons 11: vt beta 10: dspcons
9: addcon 6.4 alpha 6.4 (.6
8: addcon 8.1.200 alpha 9.1.300 1
7: upfrport 8.1.200
6: dntrk 14
5: uptrk addjob
4: addjob
3: dspjobs
2: addjob
1: dspjobs Last Command: . Next Command:

help or ?

Displays a help menu. This command accesses the help routine in the system software. It provides:

A more extensive, menu-driven, on-line help function exists within the WAN Manager NMS. Consult the Cisco WAN Manager Operations Guide for a complete description of the on-line help.

The ways to request help on commands are:

Full Name

Help command

Syntax

? or help

[command name | character string]

Related Commands

None

Attributes

Privilege Jobs Log Node Lock

1-6

No

No

IGX, BPX

No

Example 1

help

Description

Display the help menu. (Without an argument, the help command shows the command categories.)

System Response
switchnow TN SuperUser BPX 15 9.1 Oct. 1 1997 14:14 GMT All commands fall into one (or more) of the following categories: Control Terminal Configuration Lines Network Connections Cards Alarms and Failures Diagnostics Debug This Command: help Use cursor keys to select category and then hit the <RETURN> key:
Example 2

help dspbxmsloterrs

Description

Display the syntax and other information for Display BXM Slot Errors (dspbxmsloterrs).

System Response
switchwhat TN SuperUser BPX 15 9.1 Oct. 1 1997 14:16 GMT dspbxmsloterrs - Display BXM Slot Errors Cannot be included in Jobs. Usage: dspbxmsloterrs [slot] Last Command: help dspbxmsloterrs Next Command:
Example 3

help fr

Display all commands that contain the string "fr." (These are the Frame Relay commands.) A list of all commands containing the letters "fr" appears on screen. Scroll to a command then press Return to display the related help screen.


Table 2-2: help - Optional Parameter
Parameter Description

command

Specifies a command.

string

Specifies a character string as a search argument.

bye

Ends a local or remote terminal connection. With a local terminal connection, the bye command logs out the user. If a local terminal is inactive for a (default) period of 20 minutes, the connection is automatically broken. This is the equivalent of entering the bye command. With a remote terminal connection (vt), the bye command returns the terminal to the local node. After a (default) period of four minutes of inactivity, a remote terminal connection is automatically returned to a local connection. This is equivalent to entering the bye command.

Full Name

End user session

Syntax

bye

Related Commands

vt

Attributes

Privilege Jobs Log Node Lock

1-6

Yes

No

IGX, BPX

No

Example 1

bye

Description

End a current session from a local node. The local connection ends, and the initial sign-on prompt appears on the screen.

System Response
gamma TRM YourID:1 IGX 8420 9.2 Aug. 15 1998 13:47 CST Enter User ID:

clrscrn

Clears the terminal screen.

Full Name

Clear terminal screen

Syntax

clrscrn

Related Commands

redscrn, prtscrn

Attributes

Privilege Jobs Log Node Lock

1-6

Yes

No

IGX, BPX

No

Example 1

clrscrn

Description

Clear the screen.

System Response
pubsigx1 TN SuperUser IGX 8420 9.2 July 15 1998 22:49 GMT Last Command: clrscrn Next Command:

prtscrn

Prints the information on the screen at the time the command is entered.

Full Name

Print terminal screen

Syntax

prtscrn

Related Commands

clrscrn, redscrn

Attributes

Privilege Jobs Log Node Lock

1-6

Yes

No

IGX, BPX

Yes

Example 1

prtscrn

Description

Send the information on the screen to the printer.

System Response

All information on the terminal screen is printed. If printing is successful, no status message appears. If the printer is unavailable, an appropriate status message appears.

redscrn

Redraws the screen. This command can be useful for communication that involves a modem. If data has become corrupted and caused erroneous characters on the terminal screen, redscrn clears them.

Full Name

Redraw the terminal screen

Syntax

redscrn

Related Commands

clrscrn, prtscrn

Attributes

Privilege Jobs Log Node Lock

1-6

Yes

No

IGX, BPX

No

Example 1

redscrn

Description

Clear the terminal screen and redraw the valid screen information.

System Response

The current screen reappears without erroneous characters.

vt

Establishes a virtual terminal connection to a remote node. A virtual terminal connection has the following properties:

During a vt session, the remote node name and date flash on the local terminal screen, and "Virtual Terminal" appears in the lower left corner. The bye command terminates a virtual terminal session and returns the terminal to local usage. After a default timeout of four minutes of inactivity, a vt connection automatically reverts to a local connection. This timeout is the equivalent of using the bye command.

Full Name

Make a virtual connection

Syntax

vt <nodename>

Related Commands

bye

Attributes

Privilege Jobs Log Node Lock

1-6

Yes

No

IGX, BPX

No

Example 1

vt sw115

Description

Establish a virtual terminal connection to the switch named "sw115."

System Response
sw115 VT SuperUser BPX 15 9.1 July 15 1997 16:59 PDT Last Command: Next Command: Virtual Terminal CD
Table 2-3: vt - Parameter
Parameter Description

node name

Specifies the name of the remote node for the virtual terminal connection. If the specified node name is not valid, the returned message states that the "Node is unknown" and prompts for the correct node name. Also, the main area of the screen names the recognized nodes in the network to help determine the correct name.


hometocprevnextglossaryfeedbacksearchhelp
Posted: Fri Nov 8 07:07:45 PST 2002
All contents are Copyright © 1992--2002 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.