Hp D2D2503I Smartbuy Backup System Cli Reference Guide StoreOnce Single Node And Multi

Hp-D2D2502I-Backup-System-Cli-Reference-Guide-156507 hp-d2d2502i-backup-system-cli-reference-guide-156507

2015-01-05

: Hp Hp-D2D2503I-Smartbuy-Backup-System-Cli-Reference-Guide-156513 hp-d2d2503i-smartbuy-backup-system-cli-reference-guide-156513 hp pdf

Open the PDF directly: View PDF PDF.
Page Count: 178

DownloadHp Hp-D2D2503I-Smartbuy-Backup-System-Cli-Reference-Guide- StoreOnce Backup System Single-node And Multi-node CLI Reference Guide Hp-d2d2503i-smartbuy-backup-system-cli-reference-guide
Open PDF In BrowserView PDF
HP StoreOnce Backup System Single-node
and Multi-node CLI Reference Guide

Abstract
This document details the set of operations supported by the Common CLI. This command set defines the instructions used to
obtain information about a StoreOnce Backup system appliance or to control the appliance’s activity. It is intended for system
administrators managing a single or multi-node HP StoreOnce Backup System.
IMPORTANT: This guide may have more recent updates. Always check http://www.hp.com/support/manuals for the most
up-to-date documentation for your product.

*BB852-90942*
HP Part Number: BB852-90942
Published: June 2013
Edition: Fifth

© Copyright 2011–2013 Hewlett-Packard Development Company, L.P.
Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial
Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under
vendor's standard commercial license.
The information contained herein is subject to change without notice. The only warranties for HP products and services are set forth in the express
warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall
not be liable for technical or editorial errors or omissions contained herein.
Acknowledgments
Intel®, Itanium®, Pentium®, Intel Inside®, and the Intel Inside logo are trademarks or registered trademarks of Intel Corporation or its subsidiaries
in the United States and other countries.
Microsoft®, Windows®, Windows® XP, and Windows NT® are U.S. registered trademarks of Microsoft Corporation.
Adobe® and Acrobat® are trademarks of Adobe Systems Incorporated.
Java and Oracle are registered trademarks of Oracle and/or its affiliates.
UNIX® is a registered trademark of The Open Group.
Warranty
WARRANTY STATEMENT: To obtain a copy of the warranty for this product, see the warranty information website:
http://www.hp.com/go/storagewarranty
Revision History
Revision 1

October 2012

Single-node version only. Initial release on product CD
Revision 2

December 2012

Single-node version only. Minor text updates for release to the HP website. Part number: BB852-90924
Revision 4

October 2012

Multi-node version only. Part number: EJ022-90969
Revision 5

June 2013

Combined Single and Multi-node versions. Part number: BB852-90942

Contents
1 Using the CLI.............................................................................................6
Introduction..............................................................................................................................6
Accessing the CLI.....................................................................................................................6
Command Entry.......................................................................................................................7
Viewing Help...........................................................................................................................7
Transferring Files.......................................................................................................................7
Scripting..................................................................................................................................7

2 Command Instruction Syntax........................................................................8
Global Defaults........................................................................................................................9

3 Categorical List of Commands....................................................................10
4 Alphabetical List of Commands and Details.................................................13
accounts add.........................................................................................................................13
accounts del..........................................................................................................................15
accounts modify.....................................................................................................................16
accounts show.......................................................................................................................17
alerts show............................................................................................................................18
config delete..........................................................................................................................19
config restore devices..............................................................................................................20
config save devices.................................................................................................................22
config show list......................................................................................................................23
exit.......................................................................................................................................24
hardware add storage.............................................................................................................25
hardware beacon...................................................................................................................26
hardware delete storage..........................................................................................................27
hardware disable failover........................................................................................................29
hardware discover storage.......................................................................................................30
hardware enable failover.........................................................................................................31
hardware failback..................................................................................................................32
hardware failover...................................................................................................................33
hardware poweroff.................................................................................................................34
hardware powerup.................................................................................................................36
hardware prepare storage.......................................................................................................37
hardware reboot....................................................................................................................38
hardware set ports..................................................................................................................39
hardware show net status........................................................................................................40
hardware show node status......................................................................................................42
hardware show problems........................................................................................................43
hardware show status..............................................................................................................44
hardware show storage status..................................................................................................47
help......................................................................................................................................48
license add............................................................................................................................50
license load...........................................................................................................................51
license show..........................................................................................................................52
logs show events....................................................................................................................53
net activate config..................................................................................................................55
net add subnet.......................................................................................................................56
net copy config......................................................................................................................58
net create config.....................................................................................................................59
net delete config.....................................................................................................................61
net delete subnet....................................................................................................................62
Contents

3

net modify config...................................................................................................................63
net modify subnet...................................................................................................................65
net ping................................................................................................................................67
net set config.........................................................................................................................68
net set wizard........................................................................................................................70
net show config......................................................................................................................73
net show config......................................................................................................................75
net show config list.................................................................................................................77
net show ports........................................................................................................................78
net show status.......................................................................................................................79
net validate config..................................................................................................................80
serviceset show status..............................................................................................................81
serviceset start........................................................................................................................82
serviceset stop........................................................................................................................83
snmp add trapsink .................................................................................................................84
snmp add user.......................................................................................................................87
snmp del trapsink ..................................................................................................................89
snmp del user........................................................................................................................90
snmp disable.........................................................................................................................91
snmp enable..........................................................................................................................92
snmp modify trapsink..............................................................................................................93
snmp modify user...................................................................................................................95
snmp reset ro-community.........................................................................................................97
snmp set contact.....................................................................................................................98
snmp set location....................................................................................................................99
snmp set ro-community..........................................................................................................100
snmp show config.................................................................................................................101
snmp show user....................................................................................................................103
support create ticket..............................................................................................................104
support del ticket..................................................................................................................105
support show ticket...............................................................................................................106
system clear packages...........................................................................................................107
system clear repository..........................................................................................................108
system disable failover..........................................................................................................109
system enable failover...........................................................................................................110
system load packages...........................................................................................................111
system reboot.......................................................................................................................112
system set clioutput................................................................................................................113
system set config...................................................................................................................114
system set description............................................................................................................121
system set pagecontrol..........................................................................................................122
system show config...............................................................................................................123
system show packages..........................................................................................................124
system show repository..........................................................................................................125
system show status................................................................................................................126
system shutdown...................................................................................................................128
system update packages........................................................................................................129
time add ntpserver................................................................................................................130
time del ntpserver.................................................................................................................132
time reset timezone...............................................................................................................133
time set timezone..................................................................................................................134
time set UTC........................................................................................................................136
time show config..................................................................................................................137
vtl create cartridge................................................................................................................138
vtl create library...................................................................................................................140
4

Contents

vtl
vtl
vtl
vtl
vtl
vtl
vtl
vtl
vtl
vtl
vtl
vtl
vtl
vtl

delete cartridge................................................................................................................144
delete library...................................................................................................................146
modify cartridge...............................................................................................................148
modify drive....................................................................................................................150
modify library..................................................................................................................152
move cartridge.................................................................................................................156
show capacity..................................................................................................................158
show cartridges................................................................................................................160
show drive info.................................................................................................................162
show drive list..................................................................................................................164
show library info..............................................................................................................166
show library iscsi authentication.........................................................................................169
show library list................................................................................................................170
show ports.......................................................................................................................171

5 Support and other resources....................................................................173
Contacting HP......................................................................................................................173
Related information...............................................................................................................173
Websites........................................................................................................................173
Typographic conventions.......................................................................................................173
Documentation feedback.......................................................................................................174

Glossary..................................................................................................175
Index.......................................................................................................177

Contents

5

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 once
learned, you can use it with the entire StoreOnce portfolio of products.
The commonality of the CLI command set means that some unsupported commands will be present
in the CLI inline help (commands that are not applicable your appliance or are accessible through
a different CLI command). Any unsupported commands that are executed will 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).
When the operation is complete, the command prompt is displayed and you can enter the next
command sequence.
Command sequences are grouped by function. For example, commands related the network
configuration are in one group. This makes it easy to determine the correct command sequence
for a given operation. See “Categorical List of Commands” (page 10) for details.
Authorization levels are set for each user account to control what 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 6).

