HP StoreOnce Backup System CLI Reference Guide

2 Command Instruction Syntax
A StoreOnce appliance is controlled by operations. An operation:
• Provides configuration information to the appliance
• Requests an action
• Obtains information about the appliance
The execution of operations is initiated by instructions as shown in Table 2 (page 11). The instruction
entry consists of a maximum of three parts: The command sequence, objects, and parameters. In
Table 2 (page 11), the bottom row is referred to a command element.
Table 2 A CLI Instruction
Instruction
ParametersObjectsCommand Sequence
valueobjectobjectobjectcommandcommandcommandcommandCommand
Element
(clarification)(subject)(action)(group)
• The command sequence – up to four command elements representing groups of related
operations, actions, or subjects of the action. A command sequence is unique and a defined
syntax for every command sequence exists. The command sequence must be present in all
entries to define the instruction.
A typical command sequence consists of a command element defining the group of related
operations to which the given sequence belongs. This element is followed by a command
element describing the action of the operation. Then, depending on the operation, a third and
possibly fourth element may be included to describe the subject of the action. In some cases,
the command sequence may consist of only one command element describing the action of
the operation.
• Objects – represent an item associated with a StoreOnce appliance. It may be a physical
item, such as a network interface, or a virtual item, such as a virtual tape cartridge. Not all
instructions contain objects, but up to three are possible. See “Objects” (page 14) for details.
• Parameters – define additional conditions placed on the operation. A parameter consists of
a word (or a series of words separated by dashes) followed by a colon; the characters after
the colon define the value of the parameter. Not all instructions contain parameters.
NOTE: Command entries are case insensitive; command words, objects, and parameters may
be entered in either upper- or lowercase.
The beginning elements of entries are compared with the allowed command sequences. If a direct
match exists, this match defines the command syntax. If more than one direct match exists, the
match with the most number of elements is used. If a match does not exist, the help function is
performed to aid in determining the correct entry.
After the command sequence is established, the entry is verified for correct syntax. If the entry is
correct, the operation is performed as defined. If a syntax violation exists, the help function is
performed to aid you in determining the correct entry.
The following convention is used when describing command entry syntax:
• The use of square parenthesis, such as [Object] or [parameter], indicates the object
or parameter entry is optional
• The use of carat parenthesis, such as <Object> or <parameter>, indicates user entry is
required to define the object or parameter
11