Syntax - HP StoreVirtual 4000 User Manual

Syntax

CLIQ is the command-line interface (CLI) for the HP LeftHand Storage Solution. The CLI specifies parameters
in the form parameter=<parameter> (specification), rather than dictating a particular order (positional)
notation.
Parameter ordering
Ordering of parameters is not specified. Any order will do. For example:
cliq deleteVolume volumeName=theVolume userName=user passWord=secret
login=10.1.2.3
is equivalent to
cliq deleteVolume login=10.1.2.3 passWord=secret userName=user
volumeName=theVolume
The method parameter may be optionally specified as "method=<command>":
cliq userName=user passWord=secret login=10.1.2.3 volumeName=theVolume
method=deleteVolume
Parameter types
Each parameters has a given type indicating how to use it. The available types are:
• Required - the parameter must be included for the command to execute
• Optional - the parameter can be included but is not necessary for the command to execute
• Conditional - A combination of conditional parameters must be included for the command to execute
Case sensitivity
This section is applicable to languages that have a notion of case sensitivity. All commands and
parameter names are case-insensitive. "createVolume" is the same as "CreateVolume" is the same as
"CREATEVOLUME". In some cases, parameter values, while not sensitive, are case significant as the system
will preserve the case specified. For example, the description parameter value in the createVolume command
will preserve the case specified by the caller, and impose this on the newly created volume.
True/False
Any parameter that indicates true/false, may be specified as "1|0" or "true|false".
Command abbreviation
There is no command or parameter abbreviation in the CLI when scripted. All commands and parameter
names must be fully specified. This is to prevent ambiguity in legacy scripts if new commands or parameters
are added.
OS error code integration
The CLI will map error codes to reasonable OS status codes (status in Linux, ERRORLEVEL in DOS). Since
these are limited to 0..255, some of the OS errors may have less granularity than the API error codes.
Composite commands
Some commands take multiple elements for the parameter value. In this case, the parameter is interpreted as
an delimiter-separated ordered list. For example:
volumeName=volume1;volume2
login=10.0.1.2;10.1.2.3;10.2.3.4
HP Lefthand CLI | Syntax | 7