Accessing the CLI
The CLI software embedded in the appliance enables you to manage and monitor storage-system
operation. For single-node products, you can access the CLI from an SSH terminal using an SSH
client application (freely available on the internet). For multinode products, you can access the CLI
from an SSH terminal connected to the master node using an SSH client application (freely available
on the internet). The CLI is running on the management console:
ssh @
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 6) are created at the time of the StoreOnce system installation, and
the Administrator can create additional users at any time.
Table 1 Login Information

6

Authorization Level

Can Execute

Operator

Administrator

Using the CLI

User Name

Password

Command Prompt

Commands that
Operator
provide information
about the state and
configuration of the
StoreOnce appliance
but no commands that
change the
configuration.

operator

>

Commands that
provide information
about the state and
configuration of the
StoreOnce appliance
plus commands that
configure or change
the configuration of

admin

#

Admin

Table 1 Login Information (continued)
Authorization Level

Can Execute

User Name

Password

Command Prompt

the StoreOnce
appliance.

Command Entry
Upon log in, the cursor appears after the command prompt. Instruction entry elements are placed
after the prompt by entering the appropriate characters and symbols. Pressing the enter key directs
the Common CLI to interpret the instruction entry and perform the defined operation. Once the
operation is completed, the command prompt is displayed and another instruction may be entered.
Prior to pressing the enter key, the text after the command prompt can be edited using the delete,
backspace, right and left arrow keys. In addition, the up and down arrow key are used to scroll
through the previously entered command sequences; you can then edit and enter a previous
command sequence. This speeds the entry when entering multiple instances of similar command
sequences.

Viewing Help
To view brief descriptions of all global commands and commands that are available to the current
user level, enter:
help
You can also include a command or command group after help to see help specific to that
command or command group.
To assist in using the Common CLI, the following help features exist:
•

If you enter a correct command sequence but use incorrect syntax, information on the correct
syntax will be displayed.

•

If you enter an invalid command sequence, information on valid permutations of the command
elements will be displayed.

Transferring Files
Transfer of files to and from the StoreOnce appliance is managed with a repository directory within
the appliance. Access to the directory is controlled via the secure FTP.

Scripting
Scripting is performed via Expect, a UNIX automation and testing tool. To aid in parsing, the
Common CLI can be configured to return XML formatted output.

Command Entry

7

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

Objects

command

command

command

command

(group)

(action)

(subject)

(clarification)

object

Parameters
object

object

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:

8

•

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.

Command Instruction Syntax

•

The use of parenthesis such as (object) indicates a label for the object will be automatically
generated by the Common CLI application. No entry is required for this item.

•

The use of parenthesis enclosing the phrase default=value such as (default=value) indicate
that if no value is provided for this parameter, the value within the parenthesis will be used.

Global Defaults
Global defaults exist to clearly represent groups of objects or specific objects. Unlike the existence
of most objects which depend on the StoreOnce appliance or user requirements, global defaults
are directly related to the Common CLI and can be used in command entries on any implementation
of the Common interface.
Default

Represents

ALL

All objects related to a given command sequence. (Often, the absence of object elements
implies all objects. The “all” default is used to ensure intent. For example, the command entry
“hardware disable failover” does not include a definition of a node object. Therefore, the
operation is performed on all nodes. In contrast, the command entry “support del ticket all”
must include the global default all to delete all the support tickets. Because the user can not
reverse the results of deleting all the support tickets, the global default all must be included to
ensure the users intent).

CLI
(multinode default
only)

The Common CLI interface. (To support high availability, the instance of the Common CLI can
exist on any node, a VIF is used to define the location and by default the Common CLI object.
Prior to the VIF assignment, this global default is used to represent the Common CLI.)

CURRENT

The object currently active.

DEFAULT

Default settings as define by HP.

GUI
(multinode default
only)

The GUI associated with the StoreOnce appliance support by the Common CLI. (To support
high availability, the instance of the GUI can exist on any node, a VIF is used to define the
location and by default the Common CLI object. Prior to the VIF assignment, this global default
is used to represent the GUI.)

Global Defaults

9

3 Categorical List of Commands
Table 3 Commands by Category
Command
Group

Commands

accounts

“accounts add” (page 13)
“accounts del” (page 15)
“accounts modify” (page 16)
“accounts show” (page 17)

alerts

“alerts show” (page 18)

config

“config delete” (page 19)
“config restore devices” (page 20)
“config save devices” (page 22)
“config show list” (page 23)

exit

“exit” (page 24)

hardware

“hardware add storage” (page 25)
“hardware beacon” (page 26)
“hardware delete storage” (page 27)
“hardware disable failover” (page 29)
“hardware discover storage” (page 30)
“hardware enable failover” (page 31)
“hardware failback” (page 32)
“hardware failover” (page 33)
“hardware poweroff” (page 34)
“hardware powerup” (page 36)
“hardware prepare storage” (page 37)
“hardware reboot” (page 38)
“hardware set ports” (page 39)
“hardware show net status” (page 40)
“hardware show node status” (page 42)
“hardware show problems” (page 43)
“hardware show status” (page 44)
“hardware show storage status” (page 47)

help (see
“Viewing Help”
(page 7))

“help” (page 48)

license

“license add” (page 50)
“license load” (page 51)
“license show” (page 52)

logs

“logs show events” (page 53)

net

“net activate config” (page 55)
“net add subnet” (page 56)
“net copy config” (page 58)
“net create config” (page 59)
“net delete config” (page 61)

10

Categorical List of Commands

Table 3 Commands by Category (continued)
Command
Group

Commands
“net delete subnet” (page 62)
“net modify config” (page 63)
“net modify subnet” (page 65)
“net ping” (page 67)
“net set config” (page 68)
“net set wizard” (page 70)
“net show config” (page 73)
“net show config” (page 75)
“net show config list” (page 77)
“net show ports” (page 78)
“net show status” (page 79)
“net validate config” (page 80)

serviceset

“serviceset show status” (page 81)
“serviceset start” (page 82)
“serviceset stop” (page 83)

snmp

“snmp add trapsink ” (page 84)
“snmp add user” (page 87)
“snmp del trapsink ” (page 89)
“snmp del user” (page 90)
“snmp disable” (page 91)
“snmp enable” (page 92)
“snmp modify trapsink” (page 93)
“snmp modify user” (page 95)
“snmp reset ro-community” (page 97)
“snmp set contact” (page 98)
“snmp set location” (page 99)
“snmp set ro-community” (page 100)
“snmp show config” (page 101)
“snmp show user” (page 103)

support

“support create ticket” (page 104)
“support del ticket” (page 105)
“support show ticket” (page 106)

system

“system clear packages” (page 107)
“system clear repository” (page 108)
“system disable failover” (page 109)
“system enable failover” (page 110)
“system load packages” (page 111)
“system reboot” (page 112)
“system set clioutput” (page 113)
“system set description” (page 121)
“system set pagecontrol” (page 122)
“system show config” (page 123)
“system show packages” (page 124)

11

Table 3 Commands by Category (continued)
Command
Group

Commands
“system show repository” (page 125)
“system show status” (page 126)
“system shutdown” (page 128)
“system update packages” (page 129)

time

“time add ntpserver” (page 130)
“time del ntpserver” (page 132)
“time reset timezone” (page 133)
“time set timezone” (page 134)
“time set UTC” (page 136)
“time show config” (page 137)

vtl

“vtl create cartridge” (page 138)
“vtl create library” (page 140)
“vtl delete cartridge” (page 144)
“vtl delete library” (page 146)
“vtl modify cartridge” (page 148)
“vtl modify drive” (page 150)
“vtl modify library” (page 152)
“vtl move cartridge” (page 156)
“vtl show capacity” (page 158)
“vtl show cartridges” (page 160)
“vtl show drive info” (page 162)
“vtl show drive list” (page 164)
“vtl show library info” (page 166)
“vtl show library iscsi authentication” (page 169)
“vtl show library list” (page 170)
“vtl show ports” (page 171)

12

Categorical List of Commands

4 Alphabetical List of Commands and Details
accounts add
Description of Command Function
Creates an account that interfaces with the StoreOnce appliance using the CLI or GUI.
NOTE: The standard factory or restore image already contains the account Admin with the
administrator authority level and the password: admin. You cannot create that account, but you
can modify or delete it.
Command Syntax
accounts add  password  level
{admin|user} newpassword  
Command Authority
Administrator
Command Object Requirements
ACCOUNT – This required object is a string uniquely labeling the added account. It can contain
uppercase and lowercase letters, numbers, a hyphen (-), and an underscore (_) for a maximum of
16 characters.
Command Parameter Requirements
•

