Download
Share
Print this page
  1. Manuals
  2. Brands
  3. HP Manuals
  4. Storage
  5. StoreOnce B6000
  6. Reference manual

HP StoreOnce B6000 Series Reference Manual

Hp b6000 storeonce backup system cli reference guide
Hide thumbs Also See for StoreOnce B6000 Series:

Advertisement

Quick Links

Download this manual See also: Configuration Manual, User Manual
HP StoreOnce B6000 Series 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 the appliance's activity. It is intended for system
administrators managing an HP StoreOnce B6000 Series Backup System.
IMPORTANT:
www.hp.com/support/manuals
*EJ022-90906*
HP Part Number: EJ022-90906
Published: March 2012
Edition: Second
The version of this guide that is available on the web at launch may have later updates. Always check
for the most up-to-date documentation for your product.
http://

Advertisement

loading

Related Manuals for HP StoreOnce B6000 Series

Summary of Contents for HP StoreOnce B6000 Series

  • Page 1 This document details the set of operations supported by the Common CLI. This command set defines the instructions used to obtain information about a StoreOnce Backup System appliance or to control the appliance’s activity. It is intended for system administrators managing an HP StoreOnce B6000 Series Backup System. IMPORTANT: The version of this guide that is available on the web at launch may have later updates.
  • Page 2 © Copyright 201 1–2012 Hewlett-Packard Development Company, L.P. Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.21 1 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.

  • Page 3: Table Of Contents

    Contents 1 Using the CLI.....................5 Accessing the CLI........................5 CLI Output Format........................6 Using CLI Interactively.......................6 Using a Script to Access the CLI....................6 Command Names and Syntax....................6 Viewing Help...........................6 2 Command Grammar and Syntax..............7 Command Instruction Grammar....................7 Instruction Entry Syntax......................7 Transferring Files........................8 Manual Command Entry......................8 Scripting..........................9 Command Groups........................9...
  • Page 4 snmp set ro-community......................49 snmp show config........................50 support create ticket........................51 support del ticket........................52 support show ticket.........................53 system clear packages......................54 system clear repository......................55 system disable failover......................56 system enable failover......................57 system load packages......................58 system reboot.........................59 system set clioutput........................60 system set description......................61 system show config.........................62 system show packages......................63 system show performance......................64 system show repository......................65...

  • Page 5: Using The Cli

    1 Using the CLI The Common CLI Command Set provides a method of communication with the StoreOnce appliance which is intuitive, consistent and easy to use. The command set is broad in scope, so that once learned, it can be used with the B6000 family of products as well as future products in the StoreOnce roadmap.

  • Page 6: Cli Output Format

    Table 1 Login Information Authorization Level Can Execute User Name Password Command Prompt Operator Commands that Operator operator > provide information about the state and configuration of the StoreOnce appliance but no commands that change the configuration. Administrator Commands that Admin admin provide information...

  • Page 7: Command Grammar And Syntax

    2 Command Grammar and Syntax Command Instruction Grammar A StoreOnce appliance is controlled by operations. An operation is one or more of the following events: providing configuration information to the appliance requesting an action obtaining information about the appliance and conveying that information to the user The execution of operations is initiated by instructions.

  • Page 8: Transferring Files

    The command sequence must be present in all entries. This sequence defines the intended instruction. Depending on the instruction, object identification or parameter values might be part of the entry. command command command command object object object paramenters: value (group) (action) (subject) (clarification)

  • Page 9: Scripting

    Scripting Scripting is performed via expect. To aid in parsing, the Common CLI can be configured to return XML formatted output. Command Groups The elements listed below define the groups of different command sequences. Element Commands Involved With accounts user accounts for the Common CLI alert alerts generated by the StoreOnce appliance cifs...

  • Page 10: Objects

    or subjects within the different groups are listed below. (See “Categorical List of Commands” (page 13) for a list of the command elements used to represent groups.) Actions Subjects Subjects (continued) activate access outbox account(s) package(s) beacon authentication performance clear window ports config...
  • Page 11 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. The arrays are defined by the auto-configuration process.

  • Page 12: Global Defaults

    Object Label Convention 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. SMTPSERVER The user provides a unique email address string defining the account. NOTE: Command entries are not case sensitive.

  • Page 13: Categorical List Of Commands

    3 Categorical List of Commands Table 2 Commands by Category Command Group Commands accounts “accounts modify” (page 15) “accounts show” (page 16) alerts “alerts show” (page 17) exit “exit” (page 18) hardware “hardware add storage” (page 19) “hardware disable failover” (page 20) “hardware discover storage”...
  • Page 14 Table 2 Commands by Category (continued) Command Group Commands “system enable failover” (page 57) “system load packages” (page 58) “system reboot” (page 59) “system set clioutput” (page 60) “system set description” (page 61) “system show config” (page 62) “system show packages” (page 63) “system show performance”...

  • Page 15: Alphabetical List Of Commands And Details

    4 Alphabetical List of Commands and Details accounts modify Description of Command Function Modifies the password of an existing account. Command Syntax accounts modify ACCOUNT [password <password> password] Command Authority Administrator An operator can modify the password of his own account. Command Object Requirements ACCOUNT –...

  • Page 16: Accounts Show

    accounts show Description of Command Function Lists all the user accounts and their authority level defined for the StoreOnce appliance. Command Syntax accounts show [current] Command Authority Administrator Command Object Requirements current – As an option, the global default “current” may be included in the command entry. If included, “current”...

  • Page 17: Alerts Show

    alerts show Description of Command Function Lists all events with a severity of “critical” or “error.” Command Syntax alerts show [verbose] [numofevents <number>] Command Authority Operator, Administrator Command Object Requirements Not applicable – no objects exist within this command. Command Parameter Requirements verbose –...

  • Page 18: Exit

    exit Description of Command Function Terminates a CLI session. Command Syntax exit Command Authority Operator and Administrator Command Object Requirements Not applicable – no objects exist within this command. Command Parameter Requirements Not applicable – no parameters exist within this command. Requirements for Command Execution The command entry must conform to the command syntax.

  • Page 19: Hardware Add Storage

    hardware add storage Description of Command Function This command adds storage which has been discovered using the hardware discover storage command (see “hardware discover storage” (page 21)). Before this command can be executed, newly discovered storage must exist as presented in the system show status command (see “system show status”...

  • Page 20: Hardware Disable Failover

    hardware disable failover Description of Command Function Disables the failover feature between nodes which is automatically configured during the initial automatic configuration of the StoreOnce appliance. HP recommends disabling failover before rebooting the StoreOnce appliance. Command Syntax hardware disable failover [NODEX] Command Authority Administrator Command Object Requirements...

  • Page 21: Hardware Discover Storage

    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 22: Hardware Enable Failover

    hardware enable failover Description of Command Function Enables the failover feature between nodes which had been disabled using the hardware disable failover (see “hardware disable failover” (page 20)) command. Command Syntax hardware enable failover [NODEX] Command Authority Administrator Command Object Requirements NODE X –...

  • Page 23: Hardware Failback

    hardware failback 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 24: Hardware Failover

    hardware failover Description of Command Function Forces the implementation of the high availability feature for the file server node defined within the command. When this command is executed, the backup node within the couplet takes over the service set functions originally residing on the defined node. Command Syntax hardware failover NODEX Command Authority...

  • Page 25: Hardware Poweroff

    hardware poweroff Description of Command Function Powers down the StoreOnce appliance. If a file server node is defined in the command entry, only this node is powered down. Command Syntax hardware poweroff [NODEX] Command Authority Administrator Command Object Requirements NODE X – As an option, this can be used to define an individual file server node. X is a unique numeric index.

  • Page 26: Hardware Powerup

    hardware powerup Description of Command Function Powers up the StoreOnce appliance. If a file server node is defined in the command entry, only this node is powered up. Command Syntax hardware powerup [NODEX] Command Authority Administrator Command Object Requirements NODE X – As an option, this can be used to define an individual file server node. X is a unique numeric index.

  • Page 27: Hardware Reboot

    hardware reboot Description of Command Function Reboots the StoreOnce appliance nodes. If a file server node is defined in the command entry, only this node is rebooted. Command Syntax hardware reboot [NODEX] Command Authority Administrator Command Object Requirements NODE X – As an option, this can be used to define an individual file server node. X is a unique numeric index.

  • Page 28: Hardware Show Net Status

    hardware show net status 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 –...

  • Page 29: Hardware Show Node Status

    hardware show node status Description of Command Function Provides status on the StoreOnce file server nodes. If a node object is included in the command entry. The port and component status is only provided for that node. Command Syntax hardware show node status [NODEX] Command Authority Operator and Administrator Command Object Requirements...

  • Page 30: Help

    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 –...
  • Page 31 support — create, delete or show support tickets. system — commands related to configuration and system setup. time — manage time related functions. Commands currently available ____________________________ hpsupport — provides access to the HP support account with the HP support authority level.

  • Page 32: Hpsupport

    hpsupport Description of Command Function Provides access to the HP support authority level. Command Syntax hpsupport <hp-password> 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.

  • Page 33: License Add

    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 <license> Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command entry. Command Parameter Requirements license –...

  • Page 34: License Load

    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 <file-image>...

  • Page 35: License Show

    license show Description of Command Function Displays the licenses which are available for this StoreOnce appliance. Command Syntax license show Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command entry. Command Parameter Requirements Not applicable – no parameters exist within this command entry. Requirements for Command Execution The command entry must conform to the command syntax.

  • Page 36: Logs Show Events

    logs show events Description of Command Function Lists all the items in the event log. If a severity parameter is included in the command entry, only events at or greater than the defined severity are displayed. Command Syntax logs show events [severity {alert|warni|info}] [numofevents <number>] (default = 20) Command Authority Operator, Administrator...
  • Page 37 bond1:1 Aug 3 18:58:41 INFO Nic bond1:3 on host d2d78e7d1e6928e_node_1 up d2d78e7d1e6928e_node_1 bond1:3 Aug 3 18:58:19 WARN Server d2d78e7d1e6928e_node_2 failed over d2d78e7d1e6928e_node_2 Aug 3 18:58:13 ALERT Server d2d78e7d1e6928e_node_2 in failover d2d78e7d1e6928e_node_2 634 Aug 3 18:58:13 INFO Command from Local Host, user root: Failover for server d2d78e7d1e6928e_node_2. d2d78e7d1e6928e_node_2 NOTE: The example output is in a small font to fit on this specification page.

  • Page 38: Net Set Config

    net set config Description of Command Function To configure the external network to one of the four pre-defined configurations. Command Syntax net set config TEMPLATEX Command Authority Administrator Command Object Requirements TEMPLATEX – One of four predefined configurations. template 1 – 1GbE management network and 10Gbe data network template 2 –...

  • Page 39: Net Show Config

    net show config Description of Command Function Shows the network configuration. Command Syntax net 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 the command syntax.
  • Page 40 Default gateway: XXX:XXX:XXX:XXX DNS server IP address(es) XXX:XXX:XXX:XXX, XXX:XXX:XXX:XXX, XXX:XXX:XXX:XXX IP Address Ranges Allocated for this B6200 system ------------------------------------------------------------- 1GbE management network start IP address XXX.XXX.XXX.XXX 1GbE management network End IP range: XXX.XXX.XXX.XXX 10GbE data network start IP address XXX.XXX.XXX.XXX 10GbE data network End IP range: XXX.XXX.XXX.XXX Alphabetical List of Commands and Details...

  • Page 41: Snmp Add Trapsink

    snmp add trapsink Description of Command Function Defines a host to which the SNMP agent sends traps. Command Syntax snmp add trapsink <FQDN | IP> [port <Number>] [trap-community <”string”>] [events {alert | warn | info}] Command Authority Administrator Command Object Requirements Not applicable –...

  • Page 42: Snmp Del Trapsink

    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 41)). Command Syntax snmp del trapsink <FQDN | IP> Command Authority Administrator Command Object Requirements Not applicable –...

  • Page 43: Snmp Disable

    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 the command syntax.

  • Page 44: Snmp Enable

    snmp enable Description of Command Function Enables the SNMP functionality. Command Syntax snmp enable Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command. Command Parameter Requirements Not applicable – no parameters exist within this command. Requirements for Command Execution The command entry must conform to the command syntax.

  • Page 45: Snmp Modify Trapsink

    snmp modify trapsink Description of Command Function Modifies the host to which the SNMP agent sends traps. Command Syntax snmp modify trapsink <FQDN | IP> [port <Number>] [trap-community <”string”>] [events {alert | warn | info}] Command Authority Administrator Command Object Requirements Not applicable –...

  • Page 46: Snmp Reset Ro-Community

    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 –...

  • Page 47: Snmp Set Contact

    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 –...

  • Page 48: Snmp Set Location

    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 –...

  • Page 49: Snmp Set Ro-Community

    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 –...

  • Page 50: Snmp Show Config

    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 the command syntax.

  • Page 51: Support Create Ticket

    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.

  • Page 52: Support Del Ticket

    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.

  • Page 53: Support Show Ticket

    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 – objects exist within this command. Command Parameter Requirements Not applicable – no parameters exist within this command. Requirements for Command Execution The command entry must conform to the command syntax.

  • Page 54: System Clear Packages

    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 –...

  • Page 55: System Clear Repository

    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 –...

  • Page 56: System Disable Failover

    system disable failover Description of Command Function Disables the failover feature on the StoreOnce appliance. It is a direct map to the command sequence hardware disable failover (see “hardware disable failover” (page 20)). For the initial release, this command will only disable failover for the entire appliance. In following releases, the command will be updated to disable failover for given service sets.

  • Page 57: System Enable Failover

    system enable failover Description of Command Function Enables the failover feature on the StoreOnce appliance. It is a direct map to the command sequence hardware enable failover (see “hardware enable failover” (page 22)). For the initial release, this command will only enable failover for the entire appliance. In following releases, the command will be updated to enable failover for give service sets.

  • Page 58: System Load Packages

    system load packages Description of Command Function Loads the queue with the packages for which the StoreOnce appliance will be updated. The update package is a file image which must exist in the StoreOnce appliance repository. The placement of the files in the repository is outside the scope of this document. This command moves the file image from the StoreOnce appliance and into the package update queue.

  • Page 59: System Reboot

    system reboot Description of Command Function Gracefully shuts down and reboots the entire StoreOnce appliance. Command Syntax system reboot 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 the command syntax.

  • Page 60: System Set Clioutput

    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 will be set. Command Syntax system set clioutput {text | xml} Command Authority...

  • Page 61: System Set Description

    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 <appliance-name> Command Authority Administrator Command Object Requirements...

  • Page 62: System Show Config

    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 –...

  • Page 63: System Show Packages

    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 –...

  • Page 64: System Show Performance

    system show performance Description of Command Function Provides information on the StoreOnce appliance’s 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...

  • Page 65: System Show Repository

    system show repository Description of Command Function Displays the packages 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 –...

  • Page 66: System Show Status

    system show status Description of Command Function Provides 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 the command syntax.

  • Page 67: System Shutdown

    system shutdown Description of Command Function Gracefully shuts down the entire StoreOnce appliance. 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 the command syntax.

  • Page 68: System Update Packages

    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 will force the update process to be performed for packages the system already believes exist. Command Syntax system update packages [force] Command Authority...

  • Page 69: Time Add Ntpserver

    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 appliance. Command Syntax time add ntpserver {<FQDN> | <IPv4> } [{<FQDN> | <IPv4> }] Command Authority Administrator Command Object Requirements...

  • Page 70: Time Del Ntpserver

    time del ntpserver Description of Command Function Removes an ntp server which exists for the StoreOnce appliance. Command Syntax time del ntpserver {<FQDN> | <IPv4> } Command Authority Administrator Command Object Requirements Not applicable – no objects exist within this command. Command Parameter Requirements ntp server ID –...

  • Page 71: Time Reset Timezone

    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 –...

  • Page 72: Time Set Timezone

    time set timezone Description of Command Function Sets the time zone for the StoreOnce appliance. Command Syntax time set timezone <timezonelabel> 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.

  • Page 73: Time Set Utc

    time set UTC Description of Command Function Sets the value of the system clock on the node with active fusion manager to the value defined within the command entry. NTP must be disabled for this command to execute. Command Syntax time set UTC <mm/dd/yyyy hh:mm:ss>...

  • Page 74: Time Show Config

    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 –...

  • Page 75: Command Instruction Set Details Full Set Save For Later

    5 Command Instruction Set Details FULL SET SAVE FOR LATER account add Description of Function This command creates an account that interfaces with the StoreOnce appliance using the CLI or GUI. When using the CLI, either a SSH (secure shell) or serial port connection can be used to access the account.

  • Page 76: Account Del

    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.

  • Page 77: Catalyst Add Client

    Requirements for Command Execution The command entry must conform to the command syntax The account object in the command entry must be an existing account The account object in the command entry cannot be the only account with “administrator” authorization level Successful Command Output Upon successful completion of the command, the following is displayed: account ACCOUNT deleted where ACCOUNT is the string which labeled the deleted account...
  • Page 78 can be used to obtain a detailed listing of object store containers within the appliance. Refer to section 3.4.14 for details. CLIENT – This defines the client which is to be added (allowed access) to the object store container. CLIENT is a text string label which uniquely defines the client. The client is a certification of identity or authorization.

  • Page 79: Catalyst Add Window

    catalyst add window Description of Command Function This command adds a bandwidth window to an object store container. Once the bandwidth window is added, data transfer to and from the object store container will be constrained as defined by the bandwidth window. More than one bandwidth window can be added to an object store container.

  • Page 80: Catalyst Create

    word defining the day of the week at which the bandwidth window ends. The words may be Mon, Tues, Wed, Thurs, Fri, Sat or Sun. stop time – This parameter defines the time at which the bandwidth window ends. It is required. It consists of the text “stop-time”...
  • Page 81 StoreOnce Backup System products. Note: for an object store container to be fully functional, it must have the addition of at least one client. This operation is performed by a separate command. Refer to command “catalyst add client” in section 3.4.3 for further details. If an object store is created and exists without the addition of at least one client, a warning message will display whenever this object store container is listed in the CLI.

  • Page 82: Catalyst Create Client

    OBJSTORE created in SETX where OBJSTORE is the label for the object store container defined in the command entry and SETX is the service set label included in the command entry. Command Operation during Abnormal Conditions If the command does not conform to the required syntax, the following is displayed: Command Failed - the command does not conform to the required syntax, SYNTAX where SYNTAX is the command syntax as described under Command Syntax in this section...
  • Page 83 Command Object Requirements The following objects listed below may be included in the command entry after “catalyst create client”. OBJECT – This optional object defines the object store container to which the newly created client is to be added. OBJECT is a text string label uniquely defining the object store container. The command entry “catalyst show”...

  • Page 84: Catalyst Del

    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 object store container (OBJSTORE) defined in the command entry does not exist, the following message will be displayed:...

  • Page 85: Catalyst Del Client

    label which uniquely defines the service set. X represents a numeric index. The command entry “catalyst show” can be used to obtain a detailed listing of object stores containers and the associated service sets within the appliance. Refer to section 3.4.14 for details. Command Parameter Requirements Not Applicable –...
  • Page 86 Command Authority Administrator Command Object Requirements The following objects listed below are required in the command entry after “catalyst del client”: CLIENT – This is a unique label defining the client certificate to be deleted. This label was defined by the user when the client was created. The command “catalyst show clients” can be used to obtain a list of client certificates.

  • Page 87: Catalyst Del Data

    auditor deleted catalyst del data Description of Command Function This command deletes data objects within an object store container. The data objects to be deleted are listed within the command entry. The “catalyst show” command entry can be used to obtain a detailed list of data objects within an object store container when the label for the object store container is included with this command.

  • Page 88: Catalyst Del Window

    The following data objects were deleted from OBJSTORE object-string object-string where OBJECT is the label of the object store container defined in the command entry. And object-string is the labels of the objects deleted by the command execution. 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,...

  • Page 89: Catalyst Modify

    label which uniquely defines the service set. X is a numeric index. The command entry “catalyst show” can be used to obtain a detailed listing of object stores containers and the associated service sets and bandwidth windows within the appliance. Refer to section 3.4.14 for details. The command entry “catalyst show window”...
  • Page 90 Command Object Requirements The objects listed below are associated with the modification of an object store container and are located in the command entry after “catalyst modify”. SETX – This defines the service set in which the object store container resides. This object is required in the command entry when used on multi-node StoreOnce appliances.

  • Page 91: Catalyst Modify Client

    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 service set defined in the command entry does not exist, the following is displayed: SETX does not exist.

  • Page 92: Catalyst Modify Ports

    application interface separate from the appliance GUI or CLI. This parameter consists of the word “allow-create” and is followed by either “yes” or “no”. If “yes” is defined, the client is allowed to create object store containers. If this parameter is not included in the command entry, “no”...
  • Page 93 Command Object Requirements The following objects listed below are required in the command entry after “catalyst add bw-window”. SETX – This defines the service set which contains the port values to be modified. This object is required in the command entry when used on multi-node StoreOnce appliances. SETX is label which uniquely defines the service set.

  • Page 94: Catalyst Modify Window

    catalyst modify window Description of Command Function This command modifies a bandwidth window which had previously been added to an object store container using the “catalyst add window” command. Refer to section 3.4.2 for details. Command Syntax catalyst modify window [SETX] WINX [bw] [start-day { Mon | Tues | Wed | Thur | Fri | Sat | Sun }] [start-time <hh:mm>] [stop-day { Mon | Tues | Wed | Thur | Fri | Sat | Sun }] [stop-time <hh:mm>] Command Authority...

  • Page 95: Support And Other Resources

    6 Support and other resources Contacting HP For worldwide technical support information, see the HP support website: http://www.hp.com/support Before contacting HP, collect the following information: Product model names and numbers Technical support registration number (if applicable) Product serial numbers Error messages Operating system type and revision level Detailed questions Related information...

  • Page 96: Documentation Feedback

    Table 3 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...

  • Page 97: Glossary

    Glossary Command-line interface. An interface comprised of various commands which are used to control operating system responses. command elements entered into the Common CLI by the user to convey instructions command a sequence of commands which uniquely defines an instruction for the StoreOnce appliance sequence command set the entire list of unique command sequences and their associated syntax which provides a clear,...
  • Page 98 white space any combination of spaces, tabs and carriage returns word an element whose characters having meaning in the natural language of the user. The meaning of the word is directly related to the intended operation defined by the words in the command sequence Glossary...

  • Page 99: Index

    Index accessing the CLI, enable failover, hardware, accounts enable snmp, modify, enabling the system failover, show, entering commands, add a trapsink , exit, add license, add storage, hardware, adding the ntp server, failback, hardware, alerts failover, hardware, show, files alphabetical list of commands, transferring, categorical list of commands, global defaults,...
  • Page 100 node status, show, create ticket, del ticket, show ticket, objects, symbols in text, syntax for commands, system poweroff, hardware, clear packages, powerup, hardware, clear repository, disable failover, enable failover, reboot, hardware, load packages, rebooting the system, reboot, related documentation, set clioutput, repository directory, set description, reset...