Cli Command Conventions - Cisco 300 Series Cli Manual

Small business 300 series managed switches command line interface guide release 1.3

Table of Contents

Introduction

CLI Command Conventions

78-21075-01 Command Line Interface Reference Guide

When entering commands there are certain command entry standards that apply

to all commands. The following table describes the command conventions.

Screen Display

In a command line, square brackets indicate an optional entry.

In a command line, curly brackets indicate a selection of

compulsory parameters separated the | character. One option must

be selected. For example, flowcontrol {auto|on|off} means that for

the flowcontrol command, either auto, on, or off must be selected.

Italic text indicates a parameter.

Names of keys to be pressed are shown in bold.

Keys separated by the + character are to be pressed

simultaneously on the keyboard

Fixed-width font indicates CLI prompts, CLI commands entered by

the user, and system messages displayed on the console.

When a parameter is required to define a range of ports or

parameters and all is an option, the default for the command is all

when no parameters are defined. For example, the command

interface range port-channel has the option of either entering a

range of channels, or selecting all. When the command is entered

without a parameter, it automatically defaults to all.

When free text can be entered as a parameter for a command (for

example in command: snmp-server contact) if the text consists of

multiple words separated by blanks, the entire string must appear

in double quotes. For example: snmp-server contact "QA on floor 8"