•

level – This required parameter defines the account authorization level and will be one of the
following:

◦

admin (administrator)

◦

user

password – This required parameter string defines a password for the account. Include the
text password followed by the password, white space, and the same password. The string
can contain uppercase and lowercase letters, numbers, and the symbols ! @ # $ % ^ & * for
a maximum of 24 characters and is case sensitive.

Requirements for Command Execution
•

The command entry must conform to the command syntax.

•

The object value must be valid; see the object description for details.

•

All parameter values must be valid; see the parameter descriptions for details.

Successful Command Output
Upon successful completion of the command, the following is displayed:
account ACCOUNT added, where ACCOUNT is the string label of the new account.
Command Operation during Abnormal Conditions
•

If the command does not conform to the required syntax, the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.

•

If the password does not meet the defined requirements, the following is displayed:
Command Failed - The password must be 1 character in length minimum
and 24 characters in length maximum and can only contain upper,

accounts add

13

lower case letters, numbers and the following symbols ! @ # $ % ^
& *
•

If the account description is too long, the following is displayed:
Command Failed – The account description can only be 32 characters
max

•

If the label is the same as an existing account, the following is displayed:
Command Failed - account ACCOUNT already exists, where ACCOUNT is the
string label of the account.

Example
# accounts add Joe_Operator password B@seB@ll level user newpassword
F00tB*ll F00tB*ll
account Joe_Operator added

14

Alphabetical List of Commands and Details

accounts del
Description of Command Function
Deletes an existing account.
NOTE: Accounts can only be deleted if the user is logged in with an account with at least the
same level of command authority/permission as the account being deleted.
Command Syntax
accounts del  password 
Command Authority
Administrator
Command Object Requirements
ACCOUNT – This required object is a string matching the label of an existing account. This cannot
be the only account with the Administrator authorization level.
Command Parameter Requirements
Not applicable – no parameters exist within this command.
Requirements for Command Execution
•

The command entry must conform to the command syntax.

•

The object value must be valid; see the object description for details.

Successful Command Output
Upon successful completion of the command, the following is displayed:
account ACCOUNT deleted, where ACCOUNT is the string label of the deleted account.
Command Operation during Abnormal Conditions
•

Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.

•

If the account object in the command entry is the only account with “administrator” authorization
level, the following is displayed:
Command Failed – At least one account must have administrator
authorization

•

If the account label included in the command does not match an existing account, the following
is displayed:
Command Failed - account ACCOUNT does not exist, where ACCOUNT is the
account label included in the command.

Example
# accounts del Joe_Operator password B@seB@ll
account Joe_Operator deleted

accounts del

15

accounts modify
Description of Command Function
Modifies the password of an existing account.
Command Syntax
accounts modify [ACCOUNT] password  newpassword
 
Command Authority
Administrator
Command Object Requirements
ACCOUNT – This required object is a string of an existing account.
Command Parameter Requirements
password – This parameter may be modified for the account defined within this command by
entering a new value.
Requirements for Command Execution
•

The command entry must conform to the command syntax.

•

The account object in the command entry must be an existing account.

Successful Command Output
Upon successful completion of the command, the following is displayed:
account ACCOUNT modified, where ACCOUNT is the string labeling the account to be
modified.
Command Operation during Abnormal Conditions
•

If the command does not conform to the required syntax the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX where SYNTAX is the command syntax as described under Command Syntax in this
section.

•

If the password does not meet the defined requirements, the following is displayed:
Command Failed - The password must be 1 character in length minimum
and 24 characters in length maximum characters max and can only
contain upper, lower case letters, numbers and the following symbols
1! @ # $ % ^ & *.

•

If the account label included in the command does not match an existing account, the following
is displayed:
No such D2D User: ACCOUNT
Command Failed -, where ACCOUNT is the account label included in the command.

Example
# accounts modify Joe_Operator password B@seB@ll newpassword F00tB*ll
F00tB*ll
account Joe_Operator modified
To modify the password of the currently active account:
# accounts modify password B@seB@ll newpassword F00tB*ll F00tB*ll
account (current account name) modified

16

Alphabetical List of Commands and Details

accounts show
Description of Command Function
Lists all the user accounts and their authority level defined for the StoreOnce appliance.
Command Syntax
accounts show [current]
Command Authority
Administrator
Command Object Requirements
current – As an option, the global default “current” may be included in the command entry. If
included, “current” must follow accounts show in the command entry. The “current” account
object indicates the command applies to the account which has been used to log into the currently
displayed CLI.
Command Parameter Requirements
Not applicable – no parameter values exist within this command.
Requirements for Command Execution
•

The command entry must conform to the command syntax.

•

If the “current” object is included in the command entry, only information for the current account
is shown.

Successful Command Output
Upon successful completion of the command, the following is displayed for each account:
ACCOUNT AUTHORITY-LEVEL, where ACCOUNT is the string which labels a given account and
AUTHORITY-LEVEL is one of the following authorization levels:
•

operator

•

administrator

Command Operation during Abnormal Conditions
If the command does not conform to the required syntax the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.
Example
# accounts show
Username
-------Admin
Operator

Authority-Level
--------------administrator
operator

accounts show

17

alerts show
Description of Command Function
Lists all events with a severity of “critical” or “error.”
NOTE: The command logs show events can also be used to show all events or filtered
events, not just critical or error events. See “logs show events” (page 53).
Command Syntax
alerts show [verbose] [numofevents ]
Command Authority
Operator, Administrator
Command Object Requirements
Not applicable – no objects exist within this command.
Command Parameter Requirements
•

verbose – When this parameter is included in the command entry a detailed output is provided.

•

numofevents – When this parameter is use a integer must follow the “numofevents” text. This
is the maximum number of events which will be listed in the output, starting with the most
recent events.

Requirements for Command Execution
The command entry must conform to the command syntax.
Successful Command Output
Upon successful completion of the command, a list of the most recent events up to 20 events is
displayed starting with the most recent event. The output includes the event time, level, and
description.
If the “verbose” parameter is included, a detailed list of information for each event is output. If the
“numofevents” parameter is included, the maximum number of events displayed is defined by the
interger provided with this parameter. The list of events starts with the most recent event.
Command Operation during Abnormal Conditions
If the command does not conform to the required syntax, the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.
Examples
> alerts show
EVENT ID

TIMESTAMP

--------

---------------

580
stale

Jul 21 16:22:50

LEVEL
-----

TEXT
-------------------------------------------------------------------------------

ALERT

HBA link 50.06.05.b0.02.56.45.00 on host d2dd48564785fd8_node_1 status is

> alerts show verbose
EVENT ID TIMESTAMP
LEVEL TEXT
FILESYSTEM HOST
USER NAME OPERATION SEGMENT NUMBER PV NUMBER NIC HBA
RELATED EVENT
-------- --------------- ----- ---------------------------------------------------------------------------------------- ---------------------- --------- --------- -------------- --------- --- ----------------------------------580 Jul 21 16:22:50
ALERT HBA link 50.06.05.b0.02.56.45.00 on host d2dd48564785fd8_node_1 status is
stale
d2dd48564785fd8_node_1
50.06.05.b0.02.56.45.00
0

NOTE: The example output is in a small font to fit on this specification page. As a CLI output,
the character string will simply wrap at the end of a terminal line.

18

Alphabetical List of Commands and Details

config delete
Description of Command Function
Deletes a configuration file that exists in the configuration jail directory.
Command Syntax
config delete 
Command Authority
Administrator
Command Object Requirements
ConfigFile – This required object is the configuration file which is deleted from the configuration
jail directory. This file must exist in the configuration jail directory. The config show list
command lists all valid configuration files in the config directory.
Command Parameter Requirements
Not applicable – no parameters exist within this command.
Requirements for Command Execution
•

The command entry must conform to the command syntax.

•

The object value must be valid; see the object description for details.

Successful Command Output
Upon successful completion of the command, the following is displayed:
Command Successful
Command Operation during Abnormal Conditions
If any of the command execution requirements fail, command execution terminates. The configuration
file is not deleted and one of these error messages is displayed:
•

Command Failed - the command does not conform to the required syntax,
“config delete ”

•

Command Failed – The configuration file does not exist in the
configuration directory

Example
# config delete
devconfig_hpd4856476a1fc_Thur_Jul_19_10:33:24_UTC_2012.zip
Command Successful

