HP StoreOnce Backup System CLI Reference Guide

1 Using the CLI
Introduction
The Common CLI Command Set provides a method of communication with the StoreOnce appliance
which is intuitive, consistent, and easy to use. The command set is broad in scope so that it can
be used with the entire StoreOnce portfolio of products.
The commonality of the CLI command set means that some unsupported commands are present in
the CLI inline help (commands that are not applicable to your appliance or are accessible through
a different CLI command). Any unsupported commands that are executed return the failure message:
Command Failed - This command is not supported on this system.
You control the StoreOnce appliance by entering a command sequence using a specific grammar
and syntax. The operation defined by the command sequence is executed, and any output associated
with the operation is displayed in text or XML output (depending on the configuration settings).
After the operation is complete, the command prompt is displayed, and entry of the next command
sequence can be done.
Command sequences are grouped by function. For example, commands related the network
configuration are in one group. This grouping makes it easy to locate the correct command sequence
for a given operation. See “Categorical List of Commands” (page 16) for details.
Authorization levels are set for each user account to control which commands a user can perform.
This enables users to perform appropriate operations but prevents them from executing actions for
which they are not qualified (see “Accessing the CLI” (page 7)).
NOTE: This document refers to single-node and multi-node products. Products are defined as
follows:
• Single-node: HP StoreOnce 4900, 4700, 4500 and 2700 Backup (and older models HP
StoreOnce 4430, 4420, 4210, 4220, and 2620 Backup)
• Multi-node: HP StoreOnce B6200 and 6500 Backup
Accessing the CLI
The CLI software embedded in the appliance enables you to manage and monitor storage-system
operation. For single-node products, access the CLI from an SSH terminal using an SSH client
application (freely available on the internet). For multi-node products, access the CLI from the
management virtual interface (i.e., an SSH terminal connected to the master node using an SSH
client application—freely available on the internet). The CLI runs on the management console:
ssh <username>@<appliance IP address>
The Common CLI instruction set supports different authorization levels that permit execution of
different subsets of commands. Each authorization level has a unique command prompt. The
accounts in Table 1 (page 8) are created at the time of the StoreOnce system installation, and
the Administrator can create additional users at any time.
Introduction 7