HP 3PAR InForm OS 3.1.1 Command Line Interface Reference

Typical Command Layout in this Book
Typical CLI reference pages are formatted similarly as the examples that follow:
COMMAND NAME
The section heading includes the name of the CLI command.
DESCRIPTION
This section describes the use or purpose of the command.
AUTHORITY
This section defines the user access required within the HP 3PAR Storage System to use the
command.
SUBCOMMANDS
This section indicates any necessary subcommands required to complete the use of the command.
SYNTAX
See Section (page 15).
OPTIONS
This section lists the available options you can use in conjunction with the command for varied
results. Some options and their specifiers are required, as indicated in the syntax, whereas some
are provided to increase the level and functionality of your output.
SPECIFIERS
Specifies a suggested input required by the user.
RESTRICTIONS
This section includes any restrictions that must be followed in order to achieve maximum results.
EXAMPLES
This section lists sample output with results similar to what you should expect when running the
command and it’s available options.
NOTES
Any pertinent information about the command that might help increase understanding and reliability
is often provided in the Notes section.
Global Options and Environment Variables
Several options and environment variables are available at the global level. For complete information
about these, refer to the InForm OS CLI Administrator’s Manual.
Exit Status
Except where noted, the following codes are returned indicating success or failure for each individual
command:
• 0 indicates that the command was successful.
• 1 indicates that the command failed.
18 CLI Command Syntax and Conventions