This section discusses the objectives, audience, organization, and conventions of the Router Products Command Reference publication.
This publication provides an in-depth description of the commands necessary for configuring and maintaining your router. It describes tasks only in the context of using a particular command; it does not describe how the tasks interrelate or provide comprehensive configuration examples. It can be used as a standalone reference manual or in conjunction with the Router Products Configuration Guide. The various debug commands are not included in this publication. They can be found in the Debug Command Reference publication.
This publication is intended as a standalone document for experienced network administrators who will be configuring and maintaining routers and would like to reference commands. For less-experienced users who need to understand the tasks as well as the commands, it is intended as a companion guide to the Router Products Configuration Guide.
This publication is divided into six main parts. Each part comprises chapters describing related tasks or functions. The organization of parts and chapters in this publication matches the organization of parts and chapters in the Router Products Configuration Guide, except that this document contains appendixes. The parts in this publication are as follows:
- Part One, "Product Introduction," contains an overview of the router and command descriptions for the system user interface and command parser.
- Part Two, "System and Interface Configuration and Management," describes the commands pertaining to system interfaces, system booting, terminal session and asynchronous lines, and also describes EXEC commands.
- Part Three, "Wide-Area Networking," describes the commands pertaining to X.25, Frame Relay, SMDS, and dial-on-demand routing.
- Part Four, "Routing Protocols," contains chapters that describe the commands used to configure each network protocol that we support. These protocols include Apollo Domain, AppleTalk, Banyan VINES, DECnet, Internet Protocol (IP), ISO Connectionless Network Services (CLNS), Novell IPX, and Xerox XNS (including Ungermann-Bass and 3Com). The chapters are arranged in alphabetical order for ease of use. The routing protocol commands, including IGRP, BGP, RIP, OSPF, IS-IS, and ISO-IGRP also are discussed.
- Part Five, "Bridging," contains chapters that describe the commands used to configure transparent bridging, source-route bridging, source-route transparent (SRT) bridging, and source-route transparent/translational bridging (SR/TLB) on our routers/bridges.
- Part Six, "IBM Networking," contains chapters that describe the commands used to configure the SDLC transport and serial tunneling mechanisms in an IBM local-area network. Included also are the commands for the Local Acknowledgment feature, managing your source-route bridges with LAN Network Manager, and SDLLC, our solution to translating between IBM's SDLC data link protocol for serial lines and ISO's LLC2 data link protocol for Token Ring networks.
The Appendixes Part contains a list of references and recommended reading, Ethernet type codes, regular expressions, a table of the ASCII character set, a list of the Cisco 7000 processors as they relate to the modular products interface cards, and a description of features supported.
Software and hardware documentation uses the following conventions:
- The symbol ^ or Ctrl represent the key labeled Control. For example, the key combination ^D or Ctrl-D means hold down the Control key while you press the D key. Keys are indicated in capitals, but are not case sensitive.
- A string is defined as a nonquoted set of characters. For example, when setting up a community string for SNMP to "public," do not use quotes around the string, or the string will include the quotation marks.
Command descriptions use these conventions:
- Commands and keywords are in boldface font.
- Arguments for which you supply values are in italic font.
- Elements in square brackets ([ ]) are optional.
- Alternative but required keywords are grouped in braces ({ }) and separated by vertical bars (|).
Examples use these conventions:
- Examples that contain system prompts denote interactive sessions, indicating that the user enters commands at the prompt. The system prompt indicates the current command mode. For example, the prompt
router(config)# indicates global configuration mode.
- Terminal sessions and information the system displays are in
screen font.
- Information you enter is in
boldface screen font.
- Nonprinting characters, such as passwords, are in angle brackets (< >).
- Default responses to system prompts are in square brackets ([ ]).
- Exclamation points (!) at the beginning of a line indicate a comment line. They are also displayed by the router for certain processes.
 | Caution Means reader be careful. You are capable of doing something that might result in equipment damage or loss of data. |
Note Means
reader take note. Notes contain helpful suggestions or references to materials not contained in this manual.
The following illustration explains the fields on a typical command reference page:
