HighPoint RAID Management User manual

HighPoint CLI Reference
HighPoint RAID Management
Command Line Interface Guide
Revision: 3.1-1
Date: Jul 2008
HighPoint Technologies, Inc.

HighPoint CLI Reference
Copyright
© 2008 HighPoint Technologies, Inc. All rights reserved. No part of this publication may be
reproduced, stored in a retrieval system, transmitted or transcribed in any form or by any means,
electronic, mechanical, photocopying, recording or otherwise for any purpose, without the express
written permission of HighPoint Technologies, Inc.
Trademarks
Companies and products mentioned in this document are for identification purpose only. Product
names or brand names appearing in this document 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 effort has been made to ensure that the information in this document is accurate. Informa-
tion in this document is subject to change without notice and does not represent a commitment on the
part of HighPoint. HighPoint assumes no liability for technical inaccuracies, typographical, or other
errors contained herein.

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]

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
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 History.......................................................................................................24

HighPoint CLI Reference
Conventions
The following conventions are used through this guide:
Bold font is used for what you type on the command line and for the
screen output.
In commands, braces {} around an item 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 marks “”.
- 1 -

HighPoint CLI Reference
Introduction to the HighPoint Command
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.
Installing the HighPoint CLI on Linux
Before installation, you must log on as root.
The CLI package is 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 a .tbz package, hptraidconf-xxx.tbz. You can
use pkg_add command to install it:
# pkg_add hptraidconf-xxx.tbz
The following files will be installed/configured:
/usr/bin/hptraidconf - link to the CLI executable
/usr/share/hpt/hptraidconf-xxx/* - package files
Running HighPoint CLI
You can run the HighPoint CLI software two ways:
- 2 -

HighPoint CLI Reference
yEntering commands at the CLI prompt
yEntering a string of a single commands on one command line
Using the CLI prompt:
You can enter commands at the main prompt and view the output on-screen.
To use the HighPoint CLI prompt, follow these steps:
1 Enter the following command at the shell prompt:
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:
# 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.
2Enter 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 logging in, the main prompt of the CLI will be
displayed:
HighPoint CLI>
Commands are entered at the CLI prompt. The CLI Command
Reference section discusses these commands in detail (see page 4).
Using a single command line
You can enter a complete command with parameters at the shell prompt and
receive one output result on the screen at a time.
Syntax
hptraidconf [-s adapter-id | -i server-address:port] –u {username} –p
{password} {command}
- 3 -

HighPoint CLI Reference
Example
#
hptraidconf –u RAID –p hpt query controllers
Will display information of the controller.
- 4 -

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. So you should take special
care when executing these commands. The CLI utility will not prompt before
each operation is committed.
Query 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 have multiple adapters installed.
query devices
This command presents status of all the physical devices to the controllers. It
provides a list of device ID, capacity, model number, status and array
attributes. Each device’s status will be listed as one of the following:
- 5 -

HighPoint CLI Reference
NORMAL, DISABLED, SPARE, and BOOT. The BOOT status means the
disk has been set to boot disk in the controller BIOS.
Note:
A device ID is a string used to represent a disk. It is in the format
“controller/port” for SATA controllers, and “controller/channel/device” for
PATA controllers. E.g. 1/2 represents the disk on controller 1 port 2; 1/2/1
represents the disk on controller 1 channel 2 master disk; 1/2/2 represents the
disk on controller 1 channel 2 slave disk.
Example
HighPoint CLI> query devices
Typical output:
ID Capacity MaxFree Flag Statue ModelNumber
---------------------------------------------------------------------
1/1/1 249.98 249.98 SINGLE 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-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 Flag NORMAL
Read Ahead: enabled Write Cache: enabled
TCQ: -- NCQ: --
---------------------------------------------------------------------
S.M.A.R.T Attributes
Status: S.M.A.R.T OK.
ID Name Threshold Value Worst Status
- 6 -

HighPoint CLI Reference
---------------------------------------------------------------------
1 Raw Read Error Rate 51 200 150 OK
3 Spin Up Time 21 122 97 OK
4 Start Stop Count 40 94 94 OK
5 Reallocated Sector Ct 140 195 195 OK
7 Seek Error Rate 51 200 200 OK
9 Power On Hours 0 91 91 OK
A Spin Retry Count 51 100 100 OK
B Calibration Retry Count 51 100 100 OK
C Power Cycle Count 0 95 95 OK
C2 Temperature Celsius 0 106 253 OK
C4 Reallocated Event Count 0 188 188 OK
C5 Current Pending Sector 0 200 200 OK
C6 Offline Uncorrectable 0 200 200 OK
C7 UDMA CRC Error Count 0 200 253 OK
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 be specified.
Example
HighPoint CLI> query arrays
Typical output:
HighPoint CLI>query arrays
ID Capacity(GB) Type Statue Block Sector Cache Name
---------------------------------------------------------------------------
1 50.00 RAID5 NORMAL 128k 512B -- MY_RAID5
2 10.00 RAID1 NORMAL 64k 512B -- RAID1_1
query arrays {array_id}
This command will present information of each disk of a specified array.
- 7 -

HighPoint CLI Reference
Example
HighPoint CLI> query arrays 1
Typical output:
HighPoint CLI>query arrays 1
ID: 1 Name: MY_RAID5
Type: RAID5 Status: NORMAL
Capacity(GB): 50.00 BlockSize: 128k
SectorSize: 512B CachePolicy: --
Progress: --
ID Capacity MaxFree Flag Status ModelNumber
---------------------------------------------------------------------
1/5/1 249.98 223.31 NORMAL RAID WDC WD2500JD-00HBB0
1/6/1 249.98 223.31 NORMAL RAID WDC WD2500JD-00GBB0
1/7/1 249.98 233.31 NORMAL RAID WDC WD2500JD-00HBB0
1/8/1 249.98 233.31 NORMAL RAID WDC WD2500JD-00GBB0
---------------------------------------------------------------------
Create Command
This command allows you to create a new RAID array, 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= specifies initialization option (foreground or background). The
default option is create-only. The create-only option is
applicable for all the RAID types, which is to create an array
without any initialization process. Initialization is needed for
redundant arrays to provide data redundancy.
name= specifies the name for the array being created.
- 8 -

HighPoint CLI Reference
If the option is omitted, the utility will assign a default name for
the array.
src= specifies an existing array to be expanded/migrated. All data on
the source array will be redistributed online to the target array.
If this parameter is omitted, a new array is created.
capacity= specifies the capacity, in size of MB, for the target array.
bs= specifies the block size, in KB, for the target array. This option
is only valid for stripped RAID levels.
sector= specifies the logical sector size, in KB, for the target array. This
option is only valid for stripped RAID levels.
matrix=n*m
(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> 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 command indicates that you will set the disk on controller 1 channel 4 to
be a spare disk.
Delete Command
This command allows you to delete an existing RAID array or remove a
spare disk. After deletion, the original array and all data on it will be lost. All
the member disks will be listed as available single disks.
Syntax
delete {array_or_spare_ID}
Examples
HighPoint CLI> delete 1/3
This command indicates to remove the spare disk on controller 1 channel 3.
HighPoint CLI> delete 1
- 9 -

HighPoint CLI Reference
This command indicates to delete the array whose id is “1”. You can query
the array ID before the deletion.
Unplug Command
This command allows you to remove an array or disk from a running system
without shutting down.
Syntax
unplug {array_id or device_id}
Example
HighPoint CLI> unplug 1
This command instructs the controller to disconnect the array “1” and then
you can disconnect the drives safely.
Init Commands
You can use init commands 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} {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 -

HighPoint CLI Reference
Rebuild Commands
You can use rebuild commands to rebuild a RAID1, RAID1/0 or RAID5
array when it is critical or broken.
Syntax
rebuild {array_id} {device_id}
rebuild {array_id} {start|stop}
rebuild {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 “1/3” to rebuild the
array “1”. You can use the query 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 array “1”.
HighPoint CLI> rebuild 1 stop
This command stops the rebuilding process on the array “1”.
Verify Command
Syntax
verify {array_id} {start|stop}
This command starts or stops the verify process on the specified array.
Examples
HighPoint CLI> verify 1 start
- 11 -

HighPoint CLI Reference
This command starts to verify the array “1”.
HighPoint CLI> verify 1 stop
This command stops the verify process on the array “1”.
OCE/ORLM Command
Syntax
OCE/ORLM {array_id} {start|stop}
This command starts or stops the OCE/ORLM process on the specified array.
The OCE/ORLM process should be first created via create command.
Examples
HighPoint CLI> OCE/ORLM 1 stop
This command 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 the cache policy to write back on array 1.
Rescan Command
This command will rescan all of the physical devices attached to the RAID
controller.
Syntax
rescan
Example
HighPoint CLI> rescan
- 12 -

HighPoint CLI Reference
SAF-TE Commands
The SAF-TE command is used to manage SAF-TE enclosures. This command
only works when you have 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
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 Temperature 38 False
1 Fan Speed 2960 False
2 Temperature Limit 60 True
SAF-TE set {property_index} value
This command updates the value of a specified enclosure property.
Example
HighPoint CLI> SAF-TE set 2 66
- 13 -

HighPoint CLI Reference
Events Commands
The CLI system will automatically record three types of events: Information
(shortened to “Inf”), Warning (shortened to “War”), and Error (shortened to
“Err”) on the screen output. These commands allow you to query, save, or
clear the logged events.
Syntax
events
events clear
events save {file_name}
events
This command will display a list of all the logged events.
Example
HighPoint CLI> events
Typical output:
ID Type Time Description
1 Inf [10/12/2004 15:26:21] User RAID (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 127.0.0.1) exited from system.
8 Inf [10/12/2004 15:37:00] 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 -

HighPoint CLI Reference
HighPoint CLI> events save /tmp/raidlog.txt
This command will save all the events to /tmp/raidlog.txt.
Mail Commands
Syntax
mail recipient
mail recipient add {recipient_name}{mail_address} [Inf|War|Err]
mail recipient delete {recipient_name}
mail recipient test {recipient_name}
mail recipient set {recipient_name}{Inf|War|Err}
mail server
mail server set {server_address}{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 [email protected] Information, Warning, Error.
2 Kate [email protected] Warning, Error.
Mail recipient add {recipient_name} {mail_address} [Inf|War|Err]
--- Add a not exist recipient
Example
HighPoint CLI> mail recipient add admin [e-mail] Inf War Err
This command will setup the RAID system to send mail to
[email protected] about all logged events.
- 15 -

HighPoint CLI Reference
Mail recipient delete {recipient_name}
--- Delete an exist recipient.
Example
HighPoint CLI> mail recipient delete Ferry
mail recipient test {recipient_name}
--- Send a testing mail to specified recipient.
Example
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
Typical output:
Server Address Port Status Mail from
mail.somecompany.com 25 disabled [email protected]
mail server set {server_address} {port} {status} {from_address}
[username] [password]
--- Use this command to configure mail server settings.
{server_address} – SMTP server address
{port} – port, generally 25
- 16 -