HP StoreOnce D2D4324 HP StoreOnce Backup System CLI Reference Guide (BB877-909 - Page 8
Command Instruction Syntax
View all HP StoreOnce D2D4324 manuals
Add to My Manuals
Save this manual to your list of manuals |
Page 8 highlights
2 Command Instruction Syntax A StoreOnce appliance is controlled by operations. An operation is one or more of the following events: • Providing configuration information to the appliance • Requesting an action • Obtaining information about the appliance The execution of operations is initiated by instructions. The instruction entry consists of three parts: • 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 there is a defined syntax for every command sequence. 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 is possible. • Parameters - define additional conditions placed upon 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. Table 2 A CLI Instruction Command Sequence command (group) command (action) command (subject) Objects command object (clarification) object object Parameters parameter: value NOTE: Command entry is case insensitive; command words, objects, and parameters may be entered in either upper or lower case. The beginning elements of your entry are compared with the allowed command sequences. If there is a direct match, this match defines the command syntax. If there is more than one direct match, the match with the most number of elements is used. If a match does not exist, the help function is performed to aid you in determining the correct entry. Once the command sequence has been established, the entry is verified for correct syntax. If the entry is correct, the operation is performed as defined. If there is a syntax violation, 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 or indicates user entry is required to define the object or parameter • The use of special parenthesis such as {Object1 | Object2| .....} or {value1 | value2 | ......} indicates a selection of one item is required among the items separated by the | character. 8 Command Instruction Syntax