config delete

19

config restore devices
Description of Command Function
Restores the StoreOnce system devices to the condition detailed in the defined device’s configuration
file.
NOTE: For more information about the configuration save and restore process, see the HP
StoreOnce Backup System User Guide (single-node or multi-node, depending on your product).
See also “config save devices” (page 22).
Command Syntax
config restore devices SETX[,X] ConfigFile force
Command Authority
Administrator
Command Object Requirements
Not applicable – no objects exist within this command.
•

ConfigFile – This required object defines the device configuration file detailing the configuration
to which the devices in the system are restored.

•

SETX – This required object defines the service set to which the drive will be added. X is the
numeric index of the service set. You can include more than one service sets.

Command Parameter Requirements
force – This optional parameter overrides any digital signatures or sumchecks.
Requirements for Command Execution
•

The command entry must conform to the command syntax.

•

All object values must be valid; see the object descriptions for details.

•

The parameter value must be valid; see the parameter description for details.

Successful Command Output
Upon successful completion of the command, the following is displayed:
Command Successful
Command Operation during Abnormal Conditions
•

20

If any of the command execution requirements fail, command execution terminates. The
configurations are not restored and one of these error messages is displayed:

◦

Command Failed - the command does not conform to the required
syntax, SYNTAX, where SYNTAX is the command syntax as described under Command
Syntax in this section.

◦

Command Failed – The configuration file does not exist

◦

Command Failed – The configuration file is not a device
configuration file

◦

Command Failed – Duplicate service sets

◦

Command Failed – The service set(s) are invalid

◦

The software version of the configuration file [configuration
software version] does not match system software version [system
software version]

◦

Command Failed – The system hardware does not match the
configuration file (difference in number of nodes)

Alphabetical List of Commands and Details

•

◦

Command Failed – The system hardware does not match the
configuration file (service set does not exist)

◦

Command Failed – Configuration file has been modified (use of
the force parameter will override this check)

If the force parameter is set, the following message is displayed before executing the command:
The validity of the configuration file is not being checked. After
command execution, verify devices have been configured on system as
expected

•

Errors generated by the d2d serviceset restore process are prefixed with “Command
Failed” and displayed as CLI error messages.

Example
# config restore devices saved-devices-config
Command Successful

config restore devices

21

config save devices
Description of Command Function
Saves the device configuration to the configuration jail directory using the standard naming
convention of devconfig_ .zip.
NOTE: For more information about the configuration save and restore process, see the HP
StoreOnce Backup System User Guide (single-node or multi-node, depending on your product).
See also “config restore devices” (page 20).
Command Syntax
config save devices
Command Authority
Administrator
Command Object Requirements
Not applicable – no objects exist within this command.
Command Parameter Requirements
Not applicable – no parameters exist within this command.
Requirements for Command Execution
The command entry must conform to the command syntax.
Successful Command Output
Upon successful completion of the command, the following is displayed:
Configuration Save Started
Enter the config show list command to see the saved configuration files.
Command Operation during Abnormal Conditions
If the command does not conform to the required syntax the following is displayed:
•

Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.

•

Errors generated by the d2d serviceset save process are prefixed with “Command
Failed” and displayed as CLI error messages.

Example
# config save devices
Command Successful

22

Alphabetical List of Commands and Details

config show list
Description of Command Function
Displays a list of saved configuration files. A saved configuration file is any file located in the
config jail directory with the .zip extention. (A configuration file listed by this may not be a
valid configuration file. The user must manage the transfer of valid configuration files into the config
directory.)
Command Syntax
config show list
Command Authority
Operator and Administrator
Command Object Requirements
Not applicable – no objects exist within this command.
Command Parameter Requirements
Not applicable – no parameters exist within this command.
Requirements for Command Execution
The command entry must conform to the command syntax.
Successful Command Output
Upon successful completion of the command, the configuration information is displayed:
Command Operation during Abnormal Conditions
If the command does not conform to the required syntax the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.
Example
# config show list
Location: /config
Configuration
------------devconfig_hpd4856476a1fc_Thur_Jul_19_10:33:24_UTC_2012.zip
devconfig_hpd4856476a1fc_Fri_Jul_13_16:54:24_UTC_2012.zip

Command Successful

config show list

23

exit
Description of Command Function
Terminates a CLI session.
Command Syntax
exit
Command Authority
Operator and Administrator
Command Object Requirements
Not applicable – no objects exist within this command.
Command Parameter Requirements
Not applicable – no parameters exist within this command.
Requirements for Command Execution
The command entry must conform to the command syntax.
Successful Command Output
Not applicable – after command execution, the terminal is closed.
Command Operation during Abnormal Conditions
If the command does not conform to the required syntax the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.
Example
> exit
The CLI session is terminated.

24

Alphabetical List of Commands and Details

hardware add storage
Description of Command Function
This command adds storage which has been discovered using the hardware discover storage
command (see “hardware discover storage” (page 30)). Before this command can be executed,
newly discovered storage must exist as presented in the system show status command (see
“system show status” (page 126)). At least one storage set must exist with a status of “discovered
(XXTB)” where XX cannot be equal to zero. The discovery process must be complete; no storage
set can have the status of “discovering.” Once the storage addition process has been successfully
started, the system show status command is used to determine the status and completion of
the process.
Command Syntax
hardware add storage
Command Authority
Administrator
Command Object Requirements
Not applicable – no objects exist within this command.
Command Parameter Requirements
Not applicable – no parameters exist within this command.
Requirements for Command Execution
•

The command entry must conform to the command syntax.

•

Storage discover must be complete.

•

Each storage enclosure must contain 12 drives all of the same capacity.

Successful Command Output
Upon successful completion of the command, the following is displayed:
storage addition successfully started
Command Operation during Abnormal Conditions
•

If the command does not conform to the required syntax, the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.

•

If newly discovered storage does not exist, the following is displayed:
Command Failed – New storage does not exist. Add physical storage
to D2D system and execute the “hardware discover storage” command

•

If the storage discovery process in currently being executed, the following message is displayed:
Command Failed – Storage discover already in process

Example
# hardware add storage
storage addition successfully started

hardware add storage

25

hardware beacon
NOTE:

This command applies to single-node products only.

Description of Command Function
Turns on or off the beacon for a hardware component. (The hardware component must support
the beacon feature.)
Command Syntax
hardware beacon  {on|off}
Command Authority
Operator and Administrator
Command Object Requirements
dev-id – This required object defines the hardware component whose beacon is to be turned on
or off. The value is a string of the device identifier as listed in the hardware show status
command.
Command Parameter Requirements
on/off – This required parameter defines the state of the beacon on the hardware component.
“On” illuminates the beacon, and “off” places the beacon in a non-illuminated state.
Requirements for Command Execution
•

The command entry must conform to the command syntax.

•

All object values must be valid; see the object descriptions for details.

•

All parameter values must be valid; see the parameter descriptions for details.

Successful Command Output
After command execution, the beacon on the selected hardware component is turned on or off
and the following is displayed:
Command Successful
Command Operation during Abnormal Conditions
If any of the command execution requirements fail, command execution terminates. The beacon
status is unchanged and one of these error messages is displayed:
•

Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.

•

Command Failed – The hardware component does not exist

•

Command Failed – The hardware component does not support the beacon
function

•

Command Failed – The hardware component cannot support the beacon
feature at this time

Examples
# hardware beacon enclosure-1-1 on
Command Successful
# hardware beacon hard_disk-1-1-1 off
Command Successful

26

Alphabetical List of Commands and Details

hardware delete storage
NOTE:

This command applies to single-node products only.

Description of Command Function
Deletes storage segments associated with the StoreOnce system “backend” file system. This
command does not apply to the storage on which each nodes operating system is located.
Command Syntax
Hardware delete storage {ALL|dev-id}
Command Authority
Administrator
Command Object Requirements
Not applicable – no objects exist within this command.
Command Parameter Requirements
•

ALL – When this global parameter is defined in the command sequence, all couplet file systems,
logical segments, logical volumes, and physical volume are removed. The system is left in a
state in which no storage is configured. The command requires this parameter or a dev-id
value.

•

dev-id – This parameter defines a specific volume to be deleted. A specific volume is defined
as a storage component with a specific SCSI LUN. The device ID for the storage component
to be deleted can be determined using the hardware show status command. The
command requires this parameter or the global ALL.

Requirements for Command Execution
•

