NEXT INDEX

Avici Systems Inc.

Preface

The IPriori CLI Reference consists of three volumes:

Audience

This document is written for experienced central office system managers who are familiar with routers, routing protocols, and industry standard router configuration.

Document Organization

This document is organized into the following chapters:

"General Commands"

Navigation, terminal setup, and user-interface commands.

"Configuration and File Management Commands"

Move and manage configuration files, set the default configuration device, boot the system using a specified configuration file, and display the contents of various configuration files and directories.

"System Administration Commands"

Configure logging, set the clock, and manage access control to the server.

"Interface Commands"

Configure, manage and monitor interfaces and Composite Links.

"SONET/SDH Commands"

Configure, manage and display Packet Over SONET/SDH (POS) interfaces.

"AAA and SSH Commands"

Configure AAA and SSH security services.

"SNMP Commands"

Configure the SNMP agent.

"Central Office Alarms Commands"

Test, silence and display status of central office alarms.

"Remote Monitor Commands"

Enable and disable remote monitor, configure log size, create and display events and alarms for remote monitor.

"Fabric Commands"

Configure fabric version on the Avici router.

"Logging Commands"

Configure logging services.

"Debug Protocol Commands"

Display protocol specific information to the console or telnet session, or to the log.

Using the Command Reference

The IPriori CLI Reference provides detailed information about the commands on the Avici router. Information within each chapter is organized alphabetically by command name.

Each reference page contains the name of the command followed by a short summary of what the command does.

The Syntax section contains a complete syntax of that command. Refer to the "Typographical and Keying Convention" section for more information on the meaning of these syntax statements. Each Syntax section also contains a detailed description of any user-supplied variables used in the command syntax.

The Description section describes the command in detail, including any restrictions or required order for use of the command.

The Examples section provides examples of the command's usage on the command line. Wherever possible, the context of the command is given by preceding it with commands that would be required before the command can be issued. Appropriate prompts are also included for each command. Refer to the IPriori Software Configuration Guide for more information on navigation in the CLI and command modes.

The Related Commands section provides references to other commands.

Typographical and Keying Convention

This document uses the following conventions when presenting the syntax of a command:

bold

Command or keyword; you must enter this value as specified.

italics

Command variable; you must supply a value.

[ ]

The item(s) inside the brackets is optional; you can include it, or not, when entering the command.

If a series is specified (x1 ... x6), you can include none, one, or more of the listed keywords or variables; if you include more than one, they must be separated by spaces.

[ | ]

The items inside the brackets are optional; you can include none or one of the listed keywords or variables.

{ | }

One, and only one, item inside the braces is required. You must specify one of the listed items.

file.ext

File names must begin with an alphabetic character and may include alphabetic characters, digits, underscores (_), or dashes (-). A dot (.) separates the file name from its extensions. One or more extension (ext), which must consist of alphabetic characters, digits, underscores, or dashes, must be specified.
monospace font

Text displayed by the IPriori CLI in response to commands you enter, or a CLI prompt.
monospace bold

Commands you enter in response to a CLI prompt.

.
.
.

Vertical ellipsis. Indicates that a portion of the code example or configuration file is not relevant to the example.

Support Services

To obtain information on customer service and training, there are three ways to contact Avici Customer Service:

NEXT INDEX

Copyright © 2005 Avici Systems Inc.
Avici® and TSR® is a registered trademark of Avici Systems Inc.
IPriori™, Composite Links™, SSR™, QSR, and NSR® are trademarks of Avici Systems Inc.

   Source File Name: preface.fm
    HTML File Name: preface.html
    Last Updated: 02/25/05 at 14:25:20

Please email suggestions and comments to: doc@avici.com