Quantum DXi-Series Command Line Interface (CLI) Guide
6-67081-05 Rev B
April 2012
CLI Syntax Conventions
3
CLI Syntax Conventions
The CLI program is named
syscli
. It is usually invoked with parameters necessary
to carry out a predefined task. The first parameter is usually a verb indicating the
action to be performed and hence is called a command. A number of
commands specify the command type (known as subcommand) or the object
upon which the command will operate.The syntax of each CLI is listed in each
section.
The syntax for all
syscli
commands falls into one of the following two formats:
• syscli --cmd --option1 <value1> --option2 <value2> ...
• syscli --cmd subcmd --option1 <value1> --option2 <value2> ...
where
•
cmd
can be:
list
,
add
,
edit
,
del
,
deleteall
, ...
•
subcmd
can be:
share
,
storageserver
,
lsu
, ...
The following are the syntax conventions for the tokens on the command line.
• All tokens prefixed with double dash “
--
” are defined as options.
• All tokens that have no double dash are defined as values of the preceding
options.
• An option can be by itself or followed by a value.
• The first option is also known as the command. It is usually a verb such as
list
,
add
,
del
,
edit
, ...
• If the first option has a value, this value is also known as the object (or
subcommand) upon which the command operates. The object is usually a
noun such as
share
,
storageserver
, ...
• An option value specified within the angle brackets “< >” means it is to be
replaced by an appropriate value. Without the angle brackets, the value is
literal text and must be entered exactly as is. For example, the command
syscli --del share --name <share_name>
has two options
--del
and
--name
, one literal value,
share
, and one
appropriate value, <
share_name
>.
• Options or values specified between square brackets “[ ]” are optional. If an
option and/or value is not specified, the CLI provides a default value for it.
• The pipe character “|” indicates that only one of the possible option names
or values must be specified. This is like an OR symbol.
• Options enclosed within parentheses “( )” mean one or more instances of
them must be specified. For example, the command
syscli --add sanclientgroup ... (--device <device_serial_ number> --lun
<desired_LUN>)
requires that one or more pairs of devices and luns must be specified.
• If a command requires a
--password
option and you do not specify it on the
command line, the
syscli
program will prompt for the password and will
not echo the response on screen for security purposes.