The command entry must conform to the command syntax.

•

All parameter values must be valid; see the parameter descriptions for details.

Successful Command Output
Prior to executing the command the following message is displayed:
Warning – Data may be destroyed. Are you sure you want to delete storage?
y / n
You must enter a y response for command execution to continue. Upon successful completion of
the command, the following is displayed:
Command Successful
Command Operation during Abnormal Conditions
•

If any of the command execution requirements fail, command execution terminates. The beacon
status is unchanged and one of these error messages is displayed:

◦

Command Failed - the command does not conform to the required
syntax, SYNTAX, where SYNTAX is the command syntax as described under Command
Syntax in this section.

◦

Command Failed – The global parameter ALL or a device ID must be
defined

◦

Command Failed – The device ID is not a storage volume

◦

Command Failed – The device does not exist

hardware delete storage

27

•

◦

Command Failed – The storage volume is assigned to the D2D dedupe
data file system

◦

Command Failed – The storage volume is not part of D2D dedupe
data storage

If you do not respond to the warning message with y, the command is terminated and the CLI
returns to the user prompt.

Example
# hardware delete storage ALL
Command Successful

28

Alphabetical List of Commands and Details

hardware disable failover
NOTE:

This command applies to multi-node products only.

Description of Command Function
Disables the failover feature between nodes which is automatically configured during the initial
automatic configuration of the StoreOnce appliance. HP recommends disabling failover before
rebooting the StoreOnce appliance.
Command Syntax
hardware disable failover [NODEX]
Command Authority
Administrator
Command Object Requirements
NODEX – As an option, this can be used to define an individual file server node. X is a unique
numeric index. NODEX is a label uniquely defining the hardware component. It was assigned
during the initial automatic hardware initialization and configuration and its value resides in the
“node_config” file. A complete list of the NODEX labels can be obtained using the hardware
show node status command (see “hardware show node status” (page 42)). If a file server
node is defined, failover is only disabled for this node.
Command Parameter Requirements
Not applicable – no parameters exist within this command.
Requirements for Command Execution
•

The command entry must conform to the command syntax.

•

Failover must not already be disabled.

Successful Command Output
Upon successful completion of the command, the following is displayed:
failover disabled
Command Operation during Abnormal Conditions
•

If the command does not conform to the required syntax, the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.

•

If failover is already disabled, the following is displayed:
Command Failed - failover is already disabled

Example
# hardware disable failover node1
failover disabled

hardware disable failover

29

hardware discover storage
Description of Command Function
Discovers storage which has been connected to the StoreOnce appliance. Before this command
can be executed, any previous discovery process must be complete. No storage set can have the
status of “discovering.” The status of storage sets can be obtain by using the system show
status command (see “system show status” (page 126)). Once the discover storage process has
been successfully started, the system show status command is used to determine the status
and completion of the process.
Command Syntax
hardware discover storage
Command Authority
Administrator
Command Object Requirements
Not applicable – no objects exist within this command.
Command Parameter Requirements
Not applicable – no parameters exist within this command.
Requirements for Command Execution
•

The command entry must conform to the command syntax.

•

Storage must be connected correctly.

Successful Command Output
Upon successful completion of the command, the following is displayed:
storage discovery successfully completed
Command Operation during Abnormal Conditions
If the command does not conform to the required syntax, the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.
Example
# hardware discover storage
This command takes several minutes to complete execution.

30

Alphabetical List of Commands and Details

hardware enable failover
NOTE:

This command applies to multi-node products only.

Description of Command Function
Enables the failover feature between nodes which had been disabled using the hardware
disable failover (see “hardware disable failover” (page 29)) command.
Command Syntax
hardware enable failover [NODEX]
Command Authority
Administrator
Command Object Requirements
NODEX – As an option, this can be used to define an individual file server node. X is a unique
numeric index. NODEX is a label uniquely defining the hardware component. It was assigned
during the initial automatic hardware initialization and configuration and its value resides in the
“node_config” file. A complete list of the NODEX labels can be obtained using the hardware
show node status command (see “hardware show node status” (page 42)). If a file server
node is defined, failover is only enabled for this node.
Command Parameter Requirements
Not applicable – no parameters exist within this command.
Requirements for Command Execution
•

The command entry must conform to the command syntax.

•

Failover must already be disabled.

Successful Command Output
Upon successful completion of the command, the following is displayed:
failover enabled
Command Operation during Abnormal Conditions
•

If the command does not conform to the required syntax the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX where SYNTAX is the command syntax as described under Command Syntax in this
section.

•

If failover is already enabled, the following is displayed:
Command Failed - failover is already enabled.

Example
# hardware enable failover node1
failover enabled

hardware enable failover

31

hardware failback
NOTE:

This command applies to multi-node products only.

Description of Command Function
Returns the file server node defined in the command entry back from the failover condition. The
node is placed in the failover condition as a result of automatic failover or by using the hardware
failover command (see “hardware failover” (page 33)).
Command Syntax
hardware failback NODEX
Command Authority
Administrator
Command Object Requirements
NODEX – this object must appear in the command entry after hardware failover NODEX is
used to define an individual file server node. X is a unique numeric index. NODEX is a label
uniquely defining the hardware component; tt was assigned during the initial automatic hardware
initialization and configuration and its value resides in the “node_config” file. A complete list of
the NODEX labels can be obtained using the hardware show node status command (see
“hardware show node status” (page 42)).
Command Parameter Requirements
Not applicable – no parameters exist within this command.
Requirements for Command Execution
•

The command entry must conform to the command syntax.

•

The node defined in the command must be powered up and not in a failed stated.

•

The node defined in the command entry must be in a failed over state.

Successful Command Output
Upon successful completion of the command, the following is displayed:
NODEX has successfully failed back, where NODEX is the file server node defined in
the command entry.
Command Operation during Abnormal Conditions
•

If the command does not conform to the required syntax the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX where SYNTAX is the command syntax as described under Command Syntax in this
section.

•

If the node is not in a failover state, the following is displayed:
Command Failed – NODEX is not failed over, where NODEX is the file server
node defined in the command entry.

Example
# hardware failback node1
NODE1 has successfully failed back

32

Alphabetical List of Commands and Details

hardware failover
NOTE:

This command applies to multi-node products only.

Description of Command Function
Forces the implementation of the high availability feature for the file server node defined within
the command. When this command is executed, the backup node within the couplet takes over
the service set functions originally residing on the defined node.
Command Syntax
hardware failover NODEX
Command Authority
Administrator
Command Object Requirements
NODEX – this object must appear in the command entry after hardware failover. NODEX
is used to define an individual file server node. X is a unique numeric index. NODEX is a label
uniquely defining the hardware component; it was assigned during the initial automatic hardware
initialization and configuration and its value resides in the “node_config” file. A complete list of
the NODEX labels can be obtained using the hardware show node status command (see
“hardware show node status” (page 42)).
Command Parameter Requirements
Not applicable – no parameters exist within this command.
Requirements for Command Execution
•

The command entry must conform to the command syntax.

•

The node to which failover will occur must be in a good state.

Successful Command Output
Upon successful completion of the command, the following is displayed:
NODEX has successfully failed over, where NODEX is the file server node defined in
the command entry.
Command Operation during Abnormal Conditions
If the command does not conform to the required syntax the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.
Example
# hardware failover node1
NODE1 has successfully failed over

hardware failover

33

hardware poweroff
NOTE:

This command applies to multi-node products only.

Description of Command Function
Powers down the StoreOnce appliance. If a file server node is defined in the command entry, only
this node is powered down.
NOTE: This command will only work if failover is enabled. See the system enable failover
command, “system enable failover” (page 110)
Command Syntax
hardware poweroff [NODEX]
Command Authority
Administrator
Command Object Requirements
NODEX – As an option, this can be used to define an individual file server node. X is a unique
numeric index. NODEX is a label uniquely defining the hardware component; it was assigned
during the initial automatic hardware initialization and configuration and its value resides in the
“node_config” file. A complete list of the NODEX labels can be obtained using the hardware
show node status command (see “hardware show node status” (page 42)). If a file server
node is defined, only this node is powered down.
Command Parameter Requirements
Not applicable – no parameters exist within this command.
Requirements for Command Execution
•

The command entry must conform to the command syntax.

•

At least one system with an active CLI must exist.

•

If a file serving node is defined in the command entry, the defined node must be powered up.

•

This command will only work if failover is enabled.

