HP D2D2502i User's Guide

HP StoreOnce Backup System Single-nodeand Multi-node CLI Reference GuideAbstractThis document details the set of operations supported by the Common CL

3 Categorical List of CommandsTable 3 Commands by CategoryCommandsCommandGroup“accounts add” (page 13)accounts“accounts del” (page 15)“accounts modify

snmp set ro-communityDescription of Command FunctionDefines the ro-community string. In other words, it defines the passphrase for read-only access to

snmp show configDescription of Command FunctionDisplays information on the StoreOnce appliance’s SNMP configuration.Command Syntaxsnmp show configComm

SNMP V3 Trapsinks=================Trapsink Address Version Port User Name Auth Algorithm Auth Password Priv Algorithm Priv Password

snmp show userDescription of Command FunctionLists the SNMP user settings of all SNMP users unless a specific user name is included.Command Syntaxsnmp

support create ticketDescription of Command FunctionCreates a support ticket for the StoreOnce appliance.Command Syntaxsupport create ticketCommand Au

support del ticketDescription of Command FunctionDeletes support tickets which exist for the StoreOnce appliance.Command Syntaxsupport del ticket {TIC

support show ticketDescription of Command FunctionLists the support tickets that exist for the StoreOnce appliance.Command Syntaxsupport show ticketCo

system clear packagesDescription of Command FunctionClears all packages from the queue which have been loaded for update.Command Syntaxsystem clear pa

system clear repositoryDescription of Command FunctionDeletes all the files in the StoreOnce appliance repository directory.Command Syntaxsystem clear

system disable failoverNOTE: This command applies to multi-node products only.Description of Command FunctionDisables the failover feature on the Stor

Table 3 Commands by Category (continued)CommandsCommandGroup“net delete subnet” (page 62)“net modify config” (page 63)“net modify subnet” (page 65)“ne

system enable failoverNOTE: This command applies to multi-node products only.Description of Command FunctionEnables the failover feature on the StoreO

system load packagesDescription of Command FunctionLoads the queue with the packages for which the StoreOnce appliance will be updated. The updatepack

system rebootDescription of Command FunctionGracefully shuts down and reboots the entire StoreOnce appliance.Command Syntaxsystem rebootCommand Author

system set clioutputDescription of Command FunctionDefines the format of the command output. The format can be either ASCII text or xml; the defaultis

system set configDescription of Command FunctionRuns a step-based wizard to guide you through a complete series of system configuration steps:• Config

Configure Network [execute]?Please choose a template to apply: 1) Management on (2) 1Gb ports (bonded), Data/Replication on (2) 10Gb ports (bonde

(must be IPv4 X.X.X.X): Select bonding mode for 10GbE data bondenter 1 (Active/Backup), 4 (IEEE 802.3ad Dynamic Link Aggregation), or 6 (Activ

4 (IEEE 802.3ad Dynamic Link Aggregation), or 6 (Active Load Balancing),(default = 1): 1Enter 1GbE management network start IP address(must be

Enter Selection: 2Enter up to 2 ntp server names or ip addresses (space separated): 12.10.191.251 Cannot get time for NTP server 12.10.191.251Both sel

License(s):------------No licenses installedMENU Item 4The following configuration steps will be performed: Configure Network Configure Time Con

Table 3 Commands by Category (continued)CommandsCommandGroup“system show repository” (page 125)“system show status” (page 126)“system shutdown” (page

Verify Hardware health Configure Failover-> Finish Configuration and reboot Finish ConfigurationActions: execute) Perform the current step

system set descriptionDescription of Command FunctionDefines the string used to label and identify the StoreOnce appliance. This label is part of ther

system set pagecontrolDescription of Command FunctionEnables or disable the page control feature.Command Syntaxsystem set pagecontrol {on|off}Command

system show configDescription of Command FunctionDisplays information on the StoreOnce appliance system configuration.Command Syntaxsystem show config

system show packagesDescription of Command FunctionDisplays information on the software packages currently installed on the StoreOnce appliance andpac

system show repositoryDescription of Command FunctionDisplays the packages which have been transferred into the repository.Command Syntaxsystem show r

system show statusDescription of Command FunctionProvides status on the StoreOnce appliance system.Command Syntaxsystem show statusCommand AuthorityOp

------------ ------ -----Set 1 Running# system show statusStorage Set Status----------------- ------Service Sets 3, 4 No volumes foun

system shutdownDescription of Command FunctionGracefully shuts down the entire StoreOnce appliance.Command Syntaxsystem shutdownCommand AuthorityAdmin

system update packagesDescription of Command FunctionUpdates the system with the packages existing in the update queue or optionally defined in thecom

4 Alphabetical List of Commands and Detailsaccounts addDescription of Command FunctionCreates an account that interfaces with the StoreOnce appliance

time add ntpserverDescription of Command FunctionAdds a network time protocol server to use if ntp is enabled. Up to two ntp servers may be definedfor

ntp server(s) added successfullytime add ntpserver 131

time del ntpserverDescription of Command FunctionRemoves an ntp server which exists for the StoreOnce appliance.Command Syntaxtime del ntpserver {<

time reset timezoneDescription of Command FunctionResets the time zone for the StoreOnce appliance to the default of UTC. Local time is the same asUTC

time set timezoneDescription of Command FunctionSets the time zone for the StoreOnce appliance.Command Syntaxtime set timezone <timezonelabel>Co

The following information has been given: Britain (UK) Therefore TZ='Europe/London' will be used. Local time is now: Thu May

time set UTCDescription of Command FunctionSets the value of the system clock on the node with active fusion manager to the value definedwithin the co

time show configDescription of Command FunctionDisplays the time configuration and the StoreOnce appliances UTC and local times.Command Syntaxtime sho

vtl create cartridgeDescription of Command FunctionAdds a cartridge to an existing virtual tape library.Command Syntaxvtl create cartridge [SETX ] LIB

Requirements for Command Execution• The command entry must conform to the command syntax.• All object values must be valid; see the object description

lower case letters, numbers and the following symbols ! @ # $ % ^& *• If the account description is too long, the following is displayed:Command F

vtl create libraryDescription of Command FunctionCreates a virtual tape library. In addition, a virtual tape cartridge is created in every slot in the

• DriveEmulation – This optional parameter defines the type of physical drive the virtual tapedrive will emulate. The values are defined in the Comman

• BarcodeLength – This optional parameter defines the total number of characters in the barcodeused by the cartridges in the virtual tape library crea

◦ Command Failed - The number of drives must be between 0 and 192◦ Command Failed – Drive fibre channel port defined for <interface>interface◦ C

vtl delete cartridgeDescription of Command FunctionDeletes a single cartridge or all cartridges from a virtual tape library.Command Syntaxvtl delete c

Command Operation during Abnormal Conditions• If any of the command execution requirements fail, command execution terminates. Thecartridge is not del

vtl delete libraryDescription of Command FunctionDeletes a virtual tape library.Command Syntaxvtl delete library SETX LIBXCommand AuthorityAdministrat

Command Successfulvtl delete library 147

vtl modify cartridgeDescription of Command FunctionModifies the parameters of an existing cartridge.Command Syntaxvtl modify cartridge [SETX] LIBX [{C

Command Operation during Abnormal ConditionsIf any of the command execution requirements fail, command execution terminates. The cartridgeis not modif

accounts delDescription of Command FunctionDeletes an existing account.NOTE: Accounts can only be deleted if the user is logged in with an account wit

vtl modify driveDescription of Command FunctionModifies a drive which already exists within a library.Command Syntaxvtl modify drive SETX LIBX DRVX [D

Command SuccessfulCommand Operation during Abnormal ConditionsIf any of the command execution requirements fail, command execution terminates. The car

vtl modify libraryDescription of Command FunctionModifies an existing library.Command Syntax (multi-node products)vtl modify library SETX LIBX [name &

current value remains unchanged. If this parameter is changed, the number of slots and numberof drives currently defined must be less than that define

• tAuthenticationEnable – single-node only. This optional parameter determines if the CHAP(challenge handshake authentication protocol) target log on

• Command Failed – The library <LIBX> does not exist• Command Failed – Invalid Parameter: <parameter> value: <value>• Command Failed

vtl move cartridgeDescription of Command FunctionMoves a cartridge within a virtual tape library.Command Syntaxvtl move cartridge SETX LIBX [CARTX] [f

◦ Command Failed – The service set <SETX> does not exist◦ Command Failed – The library <LIBX> is invalid◦ Command Failed – The library <

vtl show capacityDescription of Command FunctionDisplays details on the library storage used and available at the cluster, service set, or library lev

SET1 LIB1 4 TB 20 TB 5:1 LIB2 5 TB 75 TB 15:1 Lib3 1

accounts modifyDescription of Command FunctionModifies the password of an existing account.Command Syntaxaccounts modify [ACCOUNT] password <curren

vtl show cartridgesDescription of Command FunctionDisplays information about the cartridges in a given library.Command Syntaxvtl show cartridges SETX

Library : LIB1Name: Gregslib Object Location Slot Barcode Max Size User Data Protected Mapped------ -------- ---- ------- --------

vtl show drive infoDescription of Command FunctionDisplays information about a given virtual drive or all the virtual drives in a given library.Comman

Command Successful# vtl show drive info SET1 LIB2 DRV1Drive Object : DRV1 Library : LIB1Library Name : GregsNextlib

vtl show drive listDescription of Command FunctionLists the drives in a library.Command Syntaxvtl show drive [SETX] [LIBX]Command AuthorityOperator an

# vtl show drive list SET1Object Type Service Set Library Name ------ ---- ----------- ------- ----

vtl show library infoDescription of Command FunctionDisplays library configuration information. The number of library configurations displayed depends

FC Address : 0x971623 WWPN : 5001438011A18945 Port : 2 FC Address : 0x9

Object : LIB1Name : Robslib>>>>Additonal Information<<<<Object

vtl show library iscsi authenticationNOTE: This command applies to single-node products only.Description of Command FunctionDisplays information on a

accounts showDescription of Command FunctionLists all the user accounts and their authority level defined for the StoreOnce appliance.Command Syntaxac

vtl show library listDescription of Command FunctionLists the libraries in a cluster.Command Syntaxvtl show library list [SETX]Command AuthorityOperat

vtl show portsDescription of Command FunctionProvides information on the Fibre Channel ports which can be used during the creation of a virtualtape li

VTL Port Physical Location ConfigurationNumber Slot Port Speed Connection---------- ---- ----- ----- ------

5 Support and other resourcesContacting HPFor worldwide technical support information, see the HP support website:http://www.hp.com/supportBefore cont

Table 4 Document conventions (continued)ElementConventionBold text• Keys that are pressed• Text typed into a GUI element, such as a box• GUI elements

GlossaryCCLI Command-line interface. An interface comprised of various commands which are used to controloperating system responses.command elements e

Wwhite space any combination of spaces, tabs and carriage returnsword an element whose characters having meaning in the natural language of the user.

IndexAaccessing the CLI, 6accountsadd, 13del, 15modify, 16show, 17alertsshow, 18alphabetical list of commands, 13Ccategorical list of commands, 10CLIa

repository directory, 7Sscripting, 7servicesetshow status, 81start, 82stop, 83snmpadd trapsink , 84add user , 87del trapsink , 89del user , 90disable,

alerts showDescription of Command FunctionLists all events with a severity of “critical” or “error.”NOTE: The command logs show events can also be use

config deleteDescription of Command FunctionDeletes a configuration file that exists in the configuration jail directory.Command Syntaxconfig delete &

© Copyright 2011–2013 Hewlett-Packard Development Company, L.P.Confidential computer software. Valid license from HP required for possession, use or c

config restore devicesDescription of Command FunctionRestores the StoreOnce system devices to the condition detailed in the defined device’s configura

◦ Command Failed – The system hardware does not match theconfiguration file (service set does not exist)◦ Command Failed – Configuration file has been

config save devicesDescription of Command FunctionSaves the device configuration to the configuration jail directory using the standard namingconventi

config show listDescription of Command FunctionDisplays a list of saved configuration files. A saved configuration file is any file located in theconf

exitDescription of Command FunctionTerminates a CLI session.Command SyntaxexitCommand AuthorityOperator and AdministratorCommand Object RequirementsNo

hardware add storageDescription of Command FunctionThis command adds storage which has been discovered using the hardware discover storagecommand (see

hardware beaconNOTE: This command applies to single-node products only.Description of Command FunctionTurns on or off the beacon for a hardware compon

hardware delete storageNOTE: This command applies to single-node products only.Description of Command FunctionDeletes storage segments associated with

◦ Command Failed – The storage volume is assigned to the D2D dedupedata file system◦ Command Failed – The storage volume is not part of D2D dedupedata

hardware disable failoverNOTE: This command applies to multi-node products only.Description of Command FunctionDisables the failover feature between n

Contents1 Using the CLI...6Introduction...

hardware discover storageDescription of Command FunctionDiscovers storage which has been connected to the StoreOnce appliance. Before this commandcan

hardware enable failoverNOTE: This command applies to multi-node products only.Description of Command FunctionEnables the failover feature between nod

hardware failbackNOTE: This command applies to multi-node products only.Description of Command FunctionReturns the file server node defined in the com

hardware failoverNOTE: This command applies to multi-node products only.Description of Command FunctionForces the implementation of the high availabil

hardware poweroffNOTE: This command applies to multi-node products only.Description of Command FunctionPowers down the StoreOnce appliance. If a file

poweroff request successfully senthardware poweroff 35

hardware powerupNOTE: This command applies to multi-node products only.Description of Command FunctionPowers up the StoreOnce appliance. If a file ser

hardware prepare storageDescription of Command FunctionAn alias for the hardware discover storage command. See “hardware discover storage”(page 30) fo

hardware rebootNOTE: This command applies to multi-node products only.Description of Command FunctionReboots the StoreOnce appliance nodes. If a file

hardware set portsNOTE: This command applies to single-node products only.Description of Command FunctionSets the node’s physical port parameters.Comm

net modify config...63net modify subne

hardware show net statusNOTE: This command applies to multi-node products only.Description of Command FunctionProvides status on the StoreOnce file se

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 t

hardware show node statusDescription of Command FunctionProvides status on the StoreOnce file server nodes. If a node object is included in the comman

hardware show problemsDescription of Command FunctionDisplays a list of the failed hardware components in the StoreOnce system.Command Syntaxhardware

hardware show statusDescription of Command FunctionProvides status on all the hardware components of the StoreOnce system.Command Syntaxhardware show

- controller-1-2 up - enclosure-1-1 down - enclosure-1-2 up - raidset-1-1 up - raidset-1-2 warn - raidset-1-3 up - raidset-1-4 u

FirmwareVersion = P67 05/05/2011 Type = SERVER Vendor = HP SystemName = HP B6200 StoreO

hardware show storage statusDescription of Command FunctionAn alias for the system show status command. See “system show status” (page 126) for detail

helpDescription of Command FunctionProvides information to assist in the use of the CLI.Command Syntaxhelp [command]Command AuthorityOperator and Admi

• support — create, delete or show support tickets.• system — commands related to configuration and system setup.• time — manage time related function

vtl delete cartridge...144vtl delete libr

license addDescription of Command FunctionProvides for the installation of a StoreOnce appliance license. The license is entered as a 168character str

license loadDescription of Command FunctionProvides for the installation of a StoreOnce appliance license. The license is entered as a file imagewhich

license showDescription of Command FunctionDisplays the licenses which are available for this StoreOnce appliance.Command Syntaxlicense showCommand Au

logs show eventsDescription of Command FunctionLists all the items in the event log. If a severity parameter is included in the command entry, onlyeve

bond1:1 0 637 Aug 3 18:58:41 INFO Nic bond1:3 on host d2d78e7d1e6928e_node_

net activate configNOTE: This command applies to single-node products only.Description of Command FunctionConfigures the external network.IMPORTANT: I

net add subnetNOTE: This command applies to single-node products only.Description of Command FunctionAdds a subnet data structure to the network confi

• bonding – This parameter defines network bonding modes. <mode> is 1, 4, or 6. See the HPStoreOnce Backup System Installation and Configuration

net copy configNOTE: This command applies to single-node products only.Description of Command FunctionCopies a network configuration.Command Syntaxnet

net create configNOTE: This command applies to single-node products only.Description of Command FunctionCreates a data structure that defines a networ

1 Using the CLIIntroductionThe Common CLI Command Set provides a method of communication with the StoreOnce appliancewhich is intuitive, consistent, a

• netmask – This optional parameter defines the netmask. If the IPAddr value is DHCP, a valueis not required for netmask.• gateway – This optional par

net delete configNOTE: This applies to single-node products only.Description of Command FunctionDeletes a network configuration.Command Syntaxnet dele

net delete subnetNOTE: This command applies to single-node products only.Description of Command FunctionDeletes a subnet configuration.Command Syntaxn

net modify configNOTE: This command applies to single-node products only.Description of Command FunctionModifies the parameters in an existing network

• domain – This optional parameter defines the domain name for the preceding subnetconfiguration.• IPAddr – This parameter defines an IP address. The

net modify subnetNOTE: This command applies to single-node products only.Description of Command FunctionModifies an existing named subnet configuratio

StoreOnce B6200 Backup System Installation Planning and Preparation Guide and Checklistsfor more detailed information about supported bonding modes.De

net pingDescription of Command FunctionVerifies communication by pinging a defined location.Command Syntaxnet ping [{NODEX|CLI|GUI}] [IPAddr <IPadd

net set configNOTE: This command applies to multi-node products only.Description of Command FunctionConfigures the external network to one of the five

• 10GbE management subnet mask• 10GbE management subnet mask• DNS server IP addresses (enter up to three, separated with commas)The information you ju

Table 1 Login Information (continued)Command PromptPasswordUser NameCan ExecuteAuthorization Levelthe StoreOnceappliance.Command EntryUpon log in, the

net set wizardNOTE: This command applies to single-node products only.Description of Command FunctionRuns a step-based wizard to guide you through the

Select bond configuration : 1.) eth0 and eth1 (1 Gig) (default)2.) eth3 and eth4 (10 Gig)1Select Static or DHCP addressing :1.) DHCP (default)2.) Stat

Step Complete. Do you want to :1.) Finish wizard and apply settings (default)2.) Go back to previous step: Step 2.)3.) Go back to start of present st

net show configNOTE: This command applies to multinode products only.Description of Command FunctionShows the network configuration.Command Syntaxnet

Domain Name:DNS server IP address(es): 16.110.135.51, 16.110.135.52IP Address Ranges Allocated for this B6200 system----------------------------------

net show configNOTE: This command applies to single-node products only.Description of Command FunctionShows the network configuration.Command Syntaxne

Write Protected: noDNS Servers:----------------------Number of Networks:1----------------------Network: subnet_one----------------------IP Address: dh

net show config listNOTE: This command applies to single-node products only.Description of Command FunctionLists all the labels of all the existing ne

net show portsNOTE: This command applies to single-node products only.Description of Command FunctionLists the ports that are available to use in subn

net show statusNOTE: This command applies to single-node products only.Description of Command FunctionDisplays information on the network status.Comma

2 Command Instruction SyntaxA StoreOnce appliance is controlled by operations. An operation is one or more of the followingevents:• Providing configur

net validate configNOTE: This command applies to single-node products only.Description of Command FunctionValidates a configuration. The command check

serviceset show statusDescription of Command FunctionThis command displays information on the selected or all service sets.Command Syntaxserviceset sh

serviceset startDescription of Command FunctionThis command starts the service sets. The command will either start the service set defined in thecomma

serviceset stopDescription of Command FunctionThis command stops the service sets. The command will either stop the service set defined in thecommand

snmp add trapsinkDescription of Command FunctionDefines a host to which the SNMP agent sends traps. Parameters for SNMP versions 1 and 2 differfrom th

Requirements for Command ExecutionThe command entry must conform to the command syntax.Successful Command OutputUpon successful entry of the command s

port 182 events information authentication-algo SHA

snmp add userDescription of Command FunctionCreates a new SNMP user.Command Syntaxsnmp add user USERNAME security-level {noAuthNoPriv|authNoPriv|authP

Command Successful, snmp user john-snmp added88 Alphabetical List of Commands and Details

snmp del trapsinkDescription of Command FunctionRemoves a trap host which has already been created using the snmp add trapsink command(see “snmp add

• The use of parenthesis such as (object) indicates a label for the object will be automaticallygenerated by the Common CLI application. No entry is r

snmp del userDescription of Command FunctionDeletes an existing SNMP user.Command Syntaxsnmp del user USERNAMECommand AuthorityAdministratorCommand Ob

snmp disableDescription of Command FunctionDisables the SNMP functionality.Command Syntaxsnmp disableCommand AuthorityAdministratorCommand Object Requ

snmp enableDescription of Command FunctionEnables the SNMP functionality.Command Syntaxsnmp enable [version {1|2|3}] [engine-id <engine-id>] [al

snmp modify trapsinkDescription of Command FunctionModifies the host to which the SNMP agent sends traps.Command SyntaxSNMP versions 1 and 2:snmp modi

Successful Command OutputUpon successful entry of the command sequence the trap host values are modified and the followingis displayed:SNMP versions 1

snmp modify userDescription of Command FunctionModifies an existing SNMP user.Command Syntaxsnmp modify user USERNAME security-level{noAuthNoPriv|auth

Example# snmp modify user john-snmp security-level noAuthNoPrivauthorization-algo MD5 authorization-pwd auth798wd privacy-algo AESprivacy-pwd priv945w

snmp reset ro-communityDescription of Command FunctionResets the ro-community string (the password to access the StoreOnce Management InformationBase)

snmp set contactDescription of Command FunctionDefines a text string indicating the contact person for SNMP agent management of this StoreOnceapplianc

snmp set locationDescription of Command FunctionDefines a text string indicating the location of the StoreOnce appliance containing the SNMPagent.Comm