background image

HighPoint CLI Reference 

Table of Contents 

Conventions .....................................................................................................................................1

 

Introduction to the HighPoint Command Line Interface............................................................2

 

Supported Operation Systems and Adapters .............................................................................2

 

Installing the HighPoint CLI on Linux .....................................................................................2

 

Installing the HighPoint CLI on FreeBSD ................................................................................2

 

Running HighPoint CLI ............................................................................................................2

 

CLI Command Reference ..............................................................................................................5

 

Query Commands .....................................................................................................................5

 

query controllers ...............................................................................................................5

 

query devices.....................................................................................................................5

 

query devices {device_id} ................................................................................................6

 

query arrays.......................................................................................................................7

 

query arrays {array_id}.....................................................................................................7

 

Create Command.......................................................................................................................8

 

Delete Command.......................................................................................................................9

 

Unplug Command ...................................................................................................................10

 

Init Commands........................................................................................................................10

 

init {device_id} ...............................................................................................................10

 

Init {array_id} {start|stop}..............................................................................................10

 

Rebuild Commands.................................................................................................................11

 

rebuild {array_id} {device_id} .......................................................................................11

 

Rebuild {array_id} {start|stop}.......................................................................................11

 

Verify Command.....................................................................................................................11

 

OCE/ORLM Command ..........................................................................................................12

 

Rescan Command ...................................................................................................................12

 

SAF-TE Commands ................................................................................................................13

 

SAF-TE ...........................................................................................................................13

 

SAF-TE set {property_index} value ...............................................................................13

 

Events Commands...................................................................................................................14

 

events ..............................................................................................................................14

 

Events clear .....................................................................................................................14

 

events save {file_name}..................................................................................................14

 

Mail Commands......................................................................................................................15

 

mail recipient...................................................................................................................15

 

Mail recipient add {recipient_name} {mail_address} [Inf|War|Err] ..............................15

 

Mail recipient delete {recipient_name} ..........................................................................16

 

mail recipient test {recipient_name}...............................................................................16

 

mail recipient set {recipient_name} {Inf|War|Err}.........................................................16

 

mail get server.................................................................................................................16

 

mail set server {server_address} {port} {status} {from_address} 

.............

 [username] 

 

Summary of Contents for RAID Managemen

Page 1: ...HighPoint CLI Reference HighPoint RAID Management Command Line Interface Guide Revision 3 1 1 Date Jul 2008 HighPoint Technologies Inc ...

Page 2: ...ment may or may not be registered trademarks or copyrights of their respective owners Disclaimer Backup your important data before using HighPoint s products and use at your own risk In no event shall HighPoint be liable for any loss of profits or for direct indirect special incidental or consequential damages arising from any defect or error in HighPoint s products or Documentation Reasonable eff...

Page 3: ...and 10 Init Commands 10 init device_id 10 Init array_id start stop 10 Rebuild Commands 11 rebuild array_id device_id 11 Rebuild array_id start stop 11 Verify Command 11 OCE ORLM Command 12 Rescan Command 12 SAF TE Commands 13 SAF TE 13 SAF TE set property_index value 13 Events Commands 14 events 14 Events clear 14 events save file_name 14 Mail Commands 15 mail recipient 15 Mail recipient add recip...

Page 4: ... array_id name once daily weekly monthly day interval time mm dd yyyy mm dd yyyy hh mm ss 19 task smart device_id m h interval 19 task delete task_id 19 task enable task_id 20 Set Commands 20 set controller AR y n 20 set controller CE y n 21 set controller BP y n 21 set controller RP 1 100 21 set controller SD minutes 21 Help Commands 22 help 22 help command 23 Exit Command 23 Appendix A Revision ...

Page 5: ...em indicate that it must be specified In commands square brackets around an item indicate that it is optional In commands braces with pipes inside indicate you must specify one option among multiple items In commands square brackets with pipes inside indicate you can either specify one option or more options Whenever you type a parameter with a space it should be enclosed with double quotation mar...

Page 6: ...s provided as a RPM package hptraidconf xxx rpm You can use rpm command to install it rpm i hptraidconf xxx rpm The following file will be installed usr bin hptraidconf the CLI executable usr share hpt hptraidconf 3 1 CLI support files usr share man man1 hptraidconf 1 bz2 CLI man page Installing the HighPoint CLI on FreeBSD Before installation you must log on as root The CLI package is provided as...

