beautypg.com

Cli command guidance – HP SAN Virtualization Services Platform User Manual

Page 19

background image

results in a need for only one pre-backup script in most cases, that is invoked by the backup
application before it starts.

Alternatively, a CLI script can also do the whole task by activating the backup application from
the script itself (using the Run CLI command). A post-backup script (for clean up) may be invoked
by the backup application after task completion. If a post-backup script is not used, a PiT is
maintained on the original virtual disk until the next backup is performed.

In both cases, the pre-backup script must clean up before starting its actual work.

CLI command guidance

This section provides guidance that applies to all CLI commands. These examples are used for
both input from the command line or from an input file.

Square brackets ([…]) mean optional. The pipe symbol (|) means alternative.

The expression R|RW|OFF means that one of the alternatives (OFF, R, or RW) must appear
in the command where the expression appears.

The expression 0|1|...|N means that one of the alternatives (0, 1,..., or N) must appear
in the command where the expression appears.

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 preceding name is the full name to be used).

The expression [LastInstance | LastAsyncMirror | LastSyncMirror] marks an
optional value. If LastInstance , LastAsyncMirror, or LastSyncMirror (not case
sensitive) 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).

CLI command guidance

19