HP StorageWorks SAN Virtualization Services Platform Manager command line interface user guide (AG781-96016, March 2009)

• The expression [TEMPLATE] marks an optional value. Either the word TEMPLATE (not case
sensitive) appears in its place to mark that the preceding name is a root name and that the VSM
CLI must create a unique full name from it, or nothing appears in its place (meaning that the pre-
ceding name is the full name to be used).
• The expression [LastInstance | LastAsyncMirror | LastSyncMirror] marks an
optional value. If LastInstance , LastAsyncMirror, or LastSyncMirror (not case sens-
itive) appears in the command line, it indicates that the preceding name is a ‘root’ name, and that
the VSM CLI must find the most recently created instance of that entity (virtual disk, PiT, or snapshot)
with this root name.
• If nothing appears in the command line, it means that the preceding name is the full name to be
used. In addition:
• The expression LastInstance indicates that the root name is for the most recently created
snapshot PiT or snapshot instance (with a template name) on the specific virtual disk.
• The expression LastAsyncMirror indicates that the root name is for the most recently created
asynchronous (async) mirror user PiT instance on the specific virtual disk. This is different from
the async mirror template name that may be provided, which is the template name for the
whole mirror group.
• The expression LastSyncMirror indicates that the root name is for the most recently created
synchronous (sync) mirror PiT instance on the specific virtual disk. This is different from the sync
mirror template name provided, which is the template name for the whole mirror group.
• The maximum length of a VSM entity name (virtual disk, PiT, snapshot, storage pool, and so on)
is 31 characters. The maximum length of a root name (to which a template suffix is to be added)
must be less than 16 characters.
• For cluster support and bootable flag arguments: 0 means no, 1 means yes.
• In almost all commands (unless otherwise specified), input numbers (for example, those indicating
size) are integer numbers. In some cases that are specifically marked, input numbers are expressed
in scientific notation (for example, 1.234e8).
• The timeout in CLI commands defines the maximum time in seconds that the CLI will wait for the
completion of the command.
If the command is completed before the timeout period expires, the CLI will return with a success
status. If the command does not complete within the timeout period, the CLI returns with a
VSM_SYNC_TIMEOUT error.
The recommended timeout value to use is 900 (seconds). For some operations (for example, create
a PiT or snapshot over multiple PiTs, delete PiT, or restore snapshot) you should use higher values,
since the time taken to complete depends on how much data is being handled.
• The -Drive may accept a drive letter in the form of H:, or where applicable, a fully qualified
mount point.
• All capacity or disk sizes are in megabytes (MB), unless otherwise specified, with 1 MB=1024
KB.
• In general, a command with multiple arguments of the same type (for example, set permissions
with multiple host names) may be partially executed. The VSM executes such commands sequen-
tially, iterating on all these arguments. If an execution error is encountered for one of these argu-
ments (for example, no such host name), it stops execution at this stage and returns an error indic-
ating the index of the failed argument (in this case, the index of the failed host on the list). However,
the command has already been successfully executed for all the previous arguments (hosts, in this
example).
HP StorageWorks SAN Virtualization Services Platform Manager command line interface user
guide 23