Subscribe to Our Youtube Channel
Summary of Contents for HighPoint RAID Management
- Page 1 HighPoint CLI Reference HighPoint RAID Management Command Line Interface Guide Revision: 3.1-1 Date: Jul 2008 HighPoint Technologies, Inc.
- Page 2 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.
-
Page 3: Table Of Contents
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... - Page 4 HighPoint CLI Reference [password]........................16 mail set server {a|p|s|m|u|t} {value}................17 Task Commands........................17 task ..........................18 task rebuild {array_id} {once|daily|weekly|monthly} {day} {interval} time=mm/dd/yyyy, mm/dd/yyyy, hh:mm:ss ..............18 task verify {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...
-
Page 5: Conventions
HighPoint CLI Reference Conventions The following conventions are used through this guide: is used for what you type on the command line and for the Bold font screen output. In commands, braces {} around an item indicate that it must be specified. -
Page 6: Introduction To The Highpoint Command Line Interface
Line Interface The HighPoint CLI (Command Line Interface) is a command line utility that configures and manages HighPoint RAID controllers via a command line. It is ideal for systems where the browser-based RAID Management utility cannot be used. Supported Operation Systems and Adapters The current CLI release supports Linux and FreeBSD operating systems. - Page 7 For RR1xxx, RR2xxx, and RR3xxx adapters without out-of-band management: # hptraidconf [-i server-address:port] Here server-address:port specifies the network address and TCP port of the RAID management service (hptsvr). By default, localhost:7402 will be used. For RR3xxx and RR4xxx adapters with out-of-band management:...
- Page 8 HighPoint CLI Reference Example hptraidconf –u RAID –p hpt query controllers Will display information of the controller. - 4 -...
-
Page 9: Cli Command Reference
HighPoint CLI Reference CLI Command Reference This chapter discusses the various HighPoint CLI commands: Query, Create, Delete, Rename, Rebuild, Device, Verify, Task, Rescan, Events, Reboot, User, Mail, Help and Exit. Warning: Operations under the Create/Delete commands may destroy data stored in the disks, and the lost data can never be recovered. -
Page 10: Query Devices {Device_Id
1/8/1 249.98 249.98 SINGLE NORMAL WDC WD2500JD-00GBB0 ---------------------------------------------------------------------- query devices {device_id} This command presents information for the specified device. Example HighPoint CLI> query devices 1/2 Typical output: Mode Number: WDC WD2500JD-00GBB0 Serial Number: WD-WMAEP1932426 Capacity(GB): 249.98 TotalFree(GB): 249.98 Status: SINGLE... -
Page 11: Query Arrays
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 be specified. Example HighPoint CLI> query arrays Typical output: HighPoint CLI>query arrays Capacity(GB) -
Page 12: Create Command
HighPoint CLI Reference Example HighPoint CLI> query arrays 1 Typical output: HighPoint CLI>query arrays 1 Name: MY_RAID5 Type: RAID5 Status: NORMAL Capacity(GB): 50.00 BlockSize: 128k SectorSize: 512B CachePolicy: Progress: Capacity MaxFree Flag Status ModelNumber --------------------------------------------------------------------- 1/5/1 249.98 223.31 NORMAL RAID... -
Page 13: Delete Command
(RAID50 only) specifies the number of RAID5’s members (n) and the number of RAID0’s members (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>... -
Page 14: Unplug Command
Init {array_id} {start|stop} This command starts/stops initialization process on a redundant array. Example HighPoint CLI> init 1 stop This command instructs the controller to stop initialization process on array 1. You can continue the initialization at a later time. - 10 -... -
Page 15: Rebuild Commands
{array_id} {device_id} This command allows you to add the specified disk to a broken array and rebuild it. Example HighPoint CLI> rebuild 1 1/3 This command instructs the controller to add the disk “ ” to rebuild the array “... -
Page 16: Oce/Orlm Command
This command stops OCE/ORLM process on array “ ”. 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. -
Page 17: Saf-Te Commands
SAF-TE enclosure information properly configured in HighPoint RAID management service. To use HighPoint RAID management service with SAF-TE enclosures, a customized configuration file (/etc/I2csep.conf) is needed. By default no config file is setup; you can copy one of the provided configuration file under /usr/share/hpt/hptsvr-xxx/ (*.conf) to /etc/I2csep.conf to enable support for... -
Page 18: Events Commands
User RAID (from 127.0.0.1) logged on system. Events clear This command will clear all the logged events. Example HighPoint CLI> events clear events save {file_name} This command will save all the logged events as a plain text file. Example - 14 -... -
Page 19: Mail Commands
Warning, Error. Mail recipient add {recipient_name} {mail_address} [Inf|War|Err] --- Add a not exist recipient Example HighPoint CLI> mail recipient add admin admin@somecompany.com Inf War Err This command will setup the RAID system to send mail to admin@somecompany.com about all logged events. -
Page 20: Mail Recipient Delete {Recipient_Name
HighPoint CLI> mail recipient test RAID mail recipient set {recipient_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... -
Page 21: Mail Set Server {A|P|S|M|U|T} {Value
{username} – username {password} – the user’s password Examples: HighPoint CLI> mail server set mail.somecompany.com 25 e admin@somecompany.com HighPoint CLI> mail server set mail.somecompany.com 25 d admin@somecompany.com mail server set {a|p|s|m|u|t} {value} --- Use this to separate set your mail server value Parameters a –... -
Page 22: Task
HighPoint CLI Reference long as you have the appropriate privileges, you can add new tasks, and modify or delete existing tasks. Syntax task task rebuild {array_id} {name=} {once|daily|monthly|weekly}={day} interval={interval} start=mm/dd/yyyy end=mm/dd/yyyy time=hh:mm:ss task verify {array_id} {name=} {once|daily|monthly|weekly}={day} interval={interval} start=mm/dd/yyyy end=mm/dd/yyyy time=hh:mm:ss... -
Page 23: Task Verify {Array_Id} {Name=} {Once|Daily|Weekly|Monthly} {Day} {Interval} Time=Mm/Dd/Yyyy, Mm/Dd/Yyyy, Hh:mm:ss
”at . The rebuild frequency is set to 12:35:46 10/8/2005 once HighPoint CLI> task rebuild 4 daily interval=2 start=2/8/2005 end=2/22/2005 time=13:49:58 This command adds a task schedule named to rebuild the myraid4 array ” ” at every... -
Page 24: Task Enable {Task_Id
HighPoint CLI Reference ID by command. task Example HighPoint CLI> task delete 2 ”2” This command will delete the task task enable {task_id} This command will enable a disabled task. Example HighPoint CLI> task enable 1 ”1” This command will enable the disabled task task disable {task_id} This command will disable a scheduled task manually. -
Page 25: Set {Controller} Ce=[Y|N]
HighPoint CLI Reference [88-100] Highest Example HighPoint CLI> set RP=50 set {controller} AR=[y|n] Set enable or disable to the [Auto Rebuild] parameter. Example HighPoint CLI> set AR=y set {controller} CE=[y|n] Set enable or disable to the [Continue Rebuilding On Error] parameter. -
Page 26: Help Commands
Set enable or disable to the ra parameter. smart=[y|n] Set enable or disable to the smart 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: {array id} The array ID. -
Page 27: Help {Command
HighPoint 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: Appendix A Revision History
HighPoint CLI Reference Appendix A Revision History Version Date Updates 3.1-1 2008/07/07 Support all RR2xxx,3xxx,4xxx adapters. 3.0-1 2008/01/18 Port to support adapters with out-of-band management feature. Not compatible with earlier versions. 2.3-4 2007/03/09 Add port multiplier support. Add serial number display.
Need help?
Do you have a question about the RAID Management and is the answer not in the manual?
Questions and answers