Notation; Position-Dependent And Keyword-Driven Parameters; Command Entry; Contents Of A Command Description - Cisco MGX 8850 Command Reference Manual

Chapter 1 Command Line Interface Overview

Notation

The notation for command and argument parameters follows:
•
•
•
•
•
•

Position-Dependent and Keyword-Driven Parameters

A command can include parameters that are keyword-driven or position-dependent.
For position-dependent parameters, you must type parameters in the order they appear in the syntax
description or on-line help. To create a logical port, for example, the position-dependent syntax is:
addport <ifNum> <bay.line> <guaranteedRate> <maxrate> <sctID> <ifType> [vpi]
For a keyword-driven parameter, a keyword must precede the value. The keyword is preceded by a dash
and followed by the parameter (–timeout <secs>, for example). The order you enter keyword-driven
parameters does not matter—although any preceding or succeeding, position-dependent parameters
must appear as they do in the command syntax description.
In the following syntax example, the command is to delete more than one connection at a time. The
mandatory, position-dependent connection identifier consist of a logical port (ifNum) and the VPI and
VCI of the first connection to delete. After the connection identifier, the line shows two optional,
keyword-driven parameters. These keyword-driven parameters let you enter the number of connections
to delete and specify verbose mode:
delcons <ifNum> <vpi> <vci> [-num <num. conns to del>] [-verbose < 1 | 0 >]

Command Entry

When you enter a command with the current version of the product, you must type all intended
arguments before you press the Return key or Enter key.
If you press the Return key or Enter key with incorrect parameters or no parameters (if the command
requires parameters), a message displays the syntax and parameter ranges. The returned message may
also suggest what the problem is. For example, the message may warn of too few parameters. No error
messages or warnings appear until you complete the command.

Contents of a Command Description

Each command description contains:
•
•
Release 2.0, Part Number 78-10467-04 Rev C0, October 2001
Commands and their parameters are separated by a space.
Variables appear in italics.
Keywords and commands appear in bold.
Required arguments appear within left and right arrowheads ("< >").
Optional parameters appear within square brackets ("[ ]").
A vertical bar ( | ) represents the logical OR function.
An introductory paragraph that explains the function of the command. Additional paragraphs
elaborate on the functionality as needed.
A list of cards on the CLI of which you can execute the command.
Contents of a Command Description
Cisco MGX 8850 Routing Switch Command Reference
1-3