1 Using the CLI
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 once
learned, it can be used with the B6000 family of products as well as future products in the StoreOnce
roadmap.
The Command Set implements a grammar and syntax which defines operations via unique
instructions. The instructions within the command set are grouped by user authorization levels. This
enables a user to perform any appropriate operation but prevents a user from executing actions
for which they are not qualified.
Separate accounts are created allow users to log into the Common CLI. Access to an account is
controlled via passwords. An account has an authorization level which defines to what level the
StoreOnce appliance can be controlled or the configuration modified by the user. The authorization
level defines what instructions can be executed by the user.
Upon logging into the Common CLI, a command prompt is displayed indicating the level of
authorization. Communication with the Common CLI is performed by entering a sequence of words
after the prompt. The Common CLI Command Set is the entire list of allowed word sequences.
Command sequences are grouped by function. Examples of this grouping are commands related
the network configuration or the establishment of an accurate time standard within the appliance.
Many functional groups exist. This functional grouping allows a user to easily determine the correct
command sequence for a given operation. For example, entering the help command lists all the
categories under which all the command sequences exist. Entering the help command followed
by a command group provides information about all the command sequences within that group.
All the instructions related to obtaining information about or controlling a virtual tape library are
grouped under the “vtl” category; entering help vtl provides the list of all the command sequence
syntax related to virtual tape libraries which are allowed for the user’s authorization level. This
structure allows a user to quickly determine the instruction syntax for a desired operation.
The user controls the StoreOnce appliance by typing in a command sequence and pressing the
enter key. After pressing the enter key, the operation defined by the command sequence is executed.
Depending on the Common CLI configuration settings, any output associated with the operation
is displayed in text or XML output. Once the operation is complete, the command prompt is displayed
and the next command sequence can be entered.
The “up” and “down” arrows can be used to scroll through previously entered command sequences.
When an arrow key is pressed, the adjacent sequence in the entry history is displayed after the
command prompt. This entry can then be edited and entered. When multiple instances of similar
command sequences are being entered, this feature will speed entry.
Accessing the CLI
The CLI software embedded in the controller modules enables you to manage and monitor
storage-system operation. You can access the CLI from an SSH terminal connected to the master
node:
ssh <vif_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.
Accessing the CLI 5