About This Manual

This manual describes the user commands for Release 8.4 of Cisco WAN switch system software. These commands configure, monitor, and manage a network consisting of IPX, IGX, or BPX nodes. (For descriptions of the super user commands, refer to the manual titled Cisco WAN Switching SuperUser Command Reference.) Each chapter pertains to a particular aspect of Cisco WAN switch network usage. For example, Chapter 5, "Setting Up Trunks" contains the commands that apply to setting up and configuring trunks in the network (except for trunks between an MGX 8220 shelf and a BPX). Some commands apply to more than one category. The addcon command is an example of this. Several chapters contain descriptions of addcon usage. The locations of each single and multi-application command appear in Appendix A. This appendix contains a quick-reference, alphabetical listing of commands and with page numbers. The following list describes each chapter:

About This Manual	Introduction to this manual and the layout of the command definitions.
IPX, IGX, and BPX Fundamentals	Information on how to use the control terminal and enter commands.
Basic Commands	Commands that provide an interface between the user and the network. Examples are Clear Screen and Add a User.
Setting Up Network Nodes	Commands that display and set up node configurations. Examples are Add Alarm Slot and Configure Node Name.
Setting Up Trunks	Commands that set up and display the network trunks, interface shelves, and topology. Examples are Configure Trunk and Display Network.
Setting Up Lines	Commands that set up and display circuit lines. Examples are Up Circuit Line and Configure Circuit Line.
Voice Connections	Commands that set up, configure, and display voice connections. Examples are Display Channel Dial Type Configuration and Configure Adaptive Voice.
Data Connections	Commands that set up, configure, and display data connections. Examples are Add Connection and Delete Connection.
Frame Relay Connections	Commands that set up, configure and display frame relay connections. Examples are Display Connections and Configure Frame Relay Port.
ATM Connections	Commands that set up, configure, and display ATM connections. Examples are Add Connection and Display Connection Class.
Optimizing Traffic Routing and Bandwidth	Commands that control the intra-node routing and trunk bandwidth allocation. An example command is Configure Class of Service.
Synchronizing Network Clocks	Commands that control the clocks and synchronization throughout the network. Examples are Clear Line Clock Alarm and Display Current Clock Source.
Managing Structured Networks	Commands that set up and display network domains and junction nodes. Examples are Display Domains and Display Junction Network.
Managing Jobs	Commands that define, start and stop jobs, and job triggers. Examples are Add Job and Delete Job Trigger.
Managing the Network	Commands for site administration of the IPX/IGX/ BPX network. Examples are Configure User Password and Configure Time.
Troubleshooting Commands	Commands associated with troubleshooting aids such as alarms and loopbacks. Examples are Add Alarm Slot and Configure Trunk Alarm.
Command Listing	Alphabetical listing of commands shows the chapter and page number of the command description. This includes multiple listings, in which case the description appears in more than one chapter because of its application.

Chapter Organization

Each chapter includes an introduction to the function of the commands and a list of the commands in that chapter. Chapters consist primarily of command descriptions. Command descriptions appear in alphabetical order. Several chapters include flow charts to illustrate how commands contribute to a larger task, such as bringing up a circuit line.

Each command description begins with the command name and a functional description. Summaries for the command and its mandatory and optional parameters follow the functional description. The summaries are in table format. The following contains a description for each part of the command summary:

Tables

Description

Command Summary

Contains general information about a command. Information includes:

full name
syntax (including required parameters and optional parameters, if any)
related commands
attributes, such as user privilege required and whether the command can be part of a job
example usage with screens

The syntax field indicates whether the command requires parameters or optional parameters. If required, the Parameter and Optional Parameter summaries follow the Command summary. Upon command entry at the control terminal, the system usually prompts for individual parameters. Use the Parameter and Optional Parameter summaries to determine which values to enter.

Parameters

Provides all the parameters required to execute the command (included only if noted in the syntax field of the Command Summary table).

Optional Parameters

Provides all the optional parameters that can be used when executing the command (included only if noted in the syntax field of the Command Summary table).

Table of Contents