Summary of the content on the page No. 1
eXpeRAID
Command Line Interface
User Guide
Nov 05, 2007
Version: 1.0
Summary of the content on the page No. 2
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” DOCUMENT STATUS OFFICIAL RELEASE REV. G–05-NOV-2007 PAGE 2 OF 27 Revision History Rev – A JeffChang 1. Initial Draft. 11-JUN -2007 Rev – B 2. Removed unnecessary commands and modified command ShoneCheng 10-AUG -2007 names to match GUI’s. 3. Modified some command names and parameters of command Rev – C ‘SetLunMap’, ‘CreateShot’ and ‘MigrateArray
Summary of the content on the page No. 3
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” DOCUMENT STATUS OFFICIAL RELEASE REV. G–05-NOV-2007 PAGE 3 OF 27 Contents 1. Introduction......................................................................6 1.1 Overview..................................................................................................................6 2. Using CLI...................................................
Summary of the content on the page No. 4
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” DOCUMENT STATUS OFFICIAL RELEASE REV. G–05-NOV-2007 PAGE 4 OF 27 3.3.3 Basic Array Configuration Commands.........................................................16 3.3.3.1 CreateArray 3.3.3.2 DeleteArray 3.3.3.3 CreateJBOD 3.3.3.4 DeleteJBOD 3.3.3.5 SetSlice 3.3.3.6 SetLunMap 3.3.3.7 DeleteLunMap 3.3.4 Advanced Array Configuration Commands.....
Summary of the content on the page No. 5
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” DOCUMENT STATUS OFFICIAL RELEASE REV. G–05-NOV-2007 PAGE 5 OF 27 3.3.7.1 UpdateSystemCode 3.3.7.2 UpdateBootCode 3.3.7.3 UpdateBIOSEFI Appendix I. .........................................................................27
Summary of the content on the page No. 6
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” DOCUMENT STATUS OFFICIAL RELEASE REV. G–05-NOV-2007 PAGE 6 OF 27 1. Introduction This user guide provides eXpeRAID Command Line Interface (CLI) instructions for configuring and maintaining your eXpeRAID. Before using this CLI, we assume that you have already installed your controller in your system. If you have not yet installed eXpeRAID, see Accu
Summary of the content on the page No. 7
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” DOCUMENT STATUS OFFICIAL RELEASE REV. G–05-NOV-2007 PAGE 7 OF 27 2. Using CLI 2.1 Pre-action Before using CLI, make sure the controller(s) has been connected to the host and the driver(s) of the controller(s) has been installed on the OS properly. Under Linux, you may need to execute the following command to let CLI find the controller normally: mk
Summary of the content on the page No. 8
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” DOCUMENT STATUS OFFICIAL RELEASE REV. G–05-NOV-2007 PAGE 8 OF 27 3. Type: mknod /dev/ACS_CDEV0 c 253 0 [Enter], a device file “ACS_CDEV0” will be created and CLI will be able to find the controller through this device file. 2.2 Execution Mode There are two methods to run CLI commands - interactive mode and non-interactive mode. For each mode, all
Summary of the content on the page No. 9
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” DOCUMENT STATUS OFFICIAL RELEASE REV. G–05-NOV-2007 PAGE 9 OF 27 This non-interactive mode is implemented by calling the CLI command "RunScript". For example: In Sample1.sh(Included in the folder where CLI application is located) under Linux, it contains the following commands: ./acs_cli RunScript acs_sample1.script ./acs_cli RunScript a
Summary of the content on the page No. 10
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” DOCUMENT STATUS OFFICIAL RELEASE REV. G–05-NOV-2007 PAGE 10 OF 27 3. CLI Command Line Configuration 3.1 CLI Command Format Command Name Command Description Command Parameter 1 Parameter Description [Format 1] Parameter 2 [Format 2] Parameter 3 … Parameter n [Format n] Example Command Format field description: Command Name: CLI Comma
Summary of the content on the page No. 11
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” DOCUMENT STATUS OFFICIAL RELEASE REV. G–05-NOV-2007 PAGE 11 OF 27 3.2 CLI Reply Status InBand(Controller) command success. InBand command failed. CLI will display “Reason: ”. Invalid command: CLI receives unrecognized commands. Invalid parameter “Param”: CLI receives incorrect parameter of the input command. CLI will
Summary of the content on the page No. 12
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” DOCUMENT STATUS OFFICIAL RELEASE REV. G–05-NOV-2007 PAGE 12 OF 27 3.3 CLI Command Set 3.3.1 Basic CLI Commands 3.3.1.1 Command Name Command Description Main Use this command to show the main information page, which lists all available CLI commands with brief descriptions. Parameter Description N/A 3.3.1.2 Command Name Command Description C
Summary of the content on the page No. 13
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” DOCUMENT STATUS OFFICIAL RELEASE REV. G–05-NOV-2007 PAGE 13 OF 27 3.3.1.4 Command Name Command Description SetPassword Use this command to set password of the active controller. Parameter 1 Parameter Description Password: Password: CHARS must be an 8-character alphabetic string. 3.3.1.5 Command Name Command Description CtrlName Use thi
Summary of the content on the page No. 14
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” DOCUMENT STATUS OFFICIAL RELEASE REV. G–05-NOV-2007 PAGE 14 OF 27 3.3.2 Information Display Commands 3.3.2.1 Command Name Command Description DumpArrayInfo Use this command to display information of the specified array. Parameter 1 Parameter Description Array No.: Array No.: <1~4> Specified array number from 1 ~ 4 for information display. Example
Summary of the content on the page No. 15
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” DOCUMENT STATUS OFFICIAL RELEASE REV. G–05-NOV-2007 PAGE 15 OF 27 3.3.2.6 Command Name Command Description DumpLockDriveInfo Use this command to display information of all locked drives. Parameter Description N/A 3.3.2.7 Command Name Command Description DumpSnapShotInfo Use this command to display information of all existing mirror snapshots
Summary of the content on the page No. 16
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” DOCUMENT STATUS OFFICIAL RELEASE REV. G–05-NOV-2007 PAGE 16 OF 27 3.3.3 Basic Array Configuration Commands 3.3.3.1 Command Name Command Description CreateArray Use this command to create an array with specified RAID level. Parameter 1 Parameter Description RAID Level: RAID Level: > R1: RAID Level 1 R5: R
Summary of the content on the page No. 17
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” DOCUMENT STATUS OFFICIAL RELEASE REV. G–05-NOV-2007 PAGE 17 OF 27 3.3.3.2 Command Name Command Description DeleteArray Use this command to delete a specified array. Parameter 1 Parameter Description Array No.: Array No.: <1~4> Specify an array number to be deleted. Example CLI>DeleteArray 1 [Enter] Array 1 will be deleted if it exists and is n
Summary of the content on the page No. 18
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” DOCUMENT STATUS OFFICIAL RELEASE REV. G–05-NOV-2007 PAGE 18 OF 27 3.3.3.6 Command Name Command Description SetLunMap Use this command to set a Lun Map for an existing slice or JBOD. Parameter 1 Parameter Description LUN No.: LUN No.: > Specify the Lun number to be mapped. Parameter 2 Array No.: Array No.: Array =1~4, Maps Lun t
Summary of the content on the page No. 19
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” DOCUMENT STATUS OFFICIAL RELEASE REV. G–05-NOV-2007 PAGE 19 OF 27 3.3.4 Advanced Array Configuration Commands 3.3.4.1 Command Name Command Description ExpandArray Use this command to expand an array with specified drive count. Parameter 1 Parameter Description Array No.: Array No.: > Specify an array number to be expanded. Parameter
Summary of the content on the page No. 20
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” DOCUMENT STATUS OFFICIAL RELEASE REV. G–05-NOV-2007 PAGE 20 OF 27 3.3.4.3 Command Name Command Description RebuildParity Use this command to rebuild parity of an array which contains parity. i.e. RAID 5 or RAID 6. Parameter 1 Parameter Description Array No.: Array No.: > Specify an array number to rebuild parity. Parameter 2 Status
