HP StoreOnce Backup System 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 appliance 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 www.hp.
© Copyright 2011–2014 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.
Contents 1 Using the CLI.............................................................................................7 Introduction..............................................................................................................................7 Accessing the CLI.....................................................................................................................7 Command Entry........................................................................................................
hardware reboot....................................................................................................................74 hardware set ports..................................................................................................................75 hardware show firmware.........................................................................................................76 hardware show net status.........................................................................................
shell....................................................................................................................................157 snmp add trapsink................................................................................................................158 snmp add user.....................................................................................................................161 snmp del trapsink.......................................................................................
vtl vtl vtl vtl vtl vtl vtl vtl vtl vtl vtl vtl vtl modify drive....................................................................................................................239 modify library..................................................................................................................241 move cartridge.................................................................................................................246 show capacity...................................................
1 Using the CLI Introduction The Common CLI Command Set provides a method of communication with the StoreOnce appliance which is intuitive, consistent, and easy to use. The command set is broad in scope so that it can be used with the entire StoreOnce portfolio of products. The commonality of the CLI command set means that some unsupported commands are present in the CLI inline help (commands that are not applicable to your appliance or are accessible through a different CLI command).
Table 1 Login Information Authorization Level Can Execute Operator Administrator User Name Default 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 Admin provide information about the state and configuration of the StoreOnce appliance, plus commands that configure or change the configuration of the StoreOnce appliance.
NOTE: Note the following command entry information: • Use the up and down arrow key are used to scroll through previously entered command sequences; you can then edit and enter previous command sequences. This capability speeds the entry after entering multiple instances of similar command sequences. • A short form exists for each command. The short form comprises at least the first three characters of each command and be unique from other short form commands.
Scripting Scripting is performed using Expect, a UNIX automation and testing tool. To aid in parsing, the Common CLI can be configured to return XML formatted output (see “system set clioutput” (page 187)).
2 Command Instruction Syntax A StoreOnce appliance is controlled by operations. An operation: • Provides configuration information to the appliance • Requests an action • Obtains information about the appliance The execution of operations is initiated by instructions as shown in Table 2 (page 11). The instruction entry consists of a maximum of three parts: The command sequence, objects, and parameters. In Table 2 (page 11), the bottom row is referred to a command element.
• 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. • The use of parenthesis, such as (object) indicates a label for the object is automatically generated by the Common CLI application. No entry is required for this item.
Command Words Command elements are represented with words or hyphenated words selected to provide clear meaning of the associated action or subject. All the command elements used to represent operations or subjects within the different groups are listed below. (See “Categorical List of Commands” (page 16) for a list of the command elements used to represent groups.
Objects An object represents 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. Objects must be uniquely labeled. To achieve this requirement, when most objects are created the label of the object is automatically generated by the CLI application using the following convention: Object Label Description ARRAYX Storage array where X is a unique index.
For a few objects, the label is defined by the user using the following convention: Object Label Convention ACCOUNT The user provides a unique character string defining a log on account. CLIENT The user provides a unique character string defining a client certification. OBJECT The user provides a unique character string defining a catalyst object container. SMTPADDR The user provides a unique email address string defining the account.
3 Categorical List of Commands Table 3 Commands by Category Command Group Commands accounts “accounts add” (page 20) “accounts del” (page 22) “accounts modify” (page 23) “accounts show” (page 25) alerts “alerts show” (page 27) cifs “cifs add localadmin” (page 28) “cifs add user” (page 30) “cifs delete localadmin” (page 32) “cifs delete user” (page 34) “cifs disable domainjoin” (page 36) “cifs disable user” (page 38) “cifs enable domainjoin” (page 40) “cifs enable user” (page 42) “cifs modify config”
Table 3 Commands by Category (continued) Command Group Commands “hardware show problems” (page 81) “hardware show status” (page 82) “hardware show storage status” (page 84) “hardware update firmware” (page 85) help (see “Viewing Help” (page 9)) “help” (page 87) license “license add” (page 90) “license load” (page 92) “license refresh” (page 93) “license show” (page 94) “license show summary” (page 96) logs “logs show events” (page 98) “logs show update” (page 99) nas “nas create share” (page 101) “
Table 3 Commands by Category (continued) Command Group Commands “nfs disable host” (page 147) “nfs enable host” (page 149) “nfs modify host” (page 151) “nfs show config” (page 152) serviceset “serviceset show status” (page 153) “serviceset start” (page 154) “serviceset stop” (page 156) snmp “snmp add trapsink” (page 158) “snmp add user” (page 161) “snmp del trapsink” (page 162) “snmp del user” (page 163) “snmp disable” (page 164) “snmp enable” (page 165) “snmp modify trapsink” (page 166) “snmp modify u
Table 3 Commands by Category (continued) Command Group Commands “system shutdown” (page 205) “system update packages” (page 206) time “time add ntpserver” (page 207) “time del ntpserver” (page 208) “time reset timezone” (page 209) “time set timezone” (page 210) “time set UTC” (page 212) “time show config” (page 213) vtl “vtl create cartridge” (page 217) “vtl create library” (page 220) “vtl delete cartridge” (page 226) “vtl delete cartridges” (page 228) “vtl delete library” (page 231) “vtl erase cartrid
4 Alphabetical List of Commands and Details accounts add Description of Command Function Creates an account that provides access to the StoreOnce appliance using the CLI or GUI. NOTE: A default account exists with administrator authority level and has the user name, Admin, and the password, admin. You cannot delete that account, but you can and should modify its password.
by this parameter (i.e., the password is case sensitive). This parameter is valid only for users of type local; authentication of external accounts is managed by an authentication service, such as Active Directory. NOTE: Some passwords cannot be created and are rejected if they are based on common words or known, insecure key patterns. Be sure to use valid passwords without using common words or invalid patterns. Requirements for Command Execution The command entry must conform to command syntax.
accounts del Description of Command Function Deletes an existing account. NOTE: Accounts can only be deleted if the user is logged in with an Administrator level account. The delete option is not available to Operator level users. Command Syntax accounts del Command Authority Administrator Command Object Requirements ACCOUNT – This required object is a string matching the label of an existing account. The default Administrator account, Admin, cannot be deleted.
accounts modify Description of Command Function Modifies an existing account. Command Syntax accounts modify [ACCOUNT] [newpassword ] [level {admin|user}] Command Authority Administrator and Operator Command Object Requirements ACCOUNT – This object is the name of an existing account. Command Parameter Requirements • newpassword – This parameter specifies the new password for the account. The length of password must be greater than 0 and lesser than or equal to 24 characters.
• If the account label included in the command does not match an existing account, the following is displayed: No such D2D User: ACCOUNT • If a password being modified is a known blacklisted weak password, the following is displayed: Failed to change user password for account NOTE: Some passwords cannot be created and are rejected if they are based on common words or known, insecure key patterns. Be sure to use valid passwords without using common words or invalid patterns.
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 and Operator Command Object Requirements CURRENT – This is optional parameter returns details on only the currently logged in user’s account. If the user is logged in as an Operator level user, then details about that user’s own account is displayed. The CURRENT parameter is not required.
# accounts show current User Name --------Admin 26 Type ---------Local User Authority --------admin Alphabetical List of Commands and Details
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 98). Command Syntax alerts show [verbose] [numofevents ] Command Authority Operator, Administrator Command Object Requirements Not applicable – no objects exist within this command.
cifs add localadmin Description of Command Function Used the cifs add localadmin command only when CIFS authentication is set to AD. Adds a local administrator to the CIFS server’s BUILTIN\Administrators group. The local administrator is used also to allow users that are not Active Directory domain administrators to perform share management on the StoreOnce appliance.
• If the local administrator name provided contained invalid characters or was an invalid length, the following is displayed: Invalid domain name • If the CIFS sever authentication mode is not set to Active Directory, the following is displayed. Local administrators are not configurable in any other authentication mode. CIFS Authentication is not AD Example # cifs add localadmin name name1@servername.
cifs add user Description of Command Function The cifs add user command is Used when the CIFS server authentication is set to User. Adds a user to the CIFS server. Command Syntax cifs add user [SETX] name password Command Authority Administrator Command Object Requirements SETX – This object defines the service set where the NAS share is to be created. X is the numeric index of the service set. This object is required for a multi-node system and optional for a single-node system.
• If a user with this name already exists within the NAS subsystem, the following is displayed. Note that user names must be unique.
cifs delete localadmin Description of Command Function Deletes local administrator from the CIFS server’s BUILTIN\Administrators group. Used only when the CIFS server authentication mode is set to AD. Command Syntax cifs delete localadmin [SETX] name Command Authority Administrator Command Object Requirements SETX – This object defines the service set where the NAS share is to be created. X is the service set numeric index.
• If the local administrator name provided contained invalid characters or was an invalid length, the following is displayed: Invalid domain name • If the CIFS sever authentication mode is not set to Active Directory, the following is displayed. Local administrators are not configurable in any other authentication mode. CIFS Authentication is not AD Example # cifs delete localadmin name servername\name1 Command Successful # cifs delete localadmin name name1@servername.
cifs delete user Description of Command Function Deletes user from CIFS server. Used only when the CIFS server authentication is set to User. Command Syntax cifs delete user [SETX] name Command Authority Administrator Command Object Requirements SETX – This object defines the service set where the NAS share is to be created. X is the numeric index of the service set. This object is required for a multi-node system and optional for a single-node system.
• If the current CIFS server authentication mode does not support user management, the following is displayed: NAS User is already configured • If the user name provided does not exist within the NAS subsystem, the following is displayed. X shows the nonexisting user name.
cifs disable domainjoin Description of Command Function Causes the CIFS server to leave the Active Directory domain. Used only when the CIFS server authentication mode is set to AD. Command Syntax cifs disable domainjoin [SETX] Command Authority Administrator Command Object Requirements SETX – This object defines the service set where the NAS share is to be created. X is the service set numeric index. This object is required for a multi-node system and optional for a single-node system.
Example # cifs disable domainjoin Command Successful cifs disable domainjoin 37
cifs disable user Description of Command Function Disables specific user authentication for the CIFS share. Used only when the CIFS server authentication mode is set to User. Command Syntax cifs disable user [SETX] SHAREX name Command Authority Administrator Command Object Requirements SETX – This object defines the service set where the NAS share is to be created. X is the service set numeric index. This object is required for a multi-node system and optional for a single-node system.
• If a Share ID is required and was not specified, the following is displayed: Share ID (SHAREX) not specified – • If a share does not exist at the index provided by the SHAREX object, the following is displayed. X shows the index at which no share exists. No such Share: X • If the user name provided was not found within the NAS subsystem, the following is displayed. This message may also be shown if the share ID (SHAREX) is not for a valid CIFS share.
cifs enable domainjoin Description of Command Function Causes the CIFS server to join to an Active Directory domain. Use this command after switching the CIFS authentication mode to AD and specifying a domain to join using the cifs modify config command. NOTE: This command may take up to 120 seconds to complete.
• If the CIFS sever authentication mode is not set to Active Directory, the following is displayed. Local administrators are not configurable in any other authentication mode. CIFS Authentication is not AD • If the process of joining the Active Directory domain failed, the following is displayed. Be sure to check that the username and password are correct.
cifs enable user Description of Command Function Enables specific user authentication for the CIFS share. Used when the CIFS server authentication mode is set to User. Command Syntax cifs enable user [SETX] SHAREX name Command Authority Administrator Command Object Requirements SETX– This object defines the service set where the NAS share is to be created. X is the service set numeric index. This object is required for a multi-node system and optional for a single-node system.
• If a required share ID was not specified, the following is displayed: Share ID (SHAREX) not specified • If a share does not exist at the index provided by the SHAREX object, the following is displayed. X shows the index at which no share exists. No such Share: X • If the user name provided was not found within the NAS subsystem, the following is displayed. This message may also be shown if the share ID (SHAREX) is not for a valid CIFS share.
cifs modify config Description of Command Function Modifies CIFS server configuration. Command Syntax cifs modify config [SETX] [servername ] [workgroup ] [auth {None|User|AD domain }] [smbSigning {Required|Optional}] NOTE: Note the following when using the cifs modify config CLI command: • The smbSigning parameter is not valid in v3.11.0 of the CLI command set.
The following list defines common detailed error messages and their meanings: • If the command entered does not conform to the command syntax, the following is displayed. Invalid number of arguments • If a parameter which requires an argument value was provided without an argument, the following is displayed. X shows the name of the parameter. Parameter X requires argument • If one of the parameters provided does not conform to the command syntax, the following is displayed.
cifs modify user Description of Command Function Modifies the CIFS user password. Used when the CIFS server authentication mode is set to User. Command Syntax cifs modify user [SETX] name password Command Authority Administrator Command Object Requirements SETX – This object defines the service set where the NAS share is to be created. X is the service set numeric index . This object is required for a multi-node system and optional for a single-node system.
• If the user name provided does not exist within the NAS subsystem, the following is displayed. X shows the nonexisting user name. No such user: X • If a parameter was provided with an invalid value, the following is displayed. This issue may be caused by providing a value outside of the supported range or with invalid characters. X shows the invalid value provided.
cifs show config Description of Command Function Displays CIFS server configuration information. Command Syntax cifs show config [SETX] Command Authority Administrator Command Object Requirements • localadmin – This object shows users in the CIFS server BUILTIN\Administrators group. • config – This object shows the CIFS server configuration. Command Parameter Requirements Not applicable – no parameters exist within this command.
cifs show localadmin Description of Command Function Lists the names of local administrators currently in the CIFS server BUILTIN\Administrators group. Used when the CIFS server authentication mode is set to AD. Command Syntax cifs show localadmin [SETX] Command Authority Administrator Command Object Requirements SETX – This object defines the service set where the NAS share is to be created. X is the service set numeric index.
Example 2: # cifs show localadmin Admin: Admin: Admin: Command Successful 50 Alphabetical List of Commands and Details ApplianceName\Administrator ServerName\domain^admins ServerName\name1
config delete Description of Command Function Deletes a configuration file existing 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.
config restore devices Description of Command Function Restores 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 55).
• ◦ 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.
config restore keystore Description of Command Function Restores a saved keystore from the file specified to the device. This operation requires the password originally given to the save command in order to decrypt the keystore. WARNING! This command overwrites the existing system keystore. If an up-to-date backup of the keystore is unavailable, permanent and unrecoverable access to encrypted data may occur.
config save devices Description of Command Function Saves the device configuration to the configuration jail directory using the standard naming convention of devconfig_ .zip. (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.) NOTE: This command only works if storage systems are in a Good state.
config save keystore Description of Command Function Saves keystore information to a file in the configuration jail directory that can be retrieved, if needed. (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 save keystore NOTE: You are prompted for a password with which to encrypt the keystore after this command is received with the keystore parameter.
config show list Description of Command Function Displays a list of saved configuration files or keystores. A saved configuration file is any file located in the config directory with the .zip extension which is accessible through the SFTP. (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.
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 command syntax. Successful Command Output Not applicable – after command execution, the terminal is closed.
filesys show config Description of Command Function Provides information on the StoreOnce appliance file system structure. Command Syntax filesys show config Command Authority HP Support 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 command syntax.
hardware add storage Description of Command Function Adds storage which has been discovered using the hardware discover storage command (see “hardware discover storage” (page 66)). Before this command can be executed, newly discovered storage must exist as presented using the system show status command (see “system show status” (page 201)). At least one storage set must exist with a status of discovered (XXTB), where XX cannot be equal to zero.
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 { dev-id [ALL] | ALL } { 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.
• 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.
hardware delete storage NOTE: This information applies to single-node products only. Description of Command Function Deletes storage volumes associated with the StoreOnce Backup system. This command does not apply to the storage on which each node’s operating system is located. Command Syntax Hardware delete storage {ALL|dev-id} Command Authority Administrator (single-node systems)/HP Support (multi-node systems) Command Object Requirements Not applicable – no objects exist within this command.
• ◦ 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.
hardware disable failover NOTE: This information applies to multi-node products. 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.
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 201)).
hardware enable failover NOTE: This information applies to multi-node products. Description of Command Function Enables the failover feature between nodes which had been disabled using the hardware disable failover command (see “hardware disable failover” (page 65)). Command Syntax hardware enable failover [NODEX] Command Authority Administrator Command Object Requirements NODEX – As an option, this object can be used to define an individual file server node. X is a unique numeric index.
hardware failback NOTE: This information applies to multi-node products. 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 69)).
hardware failover NOTE: This information applies to multi-node products. Description of Command Function Forces the implementation of the high availability feature for the file server node defined within the command. After this command is executed, the backup node within the couplet takes over the service set functions originally residing on the defined node.
hardware poweroff WARNING! This command uses the iLO port to turn off the server, which does not allow StoreOnce service sets to shut down gracefully. This results in de-duplication stores shutting down in an unclean state and requiring integrity checking (an automatic process) on the next power up. To avoid this condition, the service set on a given node should be failed over to the backup node using the hardware failover nodeX command before powering down the node.
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.
hardware powerup NOTE: This information applies to multi-node products. Description of Command Function Powers up the StoreOnce appliance. If the file server node is defined in the command entry, only that 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.
hardware prepare storage Description of Command Function Acts an alias for the hardware discover storage command. See “hardware discover storage” (page 66) for details.
hardware reboot NOTE: This command applies to multi-node products. Description of Command Function Reboots StoreOnce appliance nodes. If a file server node is defined in the command entry, only that 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.
hardware set ports Description of Command Function Sets the node’s physical port parameters and parameters for the VTL FC ports. This command supports all appliances that support Fibre Channel. 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.
hardware show firmware Description of Command Function Shows server and storage firmware components. Command Syntax hardware show firmware [NODEX|storageX|switchX] Command Authority Operator and Administrator Command Object Requirements • NODEX – This optional parameter can be used to define an individual file server node. X is a unique numeric index defining the hardware component and applies only to multi-node products.
PCIeNIC SERVER_HDD SERVER_HDD Smart_Array_Ctlr NONE NONE NONE NONE 4.6.247.5 HPD5 HPD5 5.
hardware show net status NOTE: This command applies to multi-node products. 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.
No hp31504d7870-1 .1.5.5 No hp31504d7870-2 .78.8.172 No hp31504d7870-2 .1.5.7 No hp31504d7870-2 No hp31504d7870-2 .1.5.8 No hp31504d7870-2 .154.4.2 No hp31504d7870-3 .1.5.9 No hp31504d7870-3 .1.5.10 No hp31504d7870-3 .154.4.3 No hp31504d7870-3 No hp31504d7870-3 .78.8.
hardware show node status Description of Command Function Provides a status on 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 – This optional object is used to define an individual file server node. X is a unique numeric index.
hardware show problems Description of Command Function Displays a list of 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 command syntax.
hardware show status Description of Command Function Provides a status on all hardware components in 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.
Specific device status: # hardware show status switch1 Name --------------------HP 5920AF-24XG Switch Fans PowerSupplies TemperatureSensors Dev-id --------------------switch1 switch1_fans switch1_powerSupplies switch1_tempsensors Status -----OK OK OK OK NOTE: The example output is in a small font to fit on this specification page. As a CLI output, the character string wraps at the end of a terminal line.
hardware show storage status Description of Command Function Acts as an alias for the system show status command. See “system show status” (page 201) for details. Command Syntax hardware show storage status Command Authority Administrator Command Object Requirements status – This object provides storage status information. Command Parameter Requirements Not applicable - no parameters exist within this command. Requirements for Command Execution The command entry must conform to command syntax.
hardware update firmware Description of Command Function Updates the firmware for the defined hardware type. Command Syntax hardware update firmware [force] [user] [password] Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command. Command Parameter Requirements • NODEX – This optional parameter is used to define an individual file server node. X is a unique numeric index defining the hardware component.
Examples Updating the server firmware for node1 with the force option: # hardware update firmware node1 force Updating the storage firmware for storage: hardware update firmware storage1 Updating the firmware for all switches in the cluster: # hardware update firmware switch1 force user1 password1 Command Successful 86 Alphabetical List of Commands and Details
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 is entered. • Command – A command word may be included in the command entry.
• net – commands related to the Backup System network configuration. • nfs – manage NFS server. • serviceset - provides information on the D2D serviceset. • snmp – manage snmp related functions. • support – create, delete or show support tickets. • system – commands related to configuration and system setup. • time – manage time related functions. • vtl – manage vtl-related functions.
hpsupport Description of Command Function Provides access to the HP support authority level. Command Syntax hpsupport Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command entry. Command Parameter Requirements hp-password – A string with the HP password must appear after hpsupport in the command entry. The HP password is controlled by the HP service organization.
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.
# license add YDKC D9AA H9PA GHW3 VBB5 HW6V Y9JL KMPL P7JD 5GBE UVUW JH2E BQXP PW9W ENQG HXBA KFVS D5GM EWTP H2SC HKKA DXYD QSHA Z9QM DRPE AQVB 9WKR NBYY P2ZV RHMQ N43J SGGB JWHG 9UMF L8EW R42A V886 FCYX ZKWC K7AD WRRB JKFK M2VH KMMU 4NMU FGM6"HP StoreOnce 4500 Catalyst LTU" license added.
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.
license refresh Description of Command Function Refreshes the license state across the cluster, initiating a manual license check cycle that goes though the list of installed licenses and sets the appropriate license status flag on each node in the cluster. Used when the license state on a node is incorrect following a filesystem rebuild. Command Syntax license refresh Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command entry.
license show Description of Command Function Displays currently installed licenses 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 command syntax.
Name: HP StoreOnce 4500 Replication LTU Description: HP StoreOnce 4500 Replication LTU (Instant-On) Valid From: May 19, 2014 00:00:00 AM UTC Expiration: August 16, 2014 23:59:59 PM UTC Days Remaining: 90 Capacity: N/A Feature ID: 9163 License Type: Instant-On LTU: Whole system (Instant-On) Message: Key: N/A Example showing a newly added license on a single-node system: # license show Licenses: Name: HP StoreOnce Description: HP StoreOnce Valid From: May 01, 2014 Expiration: May 31, 2014 Days Remaining: 1
license show summary Description of Command Function Shows summary information about the type and number of licenses installed. Command Syntax license show summary 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 command syntax.
Expiration: Capacity: LTU: Message: May 31, 2014 00:00:00 AM UTC N/A 1 Example showing summary information of an invalid licensing on a multi-node system: # license show summary A Summary of installed licenses: Description: Capacity: LTU: Replication licenses summary. N/A 1 Description: Capacity: LTU: Catalyst licenses summary.
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|warn|info}] [numofevents ] (default = 20) Command Authority Operator and Administrator Command Object Requirements Not applicable – no objects exist within this command.
logs show update Description of Command Function Provides logs of all software updates that have occurred on the system. Command Syntax logs show update 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 command syntax.
14:28:32 node 6 : Installing: D2D_Master-3.9.0-1336.2 14:28:32 node 4 : Installing: D2D_Master-3.9.0-1336.2 14:33:47 node 6 : Install successful 14:33:49 node 8 : Install successful 14:33:52 node 5 : Install successful 14:33:52 node 4 : Install successful 14:33:54 node 7 : Install successful 14:33:54 node 3 : Install successful 14:33:55 node 1 : Install successful 14:33:55 node 2 : Install successful 14:33:55 Package installation successful. 14:33:55 Updating firmware to arrays.
nas create share Description of Command Function Creates either a CIFS or NFS share. Command Syntax nas create share [SETX] SHAREX proto {CIFS|NFS} [name ] [desc ] [readonly {yes|no}] [encrypt {yes|no}] [dedupe {yes|no}] [version {1|2}] Command Authority Administrator Command Object Requirements • SETX – This required object defines the service set where the NAS share is to be created. X is the numeric index of the service set.
Command Operation during Abnormal Conditions • If command execution fails, one of the following messages is displayed: ◦ Command Failed ◦ Command Failed - A share already exists at id 1 Examples # nas create share SET1 SHARE0 proto NFS Command Successful # nas create share SET1 SHARE1 proto CIFS name Share1 desc CIFS share readonly yes Command Successful Deduping example: nas create share SET1 SHARE0 proto NFS nas create share SET1 SHARE1 proto CIFS encryption yes dedupe no nas create share SET1 SHAR
nas delete share Description of Command Function Deletes either a CIFS or NFS share. Command Syntax nas delete share [SETX] {SHAREX|ALL} Command Authority Administrator Command Object Requirements • SETX – This required object is a service set where the NAS share is to be deleted. X is the numeric index of the service set. This object is required for a multi-node system and optional for a single-node system. If it is omitted for a single-node system, it defaults to SET1.
nas modify share Description of Command Function Allows you to modify existing NAS shares. Command Syntax nas modify share [SETX] SHAREX [desc ] [readonly {yes|no}] [secureerase {yes|no}] \ [version {1|2}] Command Authority Administrator Command Object Requirements • SETX – This required object is a service set where the NAS share is to be modified. X is the numeric index of the service set. This object is required for a multi-node system and optional for a single-node system.
# nas modify share share4 secureerase yes Command Failed - Invalid parameter 'secureerase' nas modify share 105
nas show share Description of Command Function Displays NAS share details or a list of all NAS shares. Command Syntax nas show share [setX] {shareX|all} Command Authority Operator and Administrator Command Object Requirements • SETX – This required object indicates the service set where the NAS share is to be shown. X is the numeric index of the service set. This object is required for a multi-node system and optional for a single-node system. If it is omitted for a single-node system, it defaults to SET1.
# nas show share SHARE0 ID Protocol Name Network Name Description Created On Modified On Status Health Replication Role Replication Status Replication Health User Bytes Disk Bytes Dedupe Ratio Files Directories Read-only Encryption Enabled Deduplication Enabled Share Version Authentication Command Successful 0 NFS Share_1 /nas/Share_1 HP StoreOnce Share 1 09:10 2014/06/02 09:10 2014/06/02 Online OK Non Replicating Non Replicating Information 0 380 0.
net activate config Description of Command Function Configures the external network. IMPORTANT: If the network being used for the CLI session is modified from this command, that session may terminate. NOTE: Use the net show config list command to view valid netlabels.
• 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 attempts to configure the external network using the original, current configuration.
net activate status Description of Command Function Displays the status of the previous activate operation. Command Syntax net activate status 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 command syntax.
net add encryption Description of Command Function Adds a new encrypted link configuration to a network configuration. This command is used when configuring data in flight encryption (where encryption is applied at IP address level). Data in flight encryption requires the Security Pack license. NOTE: Backup or restore performance may decrease when data in flight encryption is turned on. The amount of decrease in performance depends on the: • CPU and memory resources of the backup media servers.
net add ipaddr Description of Command Function Adds a new IP address to a subnet in a configuration. Command Syntax net add ip addr Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command. Command Parameter Requirements • netlabel – This parameter specifies the network configuration name. • sublabel – This parameter specifies the subnet name.
net add portset Description of Command Function Adds a port set to a configuration. Command Syntax net add portset ports 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. Command Parameter Requirements • configName – This parameter specifies the network configuration name.
net add subnet NOTE: This command applies to single-node products only. Description of Command Function Adds a new subnet to a network configuration. Command Syntax net add subnet subnet [ params ] Command Authority Administrator Command Object Requirements • netlabel – This object specifies the network configuration name and identifies the network configuration to which the subnet is added. This is not case sensitive.
• bonding – This parameter defines network bonding modes (e.g., is 1, 4, or 6). See the HP StoreOnce Backup System Installation and Configuration guide for more detailed information on supported bonding modes and related templates. Bonding mode Description Default Bonding Mode for: Mode 1 (Active/Backup) A simple bonding mode that allows network traffic through one active port only. If the active network fails, then traffic moves to the backup port. Templates 1, 3, 4, and 5 Mode 4 (IEEE 802.
NOTE: The example output is in a small font to fit on this specification page. As a CLI output, the character string wraps at the end of a terminal line.
net copy config Description of Command Function Copies a network configuration. Command Syntax net copy config from to Command Authority Administrator Command Object Requirements • netlabel – The data structure in this network configuration is copied to the new network configuration object created by this command. • newnetlabel – This network configuration object is created by this command.
net create config Description of Command Function Creates a data structure that defines a network configuration. (A default data structure exists as part of the initial installation.
• subnet – This is the user-specified subnet name (required). ◦ default {yes | no} – This parameter sets this subnet as the default subnet. ◦ netmask –This parameter specifies the subnet mask in x.x.x.x format. ◦ domain – This parameter specifies the domain name. ◦ portset – This parameter indicates the port set name to use for this subnet. ◦ netusage {mgmt | data | both} – This parameter indicates whether the network traffic is management, data, or both.
Example # net create config management dns dhcp To create a default configuration: # net create config myconfig To create config with a single subnet with some parameters initialized: # net create config myconfig subnet sub1 default yes netusage both To create a complete configuration with a VLAN tag: # net create config myconfig dns 192.168.10.10,192.168.10.12 mgmtvif 172.16.0.
net delete config Description of Command Function Deletes a network configuration. Command Syntax net delete config Command Authority Administrator Command Object Requirements netlabel – This label identifies the network configuration to be deleted. This label is case insensitive. Command Parameter Requirements Not applicable – no parameters exist within this command. Requirements for Command Execution • The command entry must conform to command syntax. • The object value must be valid.
net delete encryption Description of Command Function Deletes all data in flight encryption links from a subnet configuration. Command Syntax net delete encryption [ ] Command Authority Administrator Command Object Requirements • netlabel – This object specifies the network configuration name. • sublabel – This object specifies the subnet name. Command Parameter Requirements • ipList – This parameter specifies a comma-separated list of IPs to be deleted.
net delete ipaddr Description of Command Function Deletes a network IP address or all IP addresses in a subnet. Command Syntax # net delete ipaddr 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 command syntax.
net delete portset Description of Command Function Deletes a port set or ports in a port set. Command Syntax net delete portset [ports ] Command Authority Administrator Command Parameter Requirements • configName – This object specifies the network configuration name. • portSetName –This object specifies the port set name. Command Parameter Requirements ports – This parameter specifies a comma-separated list of ports to delete.
net delete subnet Description of Command Function Deletes a subnet configuration. Command Syntax net delete subnet Command Authority Administrator Command Object Requirements • netlabel – This label identifies the network configuration to which the subnet is to be added. This label is case insensitive. • sublabel – This label identifies the subnet configuration within the defined network configuration that is to be deleted. This label is case insensitive.
net modify config Description of Command Function Modifies the parameters in an existing network configuration.
IMPORTANT: If a parameter is undefined in the modify command sequence, the current parameter value remains unchanged. If a parameter is given the value undefined, a value is no longer declared for the parameter. Requirements for Command Execution • The writeprotect parameter must be set to NO for this command to execute. (The writeprotect parameter can be modified independent of the current state of the writeprotect parameter.) • The command entry must conform to command syntax.
net modify subnet Description of Command Function This command modifies parameters in a named subnet of a saved configuration. It is not possible to modify the default configuration. To add or remove IP addresses, use net add ipaddr or net delete ipaddr. NOTE: It is not possible to modify the default configuration.
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 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.
net ping Description of Command Function Verifies communication by pinging a defined location. Command Syntax net ping [{NODEX|CLI|GUI}] [IPAddr ]|[FQN ] Command Authority Operator and Administrator Command Object Requirements • NODEX – This object defines which node should transmit the “ping” packet. X is the index which uniquely defines each node in the cluster. It is optional on a single-node system but must be defined on a multi-node system if the GUI or the CLI parameter is not defined.
net set wizard NOTE: This command applies to single-node products only. Description of Command Function Runs a step-based wizard to guide you through the creation of a complete network configuration. Command Syntax net set wizard 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.
Step 2.)Configure network settings for available network adapters Select the type of configuration for this subnet : 1.) Single port (default) 2.
<--Another subnet: Yes - on the same VLAN port set Enter VLAN tag (an integer between 2 and 4094 inclusive) : -->555 <--VLAN Tag: 555 Select Static or DHCP addressing : 1 = DHCP (default) 2 = Static -->1 <--DHCP/Static: DHCP Do you want to configure a static default gateway for this subnet or get the gateway information from DHCP? 1 = Gateway obtained from DHCP server (default) 2 = Set gateway manually -->1 <--Gateway: Gateway obtained from DHCP server Do you want to configure the network domain name or get
Do you want to configure the network domain name or get the domain name from DHCP? 1 = Domain name obtained from DHCP server (default) 2 = Set domain name manually (e.g. mydomain.
net show config Description of Command Function Shows the network configuration. Command Syntax net show config Command Authority Operator and Administrator Command Object Requirements netlabel – This object defines the name of the specific network configuration to be shown. If the object is not included in the command sequence, the parameter, all, must be included in the command sequence. Command Parameter Requirements • all– This parameter is optional.
Network Description: default Write Protected: no DNS Servers: ---------------------Number of Networks:1 ---------------------Network: subnet_one ---------------------IP Address: dhcp Net Mask: dhcp Domain Name: dhcp Gateway: dhcp Bonding Mode: 6 (High Availability) Default Network: yes Interfaces:eth0 ---------------------Network Name: current Network Description: default Write Protected: no DNS Servers: ---------------------Number of Networks:1 ---------------------Network: subnet_one ---------------------
net show ipaddr Description of Command Function Displays the IP addresses for the configurations subnet. Command Syntax net show ipaddr Command Authority Administrator Command Object Requirements • netlabel – This object specifies the network configuration name. • sublabel – This object specifies the subnet name. Command Parameter Requirements Not applicable – no parameters exist within this command.
net show ports NOTE: This command applies to single-node products only. Description of Command Function Lists the ports that are available to use in subnet configurations. Command Syntax net show ports [NODEX] Command Authority Operator and Administrator Command Object Requirements NODEX – This object determines that port information will be provided for individual nodes verses the entire cluster.
P5 P6 eth5 eth7 - 10 Gig 10 Gig Bonding Modes Supported 1: Active Passive Bonding 4: Link Aggregate Control Protocol (LACP) Bonding 6: Active Load Balance Bonding Command Successful net show ports 139
net show portset Description of Command Function Displays the network port set Command Syntax net show portset Command Authority Administrator Command Object Requirements • configName – This object specifies the network configuration name. • portSetName – This object specifies the port set name. Command Parameter Requirements Not applicable – no parameters exist within this command. Command Parameter Requirements Not applicable – no parameters exist within this command.
net show status Description of Command Function Displays information on the network status. Command Syntax net show status [subnet ][port ][all] Command Authority Operator and Administrator Command Object Requirements Not applicable – no parameters exist within this command. • NODEX – This object determines that status information will be provided for individual nodes verses the entire cluster.
Subnet Subnet Subnet Subnet ab44xx1abcd0-1 ab44xx1abcd0-1 ab44xx1abcd0-2 ab44xx1abcd0-2 subnet2 subnet1 subnet2 subnet1 Command Successful 142 Alphabetical List of Commands and Details status: status: status: status: up up up up
net show status all NOTE: This command applies to single-node products only. Description of Command Function Displays status information on all of the subnets and ports. Command Syntax net show status all 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 command syntax.
net validate config Description of Command Function Validates a configuration. The command checks the data structure according to the rules listed in the net activate config command. However, unlike the activate command, the external network is not configured as defined by the data structure. This command exists to allow a newly created configuration to be tested before configuration is actually activated.
nfs add host Description of Command Function Adds a host to the NFS server. Command Syntax nfs add host [SETX] name [desc ] Command Authority Administrator Command Object Requirements SETX – This object defines an individual service set where the NAS share is to be created. X is a unique numeric index. This object is required for a multi-node system and optional for a single-node system. If it is omitted for a single-node system, it defaults to SET1.
nfs delete host Description of Command Function Deletes an existing host from the NFS server. Command Syntax nfs delete host [SETX] name Command Authority Administrator Command Object Requirements SETX – This object defines an individual service set from where the NAS share is to be deleted. X is a unique numeric index. This object is required for a multi-node system and optional for a single-node system. If it is omitted for a single-node system, it defaults to SET1.
nfs disable host Description of Command Function Disables specific host authentication for an NFS share. NOTE: When you create a share with the CLI, by default, other users are unable to access that share. You must enable read/write permissions on the share in order for other users to access the share by using the nfs enable host command. If you wish to remove those permissions, you use this disable command.
• Command Failed - Invalid parameter value: X • Command Failed - No such Share: X • Cannot change permissions without user/host, meaning the host name provided does not exist within the NAS subsystem or is invalid Example # nfs disable host SHARE1 name Host1 Command Successful 148 Alphabetical List of Commands and Details
nfs enable host Description of Command Function Enables specific host authentication for an NFS share. In order to change specific authentication parameters, this command may be used repeatedly, even on the same host and share, without the need to call disable host or any other command.
Command Operation During Abnormal Conditions If any of the command execution requirements fail, command execution terminates, the host authentication is not enabled, 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.
nfs modify host Description of Command Function Modifies the properties of an NFS host. Command Syntax nfs modify host [SETX] name desc Command Authority Administrator Command Object Requirements SETX – This object defines an individual service set. X is a unique numeric index. This object is required for a multi-node system and optional for a single-node system. If it is omitted for a single-node system, it defaults to SET1.
nfs show config Description of Command Function Displays information on the NFS server configuration. Command Syntax nfs show config [SETX] Command Authority Operator and Administrator Command Object Requirements SETX – This object defines an individual service set. X is a unique numeric index. This object is required for a multi-node system and optional for a single-node system. If it is omitted for a single-node system, it defaults to SET1.
serviceset show status Description of Command Function Displays information on the selected or all service sets. Command Syntax serviceset show status [SETX] [all] Command Authority Operator and Administrator Command Object Requirements SETX – This optional object defines an individual service set. X is a unique numeric index. If the object is not included in the command sequence, the parameter must be included in the command sequence.
serviceset start Description of Command Function Starts the service sets. This command either starts the service set defined in the command sequence or, if parameter all is included in the command sequence, all the service sets in the cluster are started. NOTE: The status of a service set after the start command is issued can be obtained using the serviceset show info command.
Example # serviceset start set1 Command Successful serviceset start 155
serviceset stop Description of Command Function Stops the service sets. The command either stops the service set defined in the command sequence or, if parameter all is included in the command sequence, all the service sets in the cluster are stopped. NOTE: The status of a service set after the stop command is issued can be obtained using the serviceset show info command. IMPORTANT: set.
shell Description of Command Function Creates a shell with root access on the server node supporting the current CLI terminal. If a node object is included in the command entry, the shell is created on system corresponding to the node object in the command entry. Command Syntax shell [NODEX] Command Authority Operator and Administrator Command Object Requirements NODEX – This optional object defines an individual file server node. X is a unique numeric index.
snmp add trapsink Description of Command Function Defines a host to which the SNMP agent sends traps. Parameters for SNMP versions 1 and 2 differ from those for SNMP version 3. This command is supported on all versions of SNMP.
• privacy-password(v3 only) – This optional parameter specifies the privacy password for SNMP version 3 and decryption (default is no password set). Passwords must contain at least eight characters. • contextname(v3 only) – This optional parameter specifies the managed objects that can be accessed by the agent. This parameter is required if the trap receiver has defined subsets of managed objects. Requirements for Command Execution The command entry must conform to command syntax.
Examples: snmp add trapsink 16.34.123.44 events alert - adds trapsink 16.34.123.44 for SNMP version 1. snmp add trapsink 14.34.123.44 version 3 user username port 182 events information authentication-algo SHA authuthentication-pwd authpass privacy-algo AES privacy-pwd privpass contextname cname - adds trapsink 14.34.123.44 for SNMP version 3.
snmp add user Description of Command Function Creates a new SNMP user. The command is support on v3.0 or earlier versions of SNMP. Command Syntax snmp add user USERNAME security-level {noAuthNoPriv|authNoPriv|authPriv} [authorization-algo {MD5|SHA}] [authorization-pwd ] [privacy-algo {DES|AES}] [privacy-pwd ] Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command.
snmp del trapsink Description of Command Function Removes a trap host which has already been created using the snmp add trapsink command (see “snmp add trapsink” (page 158)). This command is supported on v3.0 or earlier versions of SNMP. Command Syntax snmp del trapsink Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command. Command Parameter Requirements FQDN or IP – This is a required parameter.
snmp del user Description of Command Function Deletes an existing SNMP user. This command is supported on v3.0 or earlier versions of SNMP. Command Syntax snmp del user USERNAME 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 command syntax.
snmp disable Description of Command Function Disables the SNMP functionality. Command Syntax snmp disable 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 command syntax.
snmp enable Description of Command Function Enables SNMP functionality. Command Syntax snmp enable [version {1|2|3}] [engine-id ] [allownonv3request ] Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command. Command Parameter Requirements • version – This is a mandatory parameter which implies which SNMP version the user wants to set. The parameter consists of the text, version, followed by a value of 1, 2, or 3.
snmp modify trapsink Description of Command Function Modifies the host to which the SNMP agent sends traps. This command is supported on v3.0 or earlier versions of SNMP.
Successful Command Output Upon successful entry of the command sequence the trap host values are modified, and the following is displayed: SNMP versions 1 and 2: Command Successful, host trap FQDN | IP modified, where FQDN | IP is the fully-qualified domain name or IP address of the trap host.
snmp modify user Description of Command Function Modifies an existing SNMP user. Command Syntax snmp modify user USERNAME security-level {noAuthNoPriv|authNoPriv|authPriv} [authorization-algo {MD5|SHA}] [authorization-pwd ] [privacy-algo {DES|AES}] [privacy-pwd ] Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command.
Command Operation during Abnormal Conditions • If any of the command elements (snmp, modify, user) are misspelled, the following is displayed: element: command not found • 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.
snmp reset ro-community Description of Command Function Resets the ro-community string (the password to access the StoreOnce Management Information Base) to the default string of public. Command Syntax snmp reset ro-community 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.
snmp set contact Description of Command Function Defines a text string indicating the contact person for SNMP agent management of this StoreOnce appliance. Command Syntax snmp set contact <”contact”> Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command. Command Parameter Requirements contact – This required parameter consists of a character text string enclosed in quotations.
snmp set location Description of Command Function Defines a text string indicating the location of the StoreOnce appliance containing the SNMP agent. Command Syntax snmp set location <”location”> Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command. Command Parameter Requirements location – This required parameter consists of a character text string enclosed in quotations.
snmp set ro-community Description of Command Function Defines the ro-community string. In other words, it defines the passphrase for read-only access to the SNMP agent on the StoreOnce appliance. Command Syntax snmp set ro-community <”ro-community”> Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command. Command Parameter Requirements ro-community – This required parameter consists of a character text string enclosed in quotations.
snmp show config Description of Command Function Displays information on the StoreOnce appliance’s SNMP configuration. Command Syntax snmp show config 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 command syntax.
SNMP V3 Trapsinks ================= Trapsink Address Version Port Password Context State ----------------------------------------------16.78.5.
snmp show user Description of Command Function Lists the SNMP user settings of all SNMP users unless a specific user name is included. Command Syntax snmp show user [username] Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command. Command Parameter Requirements USERNAME – If this optional parameter is included, the SNMP settings for only that user are displayed. Requirements for Command Execution • The command entry must conform to command syntax.
support create ticket Description of Command Function Creates a support ticket for the StoreOnce appliance. Command Syntax support create ticket Command Authority Operator and Administrator Command Object Requirements No object is required in the command entry, but upon command execution a support ticket object with a date label is created. Command Parameter Requirements Not applicable – no parameters exist within this command.
support del ticket Description of Command Function Deletes support tickets which exist for the StoreOnce appliance. Command Syntax support del ticket {TICKET|ALL} Command Authority Administrator Command Object Requirements • TICKET – This object is a support ticket which has already been create and exists for the StoreOnce appliance. • ALL – This is a global default which represents all of the support ticket objects which exist within the StoreOnce appliance.
support show ticket Description of Command Function Lists the support tickets that exist for the StoreOnce appliance. Command Syntax support show ticket 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 command syntax.
system clear packages Description of Command Function Clears all packages from the queue which have been loaded for update. Command Syntax system clear packages Command Authority Administrator Command Object Requirements Not applicable – no parameters 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 command syntax.
system clear repository Description of Command Function Deletes all the files in the StoreOnce appliance repository directory. Command Syntax system clear repository Command Authority Administrator Command Object Requirements Not applicable – no parameters 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 command syntax.
system disable failover NOTE: This command applies to multi-node products. Description of Command Function Disables the failover feature on the StoreOnce appliance. It is a direct map to the command sequence hardware disable failover all (see “hardware disable failover” (page 65)). For the initial release, this command only disables failover for the entire appliance. In following releases, the command is updated to disable failover for given service sets.
system enable failover NOTE: This command applies to multi-node products. Description of Command Function Enables the failover feature on the StoreOnce appliance. It is a direct map to the command sequence hardware enable failover all (see “hardware enable failover” (page 67)). For the initial release, this command only enables failover for the entire appliance. In following releases, the command is updated to enable failover for given service sets.
system load packages Description of Command Function Loads the queue with the software packages for which the StoreOnce appliance is updated. The update package is a file image which must exist in the StoreOnce appliance repository. (See applicable HP StoreOnce user guide for more information on the placement of the files in the repository.) This command moves the file image from the StoreOnce appliance and into the package update queue.
system reboot Description of Command Function Methodically shuts down and reboots the entire StoreOnce appliance. For multi-node systems, this command can be executed only if failover is disabled. Command Syntax system reboot 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.
system scan devices Description of Command Function Scans the StoreOnce system for any new, existing, or missing components that need to have their warranty serial number entitlements entered (for example, a storage expansion upgrade requires a re-scan in order for the storage expansion devices to be detected for warranty entitlement). NOTE: To apply a warranty entitlement, the required component must first be discovered. See the system set warrantyserial command for additional information.
system set clioutput Description of Command Function Defines the format of the command output. The format can be either ASCII text or xml; the default is text. Every time a new terminal session is started, the default output is set. Command Syntax system set clioutput {text|xml} Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command.
system set clusterid Description of Command Function This command sets the cluster ID on the StoreOnce Backup system. Note that the cluster ID is a global identifier which uniquely identifies the StoreOnce Backup system. The cluster ID is normally automatically generated during initialization of the StoreOnce Backup system. The cluster ID must conform to a specific format and be different from the cluster ID of any other StoreOnce Backup system.
system set config Description of Command Function Runs a step-based wizard to guide you through a complete series of system configuration steps: • Configure network • Configure time • Configure licenses • Verify hardware health • Configure failover NOTE: Configure failover only applies and is only available for configuration for multi-node products. This step in the wizard is eliminated when performing a single-node product configuration.
The following configuration steps will be performed: -> Configure Network Configure Time Configure Licenses Verify Hardware health Configure Failover Finish Configuration and reboot Finish Configuration Actions: execute) Perform the current step (Default) skip) Skip to the next step back) Go back to a previous step quit) Exit the configuration immediately Configure Network [execute]? NOTE: In the above example, the following options can be exercised: • Configure Network runs the network wizard which can
system set description Description of Command Function Defines the string used to label and identify the StoreOnce appliance. This label is part of the replication process when the source or target appliance needs to be identified. Command Syntax system set description Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command.
system set pagecontrol Description of Command Function Enables or disables the page control feature. Any command outputs information greater than one page long only shows one page at a time, if this setting is set to on. To view the current setting, execute the system show config command. As with system set clioutput, the command is reset on each new terminal session.
system set warrantyserial Description of Command Function Sets the customer’s warranty serial numbers for the various StoreOnce hardware components. Command Syntax system set warrantyserial {server | storageMSA | driveEnclosure | networkSwitch} { | } [] Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command.
Command Failed - The entry does not conform to command syntax, SYNTAX, where SYNTAX is the command syntax as described under Command Syntax in this section. • If an incorrect entitlement option is given, the following is displayed: Invalid entitle entered • If an incorrect device identifier (, ) is entered, the following is displayed: Invalid Device entitlement attempt Command Failed.
system show config Description of Command Function Displays information on the StoreOnce appliance system configuration. Command Syntax system show config 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 command syntax.
CLI OUTPUT: text Cluster ID : Description : Product Class : Hardware Type : hpd89d672850a0 hpd89d672850a0 HP StoreOnce 6500 Backup Physical Couplets ======== Couplet Id ---------1 CLI output Page control text Off : : Alphabetical List of Commands and Details
system show packages Description of Command Function Displays information on the software packages currently installed on the StoreOnce appliance and packages that have been added to the queue for installation. Command Syntax system show packages 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.
system show performance Description of Command Function Provides a snapshot of the StoreOnce appliance’s real-time performance. If a service set object is included in the command entry, the information is only provided for that service set. Command Syntax system show performance [SETX] Command Authority Operator and Administrator Command Object Requirements SETX – This optional object is a service set. It is the software operations which reside on a given node and support the StoreOnce function.
Catalyst Write: 0 MB/s Replication Inbound: 0 MB/s Outbound: 0 MB/s Catalyst Inbound: 0 MB/s Outbound: 0 MB/s system show performance 199
system show repository Description of Command Function Displays the files which have been transferred into the repository. Command Syntax system show repository 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 command syntax.
system show status Description of Command Function Provides a status on the StoreOnce appliance system. Command Syntax system show 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 command syntax.
Set 1 Running # system show status Storage Set ----------------Service Sets 3, 4 Service Sets 7, 8 Service Sets 1, 2 Service Sets 5, 6 Service Sets -----------Set 1 Set 2 Set 3 Set 4 Set 5 Set 6 Set 7 Set 8 Status -----No volumes found on the arrays in Couplet 2, may need to run discovery Formatted 30,543.25GB Needs Finalization (mounting) Formatted 30,543.
system show warrantyserial Description of Command Function Shows the warranty serial and part numbers for a StoreOnce product and also the remote support automation configuration settings. Command Syntax system show warrantyserial 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 None.
missing NA ProCurve J9264A Switch 6600ml-24G-4XG CN051EB02K NA missing missing NOTE: The example output is in a small font to fit on this specification page. As a CLI output, the character string wraps at the end of a terminal line.
system shutdown Description of Command Function Methodically shuts down the entire StoreOnce appliance. While using a multi-node system, failover must be set to disable. Command Syntax system shutdown 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 command syntax.
system update packages Description of Command Function Updates the system with the packages existing in the update queue or optionally defined in the command entry. Parameters in this command force the update process to be performed for packages the system already believes exist. Command Syntax system update packages [force] Command Authority Administrator Command Object Requirements Not applicable – no parameters exist within this command.
time add ntpserver Description of Command Function Adds a network time protocol server to use if ntp is enabled. Up to two ntp servers may be defined for the StoreOnce Backup system. Command Syntax time add ntpserver {|} [{|}] Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command. Command Parameter Requirements ntp server ID – At least one ntp server ID must appear in the command entry.
time del ntpserver Description of Command Function Removes an ntp server which exists for the HP StoreOnce appliance. Command Syntax time del ntpserver {|} Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command. Command Parameter Requirements • ntp server ID – At least one ntp server ID must appear in the command entry.
time reset timezone Description of Command Function Resets the time zone for the StoreOnce appliance to the default of UTC. Local time is the same as UTC. Command Syntax time reset timezone 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 command syntax.
time set timezone Description of Command Function Sets the time zone for the StoreOnce appliance. Command Syntax time set timezone Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command. Command Parameter Requirements timezone – A parameter defining the time zone for the StoreOnce appliance must appear in the command entry after time set timezone.
The following information has been given: Britain (UK) Therefore TZ='Europe/London' will be used. Local time is now: Thu May 9 12:12:58 BST 2013. Universal Time is now: Thu May 9 11:12:58 UTC 2013.
time set UTC Description of Command Function Sets the value of the system clock on the cluster to the value defined within the command entry. NTP must be disabled for this command to execute. Command Syntax time set UTC Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command. Command Parameter Requirements date time – This parameter must appear in the command entry after time set UTC.
time show config Description of Command Function Displays the time configuration and the StoreOnce appliances UTC and local times. Command Syntax time show config 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 command syntax.
vtl add drive Description of Command Function Adds a drive to an existing virtual tape library. The interface type (FC, iSCSI, etc.) of the drive must be the same as the virtual library into which the drive is being added.
interface is not iSCSI, defining this parameter generates an error. The value is a text string with a maximum of 17 characters. If not defined, the CHAP protocol is not supported. • WWPN – This optional parameter defines the worldwide port name if the virtual drive uses Fibre Channel ports. If the virtual drive interface is not Fibre Channel, defining this generates an error. The value must be a worldwide port name. If not defined, an algorithm is used to automatically create a unique identifier.
• ◦ Command Failed – Drive fibre channel port defined for interface ◦ Command Failed – iSCSI name defined for interface ◦ Command Failed – Worldwide port names defined for interface ◦ Command Failed – Worldwide node name defined for interface ◦ Command Failed – The interface is iSCSI, the iSCSIName parameter is required ◦ Command Failed – iSCSI name must less than 224 characters ◦ Command Failed – Worldwide port name is invalid ◦ Command Failed
vtl create cartridge Description of Command Function Adds a cartridge to an existing virtual tape library. Command Syntax vtl create cartridge [SETX ] LIBX {ALL|slot |mail } [WriteProtect {yes|no}] [barcode ] [CartSize {10|25|50|100|200|400|800|1000|1200|1400|1600|3200}] Command Authority Administrator Command Object Requirements • SETX – This object defines the service set containing the virtual tape library into which the cartridge is added.
Requirements for Command Execution • The command entry must conform to command syntax. • All object values must be valid. See object requirements for details. • All parameter values must be valid. See parameter requirements for details. • The command entry must conform to command syntax. • The service set must be valid. • The library object must be valid. • The global default ALL or a slot number must be defined. • If a slot number is defined, it must exist in the library and be empty.
# vtl create cartridge LIB1 slot 2 Command Successful vtl create cartridge 219
vtl create library Description of Command Function Creates a virtual tape library. In addition, a virtual tape cartridge is created in every slot in the virtual library.
Syntax. If the parameter is not defined, the default Generic is used. The characteristics for the different emulation types are described in the following table. Emulation Type Drive Emulation No. of Drives No. of Slots No. of Mail Slots Size of Cartridge Generic LTO4 1 8 1 800 GB MSL2X24 LTO4 2 24 1 800 GB MSL4X48 LTO4 4 48 1 800 GB MSL8X96 LTO4 8 96 1 800 GB EML LTO4 1 96 1 800 GB ESL LTO4 1 96 1 800 GB Note also that options exist for IBM tape emulation as well.
• iUserName – This optional parameter defines the initiator user name for the CHAP (challenge handshake authentication protocol) and is only valid if the interface is iSCSI, and the initiator log on is enabled. If the initiator log on is enabled and this is not defined, an error is generated. The value is a text string with a maximum of 224 characters.
Requirements for Command Execution • The command entry must conform to command syntax. • All object values must be valid. See object requirements for details. • All parameter values must be valid. See parameter requirements for details. • The command entry must conform to command syntax. • The service set must be valid. • The name must be less than or equal to 30 characters. • The interface must be valid. • The library ports must be valid.
◦ Command Failed – The service set is invalid ◦ Command Failed – The service set does not exist ◦ Command Failed – Invalid Parameter: value: ◦ Command Failed – The name must be equal to or less than 30 characters ◦ Command Failed – The interface is invalid ◦ Command Failed – The library port is invalid ◦ Command Failed – The library emulation is invalid ◦ Command Failed – The drive emulation is invalid ◦
• ◦ Command Failed – The number of slots is greater than the library emulation ◦ Command Failed – The number of drives is greater than the library emulation ◦ Command Failed – tAuthentication must be “yes” when iAuthentication is “yes” If execution of the command adds more than 48 libraries to a service set, the command execution terminates, and the following error message is displayed: Command Failed – Only 48 libraries may be added to a service set Examples # vtl create library Command Successful
vtl delete cartridge Description of Command Function Deletes a single cartridge or all cartridges from a virtual tape library. Command Syntax vtl delete cartridge [SETX] LIBX [{CARTX|ALL}] [barcode ] [mail ] [slot ] Command Authority Administrator Command Object Requirements • SETX – This object defines the service set containing the virtual tape library from which the cartridge is deleted. X is the numeric index of the service set.
Command Operation during Abnormal Conditions • • If any of the command execution requirements fail, command execution terminates, the cartridge is not deleted from the library, and one of these error messages is displayed: ◦ Command Failed – Did not conform to the correct command syntax “vtl delete cartridge [SETX] LIBX [{CARTX | ALL}] [barcode ] [mail ] [slot ]” ◦ Command Failed – The service set is invalid ◦ Command Failed – The service set does not exist ◦
vtl delete cartridges Description of Command Function Deletes a range of cartridges from a given tape library. Command Syntax vtl delete cartridges [SETX] LIBX from SLOT to SLOT [DeleteData {Yes|No}] Command Authority Administrator Command Object Requirements • SETX – This object defines the service set containing the virtual tape library from which the cartridge(s) are deleted. X is the numeric index of the service set. This object must be defined when the command is used on a multi-node system.
Command Operation during Abnormal Conditions • • If any of the shown in Successful Command Output command execution requirements fail, command execution terminates, the cartridge is not deleted, and the appropriate error message listed below is displayed.
vtl delete drive Description of Command Function Deletes a virtual drive from a virtual tape library. Command Syntax vtl delete drive [SETX] LIBX DRVX Command Authority Administrator Command Object Requirements • SETX – This required object defines the service set containing the virtual tape library from which the drive is deleted. X is the numeric index of the service set. It is optional on a single-node system but must be defined on a multi-node system.
vtl delete library Description of Command Function Deletes a virtual tape library. Command Syntax vtl delete library SETX LIBX Command Authority Administrator Command Object Requirements • SETX – This required object defines the service set containing the virtual tape library that is to be deleted. X is the numeric index of the service set. It is optional on a single-node system but must be defined on a multi-node system. If used on a single-node system, the object must be defined as SET1.
Example # vtl delete library LIB4 Command Successful 232 Alphabetical List of Commands and Details
vtl erase cartridge Description of Command Function Erases data on a cartridge from a given virtual tape library or erases all the cartridges from a given library. This operation leaves the cartridge configuration intact. Command Syntax vtl erase cartridge [SETX] LIBX [{CARTX | ALL}] [barcode ] [mail ] [ slot ] Command Authority Administrator Command Object Requirements • SETX – This object defines the service set containing the virtual tape library from which cartridges is deleted.
Successful Command Output Upon successful completion of the command, the following message is displayed, and then the CLI user prompt is displayed. Warning – Any data on the cartridge(s) will be lost, continue? (y/n) A “y” response must be entered for command execution to continue.
vtl erase cartridges Description of Command Function Erases a range of cartridges within a given virtual tape library. Command Syntax vtl erase cartridges [SETX] LIBX from SLOT to SLOT Command Authority Administrator Command Object Requirements • SETX – This object defines the service set containing the virtual tape library from which cartridges are deleted. X is the numeric index of the service set. This object must be defined when the command is used on a multi-node system.
• ◦ Command Failed – The library is invalid ◦ Command Failed – The library does not exist ◦ Command Failed - Cannot perform operation as slot is in replication target mapping ◦ Command Failed - Invalid slot range selector If the user does not respond to the warning message with y, the command terminates, and the CLI returns to the user prompt.
vtl modify cartridge Description of Command Function Modifies the parameters of an existing cartridge. Command Syntax vtl modify cartridge [SETX] LIBX [{CARTX|ALL}] [slot ] [WriteProtect {yes|no}] [barcode ] [CartSize {10|25|50|100|200|400|800|1000|1200|1400|1600|3200}] Command Authority Administrator Command Object Requirements • SETX – This required object defines the service set containing the virtual tape library that contains the cartridge to be modified.
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 cartridge is not modified, and one of these error messages is displayed: • Command Failed - Did not conform to the correct command syntax “vtl modify cartridge [SETX] LIBX [{CARTX | ALL}] [ slot ] [WriteProtect { yes | no }] [barcode ] [CartSize {10 |
vtl modify drive Description of Command Function Modifies a drive which already exists within a library. Command Syntax vtl modify drive SETX LIBX DRVX [Drive Emulation {LTO2|LTO3|LTO4|LTO5|UltriumVT}] [DrivePort ] [iSCSIname ] [iUsername ] [wwpn ] [wwnn ] Command Authority Administrator Command Object Requirements • SETX – This required object defines the service set containing the virtual tape library that contains the drive to be modified.
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 cartridge is not deleted from the library, and one of these error messages is displayed: • Command Failed – Did not conform to the correct command syntax “vtl modify drive SETX LIBX DRVX [Drive Emulation { LTO2 | LTO3 | LTO4 | LTO5 | UltriumVT}] [DrivePort
vtl modify library Description of Command Function Modifies an existing library.
• LibEmulation – This optional parameter defines the type of physical library to be emulated by the virtual tape library. The values are defined in the Command Syntax. If not defined, the current value remains unchanged. If this parameter is changed, the number of slots and number of drives currently defined must be less than that defined by the library emulation. If this is not the case, an error message is generated.
• tAuthenticationEnable – Single-node only. This optional parameter determines if the CHAP (challenge handshake authentication protocol) target log on is enabled. The value for this parameter is either yes or no. If not defined, the current value remains unchanged. • tUserName – Single-node only. This optional parameter defines the target user name for the CHAP (challenge handshake authentication protocol) and is only valid if the interface is iSCSI.
| MSL8X96 | EML | ESL }] [DriveEmulation { LTO2 | LTO3 | LTO4 | LTO5 | UltriumVT }] [DrivePort [,]] [NoOfSlots ] [NoOfDrives ] [Port [,]] [iSCSIname ] [iAuthenticationEnable {yes | no}] [iUsername ] [iSecret ] [tAuthenticationEnable {yes | no}] [tUsername ] [tSecret ] [wwpn ] [wwnn ] [BarcodeLength { 6 | 8 }] [nonstop {yes | no}]” • Command Failed – The entry does not conform to command syntax.
• Command Failed – The barcode parameters cannot be modified when cartridges exist in the library.
vtl move cartridge Description of Command Function Moves a cartridge within a virtual tape library. Command Syntax vtl move cartridge SETX LIBX [CARTX] [from {drive |mail |slot }] [barcode ] to [libX] {drive |mail |slot } Command Authority Operator and Administrator Command Object Requirements • SETX – This required object defines the service set containing the virtual tape library into which the cartridge is moved.
mail | slot }] [barcode ] to [libX] {drive | mail | slot }” • ◦ Command Failed – The service set is invalid ◦ Command Failed – The service set does not exist ◦ Command Failed – The library is invalid ◦ Command Failed – The library does not exist ◦ Command Failed – The mail slot does not exist in the library ◦ Command Failed – The slot does not exist in the library ◦ Command Failed – The drive
vtl show capacity Description of Command Function Displays details on the library storage used and available at the cluster, service set, or library level. The level of information displayed depends on the objects defined within the command sequence. Command Syntax vtl show capacity [SETX] [LIBX] Command Authority Operator and Administrator Command Object Requirements • SETX – This object defines the service set to be displayed. X is the numeric index of the service set.
# vtl show capacity SET1 Object -----SET1 LIB1 LIB2 Lib3 Space Used ---------- User Data --------- Dedupe Ratio ------------ 4 TB 5 TB 1 TB 20 TB 75 TB 5 TB 5:1 15:1 5:1 User Data --------20 TB Dedupe Ratio -----------5:1 Command Successful # vtl show capacity SET1 Object -----LIB1 Space Used ---------4 TB LIB1 Command Successful vtl show capacity 249
vtl show cartridges Description of Command Function Displays information about the cartridges in a given library. Command Syntax vtl show cartridges SETX LIBX Command Authority Operator and Administrator Command Object Requirements • SETX – This required object defines the service set containing the virtual library to be displayed. X is the numeric index of the service set. It is optional on a single-node system but must be defined on a multi-node system.
# vtl show cartridges SET1 LIB1 Library : LIB1 Name: Gregslib Object Location Slot ------------- ---CART1 1 CART2 2 CART3 Drive2 CART4 Barcode ------ABC001 ABC002 Max Size -------800 GB 800 GB User Data --------745 GB 712 GB Protected --------yes yes Mapped -----no no 3 ABC003 800 GB 799 GB yes no 4 ABC004 800 GB 785 GB yes no Command Successful vtl show cartridges 251
vtl show drive info Description of Command Function Displays information about a given virtual drive or all the virtual drives in a given library. Command Syntax vtl show drive info SETX LIBX [DRVX] Command Authority Operator and Administrator Command Object Requirements • SETX – This required object defines the service set containing the virtual library drives to be displayed. X is the numeric index of the service set. It is optional on a single-node system but must be defined on a multi-node system.
# vtl show drive info SET1 Drive Object Library Library Name Emulation Type Protocol Serial Number WWNN iSCSI Target Name iSCSI Target Alias : : : : : : : : : LIB2 DRV1 DRV1 LIB1 GregsNextlib LTO4 iSCSI CR2058t021 500143874B5B68A0 ign-1986-03.com.hp.storage.d2dbs.cr206f12e.500143874b5b68a0.library2.drive1 D2DBS.CR206F1F2E.library2.
vtl show drive list Description of Command Function Lists the drives in a library. Command Syntax vtl show drive [SETX] [LIBX] Command Authority Operator and Administrator Command Object Requirements • SETX – This optional object defines the service set containing the drives to be listed. X is the numeric index of the service set. If used on a single-node system, the object must be defined as SET1. If not defined, all drives are listed.
# vtl show drive list Object -----DRV1 DRV2 DRV1 DRV2 Type ---LTO4 LTO4 LTO4 LTO4 SET1 Service Set ----------SET1 SET1 SET1 SET1 Library ------LIB1 LIB1 LIB2 LIB2 Name ---Gregslib Gregslib GregsNextlib GregsNextlib Library ------LIB1 LIB1 Name ---Gregslib Gregslib Command Successful # vtl show drive list Object -----DRV1 DRV2 Type ---LTO4 LTO4 SET1 LIB1 Service Set ----------SET1 SET1 Command Successful vtl show drive list 255
vtl show library info Description of Command Function Displays library configuration information. The number of library configurations displayed depends on whether a service set and specific library object is defined in the command sequence. Command Syntax vtl show library info [SETX] [LIBX] Command Authority Operator and Administrator Command Object Requirements • SETX – This optional object defines the service set containing the libraries to be displayed. X is the numeric index of the service set.
No. of Slots Default Cartridge Size Barcode Generation Length : : : : 24 800GB Default 8 Command Successful # vtl show library info set2 lib2 Object Name Creation Time Replication Role Deduplication NonStop Emulation Type Default Drive Emulation Protocol : : : : : : : : : LIB2 Gregslib 20:19 2012/05/06 Non Replicating Enabled No MSL G3 Series (2x24) LTO4 iSCSI Media Changer Serial Number iSCSI WWNN iSCSI Name iSCSI Alias : : : : H1B600B50J 5001438011A18947 iqn.1986-03.com.hp:storage.d2dbs.
vtl show library iscsi authentication NOTE: This command applies to single-node products only. Description of Command Function Displays information on a library’s CHAP (challenge handshake authentication protocol) configuration. Command Syntax vtl show library iscsi authentication SETX LIBX Command Authority Administrator Command Object Requirements • SETX – This required object defines the service set containing the library whose CHAP information is displayed. X is the numeric index of the service set.
Command Successful vtl show library iscsi authentication 259
vtl show library list Description of Command Function Lists the libraries in a cluster. Command Syntax vtl show library list [SETX] Command Authority Operator and Administrator Command Object Requirements SETX – This optional object defines the service set containing the libraries to be listed. X is the numeric index of the service set. If used on a single-node system, the object must be defined as SET1. Command Parameter Requirements Not applicable – no parameters exist within this command.
vtl show performance Description of Command Function Provides details on the data transfer performance at the cluster, service set, or library level depending on the level of object definition. Command Syntax vtl show performance [SETX] [LIBX] Command Authority Operator and Administrator Command Object Requirements • SETX – This optional object defines the service set to be described. X is the numeric index of the service set. If not defined, performance information is provided at the cluster level.
SET1 LIB1 LIB2 400 MB/s 600 MB/s Command Successful # vtl show performance SET1 LIB1 Object LIB1 Read Transfer Rate Command Successful 262 Alphabetical List of Commands and Details Write Transfer rate 200 MB/s
vtl show slots Description of Command Function Displays information about the slots in the specified library Command Syntax vtl show slots SETX LIBX Command Authority Operator and Administrator Command Object Requirements • SETX – This required object defines the service set containing the virtual tape library to be described. X is the numeric index of the service set. If used on a single-node system, the object must be defined as SET1.
drive2 CART3 ABC003YZ Command Successful 264 Alphabetical List of Commands and Details 800 GB 799 GB yes no
vtl show status Description of Command Function Displays details on the virtual tape library status at the cluster, service set, or library level. Command Syntax vtl show status [SETX] [LIBX] Command Authority Operator and Administrator Command Object Requirements • SETX – This optional object defines the service set to be described. X is the numeric index of the service set. If used on a single-node system, the object must be defined as SET1. If not defined, the status is provided at the cluster level.
Object -----SET1 LIB1 LIB2 Status -----Online Online Command Successful # vtl show status SET2 LIB1 Object -----LIB1 Status -----Online Command Successful 266 Alphabetical List of Commands and Details
5 Support and other resources Contacting HP For worldwide technical support information, see the HP support website: www.hp.
Table 4 Document conventions (continued) Convention Element Bold text • Keys that are pressed • Text typed into a GUI element, such as a box • GUI elements that are clicked or selected, such as menu and list items, buttons, tabs, and check boxes Italic text Text emphasis Monospace text • File and directory names • System output • Code • Commands, their arguments, and argument values Monospace, italic text • Code variables • Command variables Monospace, bold text WARNING! CAUTION: IMPORTANT: NOTE:
Glossary C CLI Command-line interface. An interface comprised of various commands which are used to control operating system responses.
U user a person interfacing with the Common CLI (can also be an account accessing a CIFS share) UTC Universal Time Coordinate (time definition protocol) V VIF Virtual interface. W white space any combination of spaces, tabs and carriage returns word an element whose characters having meaning in the natural language of the user.
Index A accessing the CLI, 7 accounts add, 20 del, 22 modify, 23 show, 25 alerts show, 27 alphabetical list of commands, 20 C categorical list of commands, 16 cifs add localadmin, 28 add user, 30 delete localadmin, 32 delete user, 34 disable domainjoin, 36 disable user, 38 enable domainjoin, 40 enable user, 42 modify config, 44 modify user, 46 show config, 48 show localadmin, 49 CLI accessing, 7 introduction, 7 command details, 20 global defaults, 15 groups, 12 objects, 14 scripting, 10 syntax, 11 words, 1
show update, 99 nas create share, 101 delete share, 103 modify share, 104 show share, 106 net activate config, 108 activate status, 110 add encryption, 111 add ipaddr, 112 add portset, 113 add subnet, 114 copy config, 117 create config, 118 delete config, 121 delete encryption, 122 delete ipaddr, 123 delete portset, 124 delete subnet, 125 modify config, 126 modify subnet, 128 ping, 130 set wizard, 131 show config, 135 show ipaddr, 137 show ports, 138 show portset, 140 show status, 141 validate config, 144
add drive, 214 create cartridge, 217 create library, 220 delete cartridge, 226 delete cartridges, 228 delete drive, 230 delete library, 231 erase cartridge, 233 erase cartridges, 235 modify cartridge, 237 modify drive, 239 modify library, 241 move cartridge, 246 show capacity, 248 show cartridges, 250 show drive info, 252 show drive list, 254 show library info, 256 show library iscsi authentication, 258 show library list, 260 show performance, 261 show slots, 263 show status, 265 W websites, 267 product ma
