11.0 HP StoreVirtual LeftHand OS Command Line Interface User Guide (AX696-96291, September 2013)

Global parameters

prompt=<true | false>

Some commands prompt before proceeding. This default behavior can be turned off by specifying

prompt=false.

output=<XML | Normal>

In the default case, the CLI returns information to standard output, formatted in a way that's easy

to read rather than easy to parse. The XML setting returns all output information as an XML document,

allowing easier parsing of the result. There is no guarantee that newer versions of the API will

preserve the same formatting in the default case. It is strongly discouraged to use this form of the

CLI programmatically. Use the XML output type if the output must be parsed.

separator=<c>

Some CLI parameters comprise parameters for multiple operations. For example, when using the

snapshotVolumes command, allows the user to specify simultaneous snapshots of multiple

volumes. In this scenario, some parameters specify an ordered list that apply to each snapshot in

succession:

description="This applies to snapshot1;This applies to snapshot2"

The default separator character is a semicolon (;). If a semicolon is used in the body of a parameter,

you can use a different character as the separator (such as a comma).

Syntax

The CLI specifies parameters in the form of parameter=<parameter> (specification), rather than

dictating a particular order (positional) notation.

Parameter ordering

The order of parameters is not specified. For example, the following are equivalent commands

that perform the same task:

cliq deleteVolume volumeName=theVolume userName=user passWord=secret

cliq deleteVolume login=10.1.2.3 passWord=secret userName=user

The method parameter may be optionally specified as "method=<command>":

cliq userName=user passWord=secret login=10.1.2.3 volumeName=theVolume

method=deleteVolume

Case sensitivity

All commands and parameter names are case-insensitive. For example, createVolume,

CreateVolume, and CREATEVOLUME are all the same command. 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 preserves the case

specified by the caller, and imposes this on the newly created volume.

True/False

Any parameter that indicates true/false, may be specified as "1|0" or "true|false".

8 Overview