Successful Command Output
Upon successfully sending the power off request, the following is displayed:
poweroff request successfully sent
NOTE: This message only indicates the success for the shutdown request. The hardware show
node status command (see “hardware show node status” (page 42)) must be entered to verify
the server nodes shutdown correctly. Also, if the shutdown applies to the node currently supporting
the CLI interface, the session will be terminated following this command.
Command Operation during Abnormal Conditions
•

If the command does not conform to the required syntax, the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX where SYNTAX is the command syntax as described under Command Syntax in this
section.

•

If the node is already powered down, the following is displayed:
Command Failed – NODEX already shutdown, where NODEX is the file server node
object defined in the command entry.

Example
# hardware poweroff node1
34

Alphabetical List of Commands and Details

poweroff request successfully sent

hardware poweroff

35

hardware powerup
NOTE:

This command applies to multi-node products only.

Description of Command Function
Powers up the StoreOnce appliance. If a file server node is defined in the command entry, only
this node is powered up.
Command Syntax
hardware powerup [NODEX]
Command Authority
Administrator
Command Object Requirements
NODEX – As an option, this can be used to define an individual file server node. X is a unique
numeric index. NODEX is a label uniquely defining the hardware component; it was assigned
during the initial automatic hardware initialization and configuration and its value resides in the
“node_config” file. A complete list of the NODEX labels can be obtained using the hardware
show node status command (see “hardware show node status” (page 42)). If a file server
node is defined, only this node is powered up.
Command Parameter Requirements
Not applicable – no parameters exist within this command.
Requirements for Command Execution
•

The command entry must conform to the command syntax.

•

At least one system with an active CLI must exist.

•

If a file serving node is defined in the command entry, the defined node must be powered up.

Successful Command Output
Upon successfully sending the power up request, the following is displayed:
power up request successfully sent
NOTE: This message only indicates the success for the power up request. The hardware show
node status command (see “hardware show node status” (page 42)) must be entered to verify
that the server nodes powered up correctly.
Command Operation during Abnormal Conditions
•

If the command does not conform to the required syntax, the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.

•

If the entire StoreOnce appliance or the specified node is already powered up, the following
is displayed:
Command Failed – device already powered up

Example
# hardware powerup node1
power up request successfully sent

36

Alphabetical List of Commands and Details

hardware prepare storage
Description of Command Function
An alias for the hardware discover storage command. See “hardware discover storage”
(page 30) for details.
Command Syntax
hardware prepare storage

hardware prepare storage

37

hardware reboot
NOTE:

This command applies to multi-node products only.

Description of Command Function
Reboots the StoreOnce appliance nodes. If a file server node is defined in the command entry,
only this node is rebooted.
Command Syntax
hardware reboot [NODEX]
Command Authority
Administrator
Command Object Requirements
NODEX – As an option, this can be used to define an individual file server node. X is a unique
numeric index. NODEX is a label uniquely defining the hardware component. It was assigned
during the initial automatic hardware initialization and configuration. A complete list of the NODEX
labels can be obtained using the hardware show node status command (see “hardware
show node status” (page 42)). If a file server node is defined, only this node is rebooted. If no
nodes are defined, all the nodes in the appliance are rebooted.
Command Parameter Requirements
Not applicable – no parameters exist within this command.
Requirements for Command Execution
•

The command entry must conform to the command syntax.

•

At least one system with an active CLI must exist.

•

If a file serving node is defined in the command entry, the defined node must be powered on.

Successful Command Output
Upon successfully sending the reboot request, the following is displayed:
reboot request successfully sent
NOTE: This message only indicates the success for the reboot request. The hardware show
node status command (see “hardware show node status” (page 42)) must be entered to verify
that the server nodes rebooted correctly. Also, if the reboot applies to the node currently supporting
the CLI interface, the session will terminate following this command.
Command Operation during Abnormal Conditions
•

If the command does not conform to the required syntax, the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.

•

If the defined node is not powered up, the following is displayed:
Command Failed – NODEX is not rebooted, where NODEX is the file server node
defined for reboot in the command entry.

Example
# hardware reboot
reboot request successfully sent

38

Alphabetical List of Commands and Details

hardware set ports
NOTE:

This command applies to single-node products only.

Description of Command Function
Sets the node’s physical port parameters.
Command Syntax
hardware set ports [NODEX] PORTX [speed {auto|2Gbs|4Gbs|8Gbs}]
[{Connection Loop|Fabric|pnt-to-pnt}]
Command Authority
Administrator
Command Object Requirements
•

NODEX – This object defines the node containing the port whose parameters are to be set.
X is a numeric index for the node.

•

PORTX – This object defines the port whose parameters are to be set. X is a numeric index
for the port.

Command Parameter Requirements
•

Speed – This parameter defines the speed of the port. The possible values are defined in the
Command Syntax section.

•

Connection — This parameter defines the connection type. The possible values are defined
in the Command Syntax section.

Requirements for Command Execution
•

The command entry must conform to the command syntax.

•

All object values must be valid; see the object descriptions for details.

•

All parameter values must be valid; see the parameter descriptions for details.

Successful Command Output
Upon successful completion of the command, the following is displayed:
Command Successful
Command Operation during Abnormal Conditions
If any of the command execution requirements fail, command execution terminates. The node's
ports are unchanged and one of these error messages is displayed:
•

Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.

•

Command Failed – The port is invalid

•

Command Failed – The node is invalid

•

Command Failed – Cannot change port settings on a node while in
failover

Example
# hardware set ports port1 speed 8Gbs
Command Successful

hardware set ports

39

hardware show net status
NOTE:

This command applies to multi-node products only.

Description of Command Function
Provides status on the StoreOnce file server node’s network interfaces.
Command Syntax
hardware show net status
Command Authority
Operator and Administrator
Command Object Requirements
Not applicable – no objects exist within this command.
Command Parameter Requirements
Not applicable – no parameters exist within this command.
Requirements for Command Execution
The command entry must conform to the command syntax.
Successful Command Output
Upon successful completion of the command, the status of the hardware network interfaces is
displayed. The displayed status can be one of the following:
•

Up

•

LinkUp

•

Inactive

•

Standby

•

LinkDown

•

BondsDegraded

•

NicsStatusStale

Command Operation during Abnormal Conditions
If the command does not conform to the required syntax, the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.
Example
> hardware show net status
HOST

IFNAME
TYPE
BACKUP_HOST
BACKUP_IF ROUTE LINKMON
------------------------------------------ ------- ---------------------------- --------- ----- ------d2d78e7d1e6928e_node_1
bond1:3 User
No
d2d78e7d1e6928e_node_1
bond1:1 User
d2d78e7d1e6928e_node_2 bond1:3
No
d2d78e7d1e6928e_node_1
bond0
Cluster
No
d2d78e7d1e6928e_node_2
bond1:1 User
d2d78e7d1e6928e_node_1 bond1:3
No
d2d78e7d1e6928e_node_2
bond1:3 User
No
d2d78e7d1e6928e_node_2
bond0
Cluster
No
d2d78e7d1e6928e_node_1 [Active FM Nonedit] bond0:1 Cluster
No
d2d78e7d1e6928e_node_1 [Active FM Nonedit] bond1:2 User
No

40

Alphabetical List of Commands and Details

STATE
-----------------

IP_ADDRESS
------------

Inactive, Standby
Up, LinkUp

MAC_ADDRESS
----------------78:e7:d1:e6:92:8e

10.10.10.10

78:e7:d1:e6:92:8e

Up, LinkUp

10.10.4.1

3c:4a:92:3d:90:a8

Up, LinkUp

10.10.10.11

1c:c1:de:23:d4:5e

10.10.4.2

d4:85:64:23:22:40

Inactive, Standby
Up, LinkUp
Up, LinkUp

10.10.1.1

Up, LinkUp

10.10.10.5

NOTE: The example output is in a small font to fit on this specification page. As a CLI output,
the character string will simply wrap at the end of a terminal line.

hardware show net status

41

hardware show node status
Description of Command Function
Provides status on the StoreOnce file server nodes. If a node object is included in the command
entry. The port and component status is only provided for that node.
Command Syntax
hardware show node status [NODEX]
Command Authority
Operator and Administrator
Command Object Requirements
NODEX – As an option, this can be used to define an individual file server node. X is a unique
numeric index. NODEX is a label uniquely defining the hardware component. It was assigned
during the initial automatic hardware initialization and configuration.
Command Parameter Requirements
Not applicable – no parameters exist within this command.
Requirements for Command Execution
The command entry must conform to the command syntax.
Successful Command Output
Upon successful completion of the command, the status of the hardware network interfaces is
displayed. The displayed status can be one of the following:
•