Page 7: ...hptraidconf s adapter id Here adapter id specifies the adapter to be managed in case of multiple adapters installed By default the first adapter 0 will be used 2 Enter the username and password to log on to the CLI Note The default username is RAID and the default password is hpt You cannot change the password using CLI to changed password you must use the browser based utility After successfully ...

Page 8: ...HighPoint CLI Reference Example hptraidconf u RAID p hpt query controllers Will display information of the controller 4 ...

Page 9: ...ery Commands Syntax query controllers query devices query devices device_id query arrays query arrays array_id query controllers This command reports controller information Example HighPoint CLI query controllers Typical output ID Channels Name 1 8 RocketRAID 3522 SATA Controller Note This release of CLI can only manage one adapter at a time So there will be only one controller listed even if you ...

Page 10: ... NORMAL WDC WD2500JD 00GBB0 1 2 1 249 98 249 98 SINGLE NORMAL WDC WD2500JD 00GBB0 1 3 1 249 98 249 98 SINGLE NORMAL WDC WD2500JD 00HBB0 1 4 1 249 98 249 98 SINGLE NORMAL WDC WD2500JD 00GBB0 1 5 1 249 98 249 98 SINGLE NORMAL WDC WD2500JD 00HBB0 1 6 1 249 98 249 98 SINGLE NORMAL WDC WD2500JD 00GBB0 1 7 1 249 98 249 98 SINGLE NORMAL WDC WD2500JD 00HBB0 1 8 1 249 98 249 98 SINGLE NORMAL WDC WD2500JD 0...

Page 11: ...C8 Multi Zone Error Rate 51 200 155 OK query arrays This command lists information for all configured arrays It will list each array s ID capacity RAID level and status information Note An array ID is generally represented by number or set of numbers For RAID1 0 arrays each sub array will be represented by an ID in the format 1 1 1 2 An array ID is used in the command line where an array needs to ...

Page 12: ...or add a spare disk or expand migrate an existing array Syntax create RAID0 RAID1 RAID10 RAID3 RAID5 RAID6 RAID50 JBOD spare create options Parameters You can specify one or more create options for this command separated by space The options can be typed in any order disks specifies member disks which will compose a new array e g disks 1 1 1 2 disks The character means all available drives init sp...

Page 13: ...rs m Examples HighPoint CLI create RAID0 name myraid0 disks 1 3 1 4 This command instructs the system to create an RAID 0 array using the disks attached to controller 1 channels 3 and 4 and name it myraid0 HighPoint CLI create RAID5 disks src 1 This command instructs the controller to expand an existing array using all the available disks to a RAID5 array HighPoint CLI create spare disks 1 4 This ...

Page 14: ...mands to initialize disks or arrays A drive must be initialized first before being used to create arrays Syntax init device_id init array_id start stop init device_id This command initialize a disk for first use on the controller Example HighPoint CLI init 1 3 This command instructs the controller to initialize the disk on controller 1 channel 3 All data on the disk will be destroyed Init array_id...

Page 15: ...commands first to verify the device ID and the array ID information before the rebuild command Rebuild array_id start stop This command allows you to start or stop the rebuilding process on the specified array After you stopped a rebuilding process you can resume it at a later time by the rebuild start command Examples HighPoint CLI rebuild 1 start This command starts the rebuilding process on the...

Page 16: ...and stops OCE ORLM process on array 1 You can resume the process at later time HighPoint CLI device 1 5 1 d wc This command will disable write cache on the disk on controller 1 channel 5 Array Command This command will set optional array features Currently only cache policy setting for RAID5 is supported Syntax array array_id cp WB WT None Example HighPoint CLI array 1 cp WB This command will set ...

Page 17: ...configuration file under usr share hpt hptsvr xxx conf to etc I2csep conf to enable support for SAF TE enclosures The RAID management service hptsvr needs to be restarted when the configuration file is updated Syntax SAF TE SAF TE set property_index value SAF TE This command will display the enclosure status information Example HighPoint CLI SAF TE Typical output Index Name Value Status Editable 0...

