Inc. Command Line Interface User Guide

ManualsBrandsAccusys ManualsNetwork CardeXpeRAID

eXpeRAID

Command Line Interface

User Guide

Nov 05, 2007

Version: 1.0

Summary of content (27 pages)

PAGE 1
eXpeRAID Command Line Interface User Guide Nov 05, 2007 Version: 1.
PAGE 2
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 OFFICIAL RELEASE PAGE 2 OF 27 Revision History Rev – A 11-JUN -2007 Rev – B 10-AUG -2007 JeffChang ShoneCheng 1. Initial Draft. 2. Removed unnecessary commands and modified command names to match GUI’s.
PAGE 3
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 OFFICIAL RELEASE PAGE 3 OF 27 Contents 1. Introduction......................................................................6 1.1 Overview..................................................................................................................6 2. Using CLI......................................................................
PAGE 4
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 OFFICIAL RELEASE 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..............................
PAGE 5
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 OFFICIAL RELEASE PAGE 5 OF 27 3.3.7.1 UpdateSystemCode 3.3.7.2 UpdateBootCode 3.3.7.3 UpdateBIOSEFI Appendix I. .........................................................................
PAGE 6
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 OFFICIAL RELEASE 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.
PAGE 7
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 OFFICIAL RELEASE 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.
PAGE 8
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 OFFICIAL RELEASE 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.
PAGE 9
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 OFFICIAL RELEASE 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 acs_sample2.
PAGE 10
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 OFFICIAL RELEASE PAGE 10 OF 27 3. CLI Command Line Configuration 3.1 CLI Command Format Command Name Command Parameter 1 [Format 1] Parameter 2 [Format 2] Parameter 3 … Parameter n [Format n] Command Description Parameter Description Example Command Format field description: Command Name: CLI Command Name.
PAGE 11
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 OFFICIAL RELEASE PAGE 11 OF 27 3.2 CLI Reply Status z z InBand(Controller) command success. InBand command failed. CLI will display “Reason: ”. z z Invalid command: CLI receives unrecognized commands. Invalid parameter “Param”: CLI receives incorrect parameter of the input command.
PAGE 12
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 OFFICIAL RELEASE PAGE 12 OF 27 3.3 CLI Command Set 3.3.1 Basic CLI Commands 3.3.1.1 Command Name Main 3.3.1.2 Command Name CtrlIndex Parameter 1 Controller index: <0~n> 3.3.1.
PAGE 13
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 OFFICIAL RELEASE PAGE 13 OF 27 3.3.1.4 Command Name SetPassword Parameter 1 Password: Command Description Use this command to set password of the active controller. Parameter Description Password: CHARS must be an 8-character alphabetic string. 3.3.1.
PAGE 14
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 OFFICIAL RELEASE PAGE 14 OF 27 3.3.2 Information Display Commands 3.3.2.1 Command Name DumpArrayInfo Parameter 1 Array No.: <1~4> Command Description Use this command to display information of the specified array. Parameter Description Array No.: Specified array number from 1 ~ 4 for information display.
PAGE 15
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 3.3.2.6 Command Name DumpLockDriveInfo 3.3.2.7 Command Name DumpSnapShotInfo 3.3.2.8 Command Name DumpMiscInfo 3.3.2.9 Command Name DumpDriveInfo OFFICIAL RELEASE PAGE 15 OF 27 Command Description Use this command to display information of all locked drives.
PAGE 16
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 OFFICIAL RELEASE PAGE 16 OF 27 3.3.3 Basic Array Configuration Commands 3.3.3.
PAGE 17
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 3.3.3.2 Command Name DeleteArray Parameter 1 Array No.: <1~4> OFFICIAL RELEASE PAGE 17 OF 27 Command Description Use this command to delete a specified array. Parameter Description Array No.: Specify an array number to be deleted. Example CLI>DeleteArray 1 [Enter] Array 1 will be deleted if it exists and is not in use. 3.3.3.
PAGE 18
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 3.3.3.6 Command Name SetLunMap Parameter 1 LUN No.: > Parameter 2 Array No.: : JBOD= <1~n>> Parameter 3 Slice No.: > OFFICIAL RELEASE PAGE 18 OF 27 Command Description Use this command to set a Lun Map for an existing slice or JBOD. Parameter Description LUN No.
PAGE 19
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 OFFICIAL RELEASE PAGE 19 OF 27 3.3.4 Advanced Array Configuration Commands 3.3.4.1 Command Name ExpandArray Parameter 1 Array No.: > Parameter 2 Drive Count: > 3.3.4.2 Command Name MigrateArray Parameter 1 Array No.
PAGE 20
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 3.3.4.3 Command Name RebuildParity Parameter 1 Array No.: > Parameter 2 State setting: > OFFICIAL RELEASE PAGE 20 OF 27 Command Description Use this command to rebuild parity of an array which contains parity. i.e. RAID 5 or RAID 6. Parameter Description Array No.
PAGE 21
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 3.3.4.6 Command Name RefreshPriority OFFICIAL RELEASE PAGE 21 OF 27 Parameter 1 Command Description Use this command to set the priority of array refreshment. This setting would be applied to all arrays which are being refreshed. Parameter Description Select the priority for array refreshment function. 3.3.4.
PAGE 22
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 OFFICIAL RELEASE PAGE 22 OF 27 3.3.5.2 Command Name DeleteShot Parameter 1 Shot No.: <1~8> Command Description Use this command to delete a mirror snapshot. Parameter Description Shot No.: Specify an existing mirror snapshot to be deleted. 3.3.5.3 Command Name ResyncShot Parameter 1 Shot No.
PAGE 23
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 3.3.5.6 Command Name CancelSplitSchedule Parameter 1 Shot No.: <1~8> OFFICIAL RELEASE PAGE 23 OF 27 Command Description Use this command to cancel split schedule for the specified mirror snapshot. Parameter Description Shot No.: Specify an existing mirror snapshot to cancel schedule. 3.3.6 Miscellaneous Commands 3.3.6.
PAGE 24
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 3.3.6.4 Command Name SMARTPollingPeriod Parameter 1 Polling Time: <1Min:15Min:30Min: 60Min:2Hr:4Hr:8Hr> OFFICIAL RELEASE PAGE 24 OF 27 Command Description Use this command to set the polling frequency of SMART pre-failure warning mode. Parameter Description Polling Time: Set Polling Time as the SMART polling period. 3.3.6.
PAGE 25
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 3.3.6.9 Command Name PrefetchNumber Parameter 1 Pre-fetch Number: <1:2:4:8:16:32:64:128> 3.3.6.10 Command Name DriveCacheMode Parameter 1 Drive No.: > Parameter 2 Switch setting: > 3.3.6.
PAGE 26
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 OFFICIAL RELEASE PAGE 26 OF 27 3.3.7 Firmware Update Commands 3.3.7.1 Command Name UpdateSystemCode Parameter 1 File Path: <[DIR] > 3.3.7.2 Command Name UpdateBootCode Parameter 1 File Path: <[DIR] > 3.3.7.
PAGE 27
ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. TITLE PROJECT REV. EXPERAID COMMAND LINE INTERFACE USER GUIDE “DESKTOP RAID” DOCUMENT STATUS G–05-NOV-2007 OFFICIAL RELEASE PAGE 27 OF 27 Appendix I.