HP 3PAR OS 3.1.3 Command Line Interface Reference

1 CLI Command Syntax and Conventions
This chapter describes the command syntax for the HP 3PAR OS CLI commands listed in this
reference. General control commands that do not follow the syntax rules are also listed. As well
as glob-style patterns.
Syntax and Conventions
Most CLI commands use the following syntax.
cmd [subcmd] [options [arg]]... [<spec>...][<pattern>...]
Table 1 (page 11) Lists all syntax elements and provides their meanings:
Table 1 CLI Command Syntax
MeaningElement
Specifies an operation to be executed, such as create,
move, or show .
cmd
Specifies a subcommand. Subcommands specify actions
for commands to be executed.
subcmd
Indicates an optional command line element such as histch
–rw .
options
Indicates a specific variable of an option or subcommand.
The argument is often used to identify a specific node,
volume, or disk.
arg
Indicates a specifier used with a required command line
element such as the command or option.
spec
Specifies that only one of the command specifiers or options
separated by this character can be specified at a time.
|
Indicates grouped elements. Do not type the braces; type
only the information inside the braces.
{}
Indicates optional elements. Do not type the brackets; type
only the information inside the brackets.
[ ]
Indicates user-supplied input.< >
Indicates that a specifier or an option can be used more
than once in a command.
...
Syntax Rules
The command syntax described in the table above obeys the following rules:
• All command line elements are in lowercase letters, except where indicated in this reference.
• Subcommands immediately follow the commands they modify.
• Options, as indicated in this guide, are indicated by one or more letters, are preceded by a
hyphen, and are enclosed in brackets (for example: removealert [–a]).
• Options follow subcommands on the command line and precede any specifier.
• An argument must directly follow the option or subcommand it is modifying and is required
on the command line, unless otherwise specified (for example: removealert –i
<alert_ID>).
• Multiple options and arguments on a command line are separated with a space.
• Specifiers follow options.
Syntax and Conventions 11