Page 18: ...AID from 127 0 0 1 exited from system 2 Inf 10 12 2004 15 26 30 User RAID from 127 0 0 1 logged on system 3 Inf 10 12 2004 15 26 34 Array myraid verifying started 4 War 10 12 2004 15 31 35 Array myraid verifying aborted 5 Inf 10 12 2004 15 31 36 User RAID from 127 0 0 1 exited from system 6 Inf 10 12 2004 15 32 15 User RAID from 127 0 0 1 logged on system 7 Inf 10 12 2004 15 32 51 User RAID from 1...

Page 19: ...ss port status from_address username password mail server set a p s m u t value mail recipient List all the mail recipients Example HighPoint CLI mail recipient Typical output ID Name Mail Address Notify Types 1 RAID admin somecompany com Information Warning Error 2 Kate kate somecompany com Warning Error Mail recipient add recipient_name mail_address Inf War Err Add a not exist recipient Example ...

Page 20: ...nt_name Inf War Err Set the notification type for a recipient Example HighPoint CLI mail recipient set admin War Err mail server Print the SMTP server information Example HighPoint CLI mail server Typical output Server Address Port Status Mail from mail somecompany com 25 disabled admin somecompany com mail server set server_address port status from_address username password Use this command to co...

Page 21: ...server value Parameters a SMTP server address p port generally 25 s status e for enable or d for disable m mail from address u username t user s password Examples HighPoint CLI mail server set a smtp somecompany com Change the server address HighPoint CLI mail server set p 25 Change the port HighPoint CLI mail server set s d Disable mail notification HighPoint CLI mail server set s e Enable mail n...

Page 22: ...isplays detailed information about all scheduled tasks Example HighPoint CLI task This command displays the current background tasks ID Task Description Start Date End Date Time S 1 Rebuild Array_1 created by RAID 10 08 2004 10 20 30 E task rebuild array_id once daily weekly monthly day interval interval start mm dd yyyy end mm dd yyyy time hh mm ss This command allows you to schedule the frequenc...

Page 23: ... 2 8 2004 to 2 22 2008 HighPoint CLI task rebuild 2 monthly 3 interval 4 start 2 8 2004 end 2 8 2006 time 12 30 33 This command adds a task schedule to rebuild the array 2 at 12 30 33 on the 3rd day of a month every 4 months from 2 8 2004 to 2 8 2006 task verify array_id name once daily weekly monthly day interval interval start mm dd yyyy end mm dd yyyy time hh mm ss This command allows you to sc...

Page 24: ... task 1 task disable task_id This command will disable a scheduled task manually Example HighPoint CLI task disable 1 This command will disable the scheduled task 1 Set Commands Note Not all controllers and drivers support this command Syntax set name value set set controller RP 0 100 Change rebuilding priority If controller is not specified this command will set the global rebuilding priority Not...

Page 25: ...isable to the Continue Rebuilding On Error parameter Example HighPoint CLI set CE y set controller BP y n Set enable or disable beeper Example HighPoint CLI set BP y set controller SD minutes Set value of Spindown Idle Disk Example HighPoint CLI set SD 10 Setting device parameters Syntax set device id tcq y n ncq y n wc y n ra y n smart y n The options are z tcq y n Set enable or disable to the tc...

Page 26: ... parameter Example HighPoint CLI set 1 2 tcq y ncq n wc y ra y Setting array parameters Syntax set array id name name cp wt wb none The options are z array id The array ID z name name Set the array name This is a option to rename an array z cp wt wb none Set the cache policy of an array Example HighPoint CLI set 1 name my_arr init y cp none Help Commands Syntax help help command help Show generic ...

Page 27: ...nt CLI Reference Example HighPoint CLI help help command Show help about a specific command Example HighPoint CLI help create Exit Command Syntax exit Exit from the interactive mode and return to the shell 23 ...

Page 28: ...lier versions 2 3 4 2007 03 09 Add port multiplier support Add serial number display 2 3 3 2006 11 20 Use static link Show more fields in controller information 2 3 1 2006 08 08 Add RR3xxx adapter support 2 2 1 2006 03 01 Fix email command error 2 1 3 2005 11 25 Add RAID50 support Add deb package for Debian installation 2 1 1 2005 8 8 Use static link 2 0 2 2005 6 30 Minor fixes 2 0 1 2005 4 8 Firs...

Reviews: