Using The Command-Line; Command Syntax; Command Conventions - D-Link 5000 Series Cli Reference Manual

5000 Series Layer 2/3 Managed Data Center Switch CLI Reference Guide
2.

Using the Command-Line

The command-line interface (CLI) constitutes a text-based means by which to monitor and manage the
system. The CLI can be accessed by the use of a direct serial connection or through the used of a remote
logical connection via telnet or SSH.

Command Syntax

A command consists of one or more words. A given command may or may not be followed by one or
more parameters, as parameters may be required or optional depending on the command being used.
For example, the commands
commands, such as
parameter values must be typed in a specific order, with any optional parameters following any required
parameters. The following example illustrates the command syntax for the
network parms ipaddr netmask [gateway]
•
The term
•
The terms
be entered after the command itself are entered.
•
The term
entered in place of the parameter.
Each command is listed by the command name in the CLI Command Reference, which also provides a
brief description of each command.
The command keywords and the associated required and optional parameters are shown under Format.
The command mode used must be in to access the command is indicated under Mode.
The default value for a configurable setting on the device, if any, is indicated by Default.
Furthermore, the information that a given command shows is described by the

Command Conventions

For a given command, the parameters used may include mandatory values, optional values, or keyword
choices. Such parameters follow a prescribed order.
to distinguish between value types.
Table 1: Parameter Conventions
Symbol
[] Brackets
Italic font in a parameter
{} Braces
| Vertical bars
[{}] Braces within brackets
and
network
parms, require that a value is included after the command. Such
network
is the name of the command itself.
network parms
and
ipaddr netmask
is an optional parameter, meaning that it is not required that a value be
[gateway]
Example
[value]
or
value [value]
{choice1 | choice2}
choice1 | choice2
[{choicel | choice2}]
do not require parameters, whereas other
clear vlan
are parameters and are examples of required values that must
Table 1 explains the conventions used in this guide
Description
Denotes an optional parameter.
Denotes a variable value. You must
substitute the italicized text and brackets
with an appropriate value, such as a name
or number.
Indicates a parameter selection option.
Separates mutually exclusive choices.
Denotes a choice within an optional
8
command:
network parms
command.
show