Up

•

Down

•

Initializing/PoweringUp

•

NicsLinkDown

•

NicsStatusStale

•

FailedOver

•

InFailback

•

PartialFailover

•

BondsDegraded

Command Operation during Abnormal Conditions
If the command does not conform to the required syntax, the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.
Example
> hardware show node status
SERVER_NAME
BACKUP
STATE
HA
ID
GROUP
---------------------- ---------------------- ------------ --- ------------------------------------ ----d2d78e7d1e6928e_node_1 d2d78e7d1e6928e_node_2 Up
off 68fa0df3-ceed-41f6-9b93-ce86cdf552a3 servers
d2d78e7d1e6928e_node_2 d2d78e7d1e6928e_node_1 Up, HBAsDown off 0f1488ca-9478-46b0-9aff-7e39b2a59017 servers

Clients
=======
CLIENT_NAME
-----------

IPADDRESS
---------

ID
--

GROUP
-----

NOTE: The example output is in a small font to fit on this specification page. As a CLI output,
the character string will simply wrap at the end of a terminal line.
42

Alphabetical List of Commands and Details

hardware show problems
Description of Command Function
Displays a list of the failed hardware components in the StoreOnce system.
Command Syntax
hardware show problems
Command Authority
Operator and Administrator
Command Object Requirements
Not applicable – no objects exist within this command.
Command Parameter Requirements
Not applicable – no parameters exist within this command.
Requirements for Command Execution
The command entry must conform to the command syntax.
Successful Command Output
Upon successful completion of the command, the failed hardware components are listed.
Command Operation during Abnormal Conditions
•

If the command does not conform to the required syntax, the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.

•

If any of the command elements (hardware, show, problem, report) are misspelled, the
following is displayed:
element: command not found

Example
> hardware show problems
uuid of failed hw
--------------------msa1
enclosure-1-1
hard_disk-1-1-10
raidset-1-2
msa2
controller-2-1
sas_channel-2-1-1
controller-2-2
sas_channel-2-2-1
switch1_powersupply_2
switch2_powersupply_2

status text
----------warn
down
down
warn
warn
warn
down
warn
down
failure
failure

hardware type
--------------STORAGE_ARRAY
DISK_ENCLOSURE
PHYSICAL_DISK
RAID_SET
STORAGE_ARRAY
DISK_CONTROLLER
SAS_CHANNEL
DISK_CONTROLLER
SAS_CHANNEL
POWER_SUPPLY
POWER_SUPPLY

hardware path
----------------------------------------------------Couplet_1 > msa1
Couplet_1 > msa1 > enclosure-1-1
Couplet_1 > msa1 > enclosure-1-1 > hard_disk-1-1-10
Couplet_1 > msa1 > raidset-1-2
Couplet_1 > msa2
Couplet_1 > msa2 > controller-2-1
Couplet_1 > msa2 > controller-2-1 > sas_channel-2-1-1
Couplet_1 > msa2 > controller-2-2
Couplet_1 > msa2 > controller-2-2 > sas_channel-2-2-1
switch1 > switch1_powersupply_2
switch2 > switch2_powersupply_2

Command Successful

NOTE: The example output is in a small font to fit on this specification page. As a CLI output,
the character string will simply wrap at the end of a terminal line.

hardware show problems

43

hardware show status
Description of Command Function
Provides status on all the hardware components of the StoreOnce system.
Command Syntax
hardware show status [detail] [dev-id]
Command Authority
Operator and Administrator
Command Object Requirements
Not applicable – no objects exist within this command.
Command Parameter Requirements
•

detail – This optional parameter provides a detailed output for the hardware components
selected. If not defined, only the device ID and its status are provided.

•

dev-id – This optional parameter selects a particular device and its immediate children to have
their statuses shown. If not defined, the top level status and device IDs of couplets (with their
nodes and storage arrays) and internal network switches are shown. The device ID of any
component can be found using the hardware show status command and then using that
device ID with the same command to view the device IDs of its subcomponents.

Requirements for Command Execution
•

The command entry must conform to the command syntax.

•

All parameter values must be valid; see the parameter descriptions for details.

Successful Command Output
Upon successful completion of the command, the status of the selected devices is shown.
NOTE:

If CLI paging is enabled, the output of this command is displayed with paging.

Command Operation during Abnormal Conditions
If any of the command execution requirements fail, command execution terminates. The hardware
status is not displayed and one of these error messages is displayed:
•

Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.

•

Command Failed – Component for the device ID does not exist in system

Examples
> hardware show status
dev-id
----------------Couplet_1
- msa1
- msa2
- hp85647867b2-2
- hp85647867b2-1
switch1
switch2
Command Successful

StatusText
---------down
warn
warn
up
up
up
up

> hardware show status msa1
dev-id
----------------msa1
- controller-1-1
44

StatusText
---------warn
up

Alphabetical List of Commands and Details

- controller-1-2
- enclosure-1-1
- enclosure-1-2
- raidset-1-1
- raidset-1-2
- raidset-1-3
- raidset-1-4
Command Successful

up
down
up
up
warn
up
up

> hardware show status Couplet_1 detail
dev-id
---------------------------------------------------------------------Couplet_1
Name
= Couplet_1
SerialNumber
= Couplet_1
Status
= 3
Id
= Couplet_1
FirmwareVersion
=
Type
= COUPLET
Vendor
= HP
SystemName
= HP B6200 StoreOnce Backup System
RolledUpStatus
= down
diagMessages
=
AdditionalProperties = groupId=null, displayIp=
- msa1
Name
= MSA
SerialNumber
=
Status
= 4
Id
= msa1
FirmwareVersion
=
Type
= STORAGE_ARRAY
Vendor
= HP
SystemName
= HP B6200 StoreOnce Backup System
RolledUpStatus
= unknown
diagMessages
=
AdditionalProperties = State=NEEDS ATTENTION
- msa2
Name
= MSA
SerialNumber
=
Status
= 4
Id
= msa2
FirmwareVersion
=
Type
= STORAGE_ARRAY
Vendor
= HP
SystemName
= HP B6200 StoreOnce Backup System
RolledUpStatus
= unknown
diagMessages
=
AdditionalProperties = State=NEEDS ATTENTION
- hp85647867b2-2
Name
= ProLiant DL380 G7
SerialNumber
= USE048N4JX
Status
= 2
Id
= hp85647867b2-2
FirmwareVersion
= P67 05/05/2011
Type
= SERVER
Vendor
= HP
SystemName
= HP B6200 StoreOnce Backup System
RolledUpStatus
= unknown
diagMessages
= Good
AdditionalProperties = UIDBeacon=On, ReleaseVersion=3.3.0-1222.16
- hp85647867b2-1
Name
= ProLiant DL380 G7
SerialNumber
= USE048N4JT
Status
= 2
Id
= hp85647867b2-1
hardware show status

45

FirmwareVersion
Type
Vendor
SystemName
RolledUpStatus
diagMessages
AdditionalProperties

=
=
=
=
=
=
=

P67 05/05/2011
SERVER
HP
HP B6200 StoreOnce Backup System
unknown
Good
UIDBeacon=On, ReleaseVersion=3.3.0-1222.16

Command Successful

NOTE: The example output is in a small font to fit on this specification page. As a CLI output,
the character string will simply wrap at the end of a terminal line.

46

Alphabetical List of Commands and Details

hardware show storage status
Description of Command Function
An alias for the system show status command. See “system show status” (page 126) for details.
Command Syntax
hardware show storage status

hardware show storage status

47

help
Description of Command Function
Provides information to assist in the use of the CLI.
Command Syntax
help [command]
Command Authority
Operator and Administrator
Command Object Requirements
Not applicable – no objects exist within this command entry.
Command Parameter Requirements
•

Command Group – A command group word may be included in the command entry. If this
parameter is included, it appears after “help” in the command entry.

•

Command – a command word may be included in the command entry. If this parameters is
included, it appear after “help” in the command entry.

Requirements for Command Execution
•

The command entry must conform to the command syntax

•

The parameters included in the command entry must be valid command groups or command
words.

Successful Command Output
Provides information on command sequences in the CLI.
Command Operation during Abnormal Conditions
Not applicable.
Example
# help
Global commands
_______________
•

help — List commands or get help for a specific command.

•

home — Go to the root level.

•

exit — Log out.

•

up — Go up one level.

Paths currently available
_________________________

48

•

accounts — manage user accounts.

•

alerts — commands related to display and settings of alerts and
events.

•

filesys — provides information on the Backup System file system.

•

hardware — manage Backup System hardware.

•

license — manage Backup System licenses.

•

logs — commands related to the logs generated by the Backup System.

•

net — commands related to the Backup System network configuration.

•

snmp — ommands related to management of appliance via the network

Alphabetical List of Commands and Details

•

support — create, delete or show support tickets.

•

system — commands related to configuration and system setup.

•

time — manage time related functions.

Commands currently available
____________________________
hpsupport — provides access to the HP support account with the HP support
authority level.
shell — creates a shell with root access on the server node.

help

49

license add
Description of Command Function
Provides for the installation of a StoreOnce appliance license. The license is entered as a 168
character string.
Command Syntax
license add 
Command Authority
Administrator
Command Object Requirements
Not applicable – no objects exist within this command entry.
Command Parameter Requirements
license – a license string must appear in the command entry after license add. The license
string is 168 characters in length. White space within the license is ignored. The license is purchased
by the customer and provided by HP.
Requirements for Command Execution
The command entry must conform to the command syntax.
Successful Command Output
Upon successful completion of the command, the following is displayed:
license added
Command Operation during Abnormal Conditions
•

If the command does not conform to the required syntax, the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.

•

If the license is invalid, the following is displayed:
Invalid License

Example
# license
2CSM GHTG
QNMV 4ZCQ
2LME EMJC

add QACA A99A H9PY KHUY UVA5 HW6F Y9JL KMPL B89H MZVU DXAU
L762 M7R6 EWJ9 KJVT D5KM EFVW TSNJ N6CJ 6KGC Q9R9 LB2K 5ART
5YEM Q3ZN FB79 N45F BAUG BKTG 6VAB 3KMW R42A WW64 2N5Q 2R9F
LBYF

license added

50

Alphabetical List of Commands and Details

license load
Description of Command Function
Provides for the installation of a StoreOnce appliance license. The license is entered as a file image
which exists in the StoreOnce appliances repository directory. The means by which the license file
is placed in the repository directory is outside the scope of the CLI.
Command Syntax
license load 
Command Authority
Administrator
Command Object Requirements
Not applicable – no objects exist within this command entry.
Command Parameter Requirements
file-image – The name of the license file in the StoreOnce directory must appear in the command
entry after license load. The license is purchased by the customer and provided by HP. The
means by which the license file is place in the StoreOnce appliance repository directory is beyond
the scope of the CLI.
Requirements for Command Execution
The command entry must conform to the command syntax.
Successful Command Output
Upon successful completion of the command, the following is displayed:
license loaded successfully
Command Operation during Abnormal Conditions
•

If the command does not conform to the required syntax, the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section

•

If the license is invalid, the following is displayed:
Command Failed – license invalid

Example
# license load HP_D2D_543467
license loaded successfully

license load

51

license show
Description of Command Function
Displays the licenses which are available for this StoreOnce appliance.
Command Syntax
license show
Command Authority
Administrator
Command Object Requirements
Not applicable – no objects exist within this command entry.
Command Parameter Requirements
Not applicable – no parameters exist within this command entry.
Requirements for Command Execution
The command entry must conform to the command syntax.
Successful Command Output
Upon successful completion, the command displays the serial number and available licenses for
the StoreOnce appliance.
Command Operation during Abnormal Conditions
If the command does not conform to the required syntax, the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.
Example
# license show
D2D Appliance
Model Number: 652428-B21
Product Serial Number: XXXXXXXX
Replication
lic# 1245656 Qty: 1
Additional 24 TB Storage lic# 3409723

52

Alphabetical List of Commands and Details

Qty: 2

logs show events
Description of Command Function
Lists all the items in the event log. If a severity parameter is included in the command entry, only
events at or greater than the defined severity are displayed.
Command Syntax
logs show events [severity {alert|warni|info}] [numofevents ]
(default = 20)
Command Authority
Operator, Administrator
Command Object Requirements
Not applicable – no objects exist within this command.
Command Parameter Requirements
severity – This is an optional parameter which filters which events are displayed. The parameter
appears after “logs show” in the command entry. It consists of the text “severity” followed by one
of these values:
•

alerts

•

warn

•

info

Requirements for Command Execution
The command entry must conform to the command syntax.
Successful Command Output
Upon successful completion of the command, the output is displayed as in the example below.
Command Operation during Abnormal Conditions
If the command does not conform to the required syntax, the following is displayed:
Command Failed - the command does not conform to the required syntax,
SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this
section.
Example
> logs show events
EVENT ID

TIMESTAMP

LEVEL

TEXT

FILESYSTEM HOST
USER NAME OPERATION
SEGMENT NUMBER PV NUMBER NIC
HBA
RELATED EVENT
-------- --------------- ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ---------------------- --------- --------- -------------- --------- ----------------------------- ------------644 Aug 3 19:00:41
INFO
Nic bond1:3 on host d2d78e7d1e6928e_node_1 inactive

643

Aug 3 18:59:55

d2d78e7d1e6928e_node_1
bond1:3
0
INFO
Nic bond1:1 on host d2d78e7d1e6928e_node_2 up

642

Aug 3 18:59:46

d2d78e7d1e6928e_node_2
bond1:1
0
INFO
Server d2d78e7d1e6928e_node_2 failed back

Aug 3 18:59:40

d2d78e7d1e6928e_node_2
0
Server d2d78e7d1e6928e_node_2 in failback

640

639

638

Aug 3 18:59:40

Aug 3 18:58:54

WARN

INFO

INFO

d2d78e7d1e6928e_node_2
0
Command from Local Host, user root: Failover for server d2d78e7d1e6928e_node_2.
d2d78e7d1e6928e_node_2
0
Nic bond1:1 on host d2d78e7d1e6928e_node_2 inactive
d2d78e7d1e6928e_node_2

logs show events

53

637

636

635

634

Aug 3 18:58:41

bond1:1
0
INFO
Nic bond1:3 on host d2d78e7d1e6928e_node_1 up

Aug 3 18:58:19

d2d78e7d1e6928e_node_1
bond1:3
0
WARN
Server d2d78e7d1e6928e_node_2 failed over

Aug 3 18:58:13

d2d78e7d1e6928e_node_2
0
Server d2d78e7d1e6928e_node_2 in failover

Aug 3 18:58:13

ALERT

INFO

d2d78e7d1e6928e_node_2
0
Command from Local Host, user root: Failover for server d2d78e7d1e6928e_node_2.
d2d78e7d1e6928e_node_2

NOTE: The example output is in a small font to fit on this specification page. As a CLI output,
the character string will simply wrap at the end of a terminal line.

54

Alphabetical List of Commands and Details

net activate config
NOTE:

This command applies to single-node products only.

Description of Command Function
Configures the external network.
IMPORTANT: If the network you are using for the CLI session is modified from this command,
your session may be terminated.
Command Syntax
net activate config 
Command Authority
Administrator
Command Object Requirements
netlabel – This required object identifies the network configuration whose data structure will be
used to configure the external network for the cluster.
Command Parameter Requirements
Not applicable – no parameters exist within this command.
Requirements for Command Execution
The following list shows some examples but is not a complete list of checks.
•

Verify the configuration structure according to the rules below:

◦

A default subnet must exist.

◦

Only one default subnet can exists.

◦

A gateway is required for the default subnet.

◦

The ports defined in a subnets must be valid options.

◦

If more than one port is defined in a subnet, all the ports must be the same type.

◦

The same port cannot be in two different subnets or defined twice in same subnet.

•

If DHCP is defined in any subnet, verify that the DHCP server exists.

•

Configure the external network as defined by the configuration data structure.

•

If defined, verify that the gateway exists.

Successful Command Output
Upon successful completion of the command, information on the external network configuration is
displayed.
Command Operation during Abnormal Conditions
If the command fails, the system will attempt to configure the external network using the original,
current configuration.
Example
# net activate config management

net activate config

55

net add subnet
NOTE:

This command applies to single-node products only.

Description of Command Function
Adds a subnet data structure to the network configuration.
Command Syntax
net add subnet  subnet