How it Works
Accusys
Loading...
eXpeRAID
User Manual
27 pgs171.33 Kb0

Accusys eXpeRAID User Manual

eXpeRAID
Command Line Interface
User Guide
Nov 05, 2007
Version: 1.0
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
Revision History
Rev – A 11-JUN -2007 Rev – B 10-AUG -2007
Rev – C 14-AUG -2007
Rev – D 03-SEP -2007
Rev – E 19-OCT -2007
Rev – F 02-NOV -2007 Rev – G 05-NOV -2007
JeffChang 1. Initial Draft. ShoneCheng
ShoneCheng
ShoneCheng
ShoneCheng
ShoneCheng 6. Modified the description in section 2.1 Pre-action. ShoneCheng 7. Of ficial release version 1.0.
2. Removed unnecessary commands and modified command names to match GUI’s.
3. Modified some command names and parameters of command ‘SetLunMap’, ‘CreateShot’ and ‘MigrateArray’, added Appendix I for Migration command reference. Added ‘CancelSplitSchedule’ command.
4. Removed parameter “Array” for CreateArray command. Added DumpMiscInfo and DumpDriveInfo commands. Modified the description of DumpCtrlEvent command.
5. Removed CLI command “BatteryState”. Added Chapter 1 “Introduction” and Chapter 2 “Using CLI”, the original Chapter 1 had been moved to Chapter 3.
PAGE 2 OF 27
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..........................................................................7
2.1 Pre-action.................................................................................................................7
2.2 Execution Mode.......................................................................................................8
2.2.1 Interactive Mode.............................................................................................8
2.2.2 Non-interactive Mode.....................................................................................8
2.2.2.1 CLI script Mode
2.2.2.2 Shell script Mode
3. CLI Command Line Configuration .............................10
3.1 CLI Command Format...........................................................................................10
3.2 CLI Reply Status....................................................................................................11
3.3 CLI Command Set .................................................................................................12
3.3.1 Basic CLI Commands...................................................................................12
3.3.1.1 main
3.3.1.2 CtrlIndex
3.3.1.3 CheckPassword
3.3.1.4 SetPassword
3.3.1.5 CtrlName
3.3.1.6 RunScript
3.3.1.7 exit
3.3.2 Information Display Commands...................................................................14
3.3.2.1 DumpArrayInfo
3.3.2.2 DumpSliceInfo
3.3.2.3 DumpJBODInfo
3.3.2.4 DumpCtrlEvent
3.3.2.5 DumpCtrlInfo
3.3.2.6 DumpLockDriveInfo
3.3.2.7 DumpSnapShotInfo
3.3.2.8 DumpMiscInfo
3.3.2.9 DumpDriveInfo
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
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..................................................19
3.3.4.1 ExpandArray
3.3.4.2 MigrateArray
3.3.4.3 RebuildParity
PAGE 4 OF 27
3.3.4.4 VerifyParity
3.3.4.5 RefreshArray
3.3.4.6 RefreshPriority
3.3.4.7 UnlockDrive
3.3.5 Mirror Snapshot Configuration Commands..................................................21
3.3.5.1 CreateShot
3.3.5.2 DeleteShot
3.3.5.3 ResyncShot
3.3.5.4 SplitShot
3.3.5.5 SplitSchedule
3.3.5.6 CancelSplitSchedule
3.3.6 Miscellaneous Commands............................................................................23
3.3.6.1 DiskLagProof
3.3.6.2 NCQMode
3.3.6.3 SMARTMode
3.3.6.4 SMARTPollingPeriod
3.3.6.5 BeeperMode
3.3.6.6 EQMode
3.3.6.7 CtrlCache
3.3.6.8 SyncCacheMode
3.3.6.9 PrefetchNumber
3.3.6.10 DriveCacheMode
3.3.6.11 CtrlTime
3.3.7 Firmware Update Commands.......................................................................26
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
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 Accusys eXpeRAID Installation User manual for instructions.
1.1 Overview
This Command Line Interface (CLI) is provided for you to configure and manage the Accusys eXpeRAID components in Linux, Mac or Windows. The CLI is useful under environments where a graphical user interface (GUI) is not available. Through CLI, you can perform most of the storage management tasks that you perform with the eXpeRAID storage manager GUI. CLI commands can be executed under either interactive or non-interactive (script) mode, providing higher level API functionalities.
1.2 Supported Operating Systems
• Windows: XP, 20xx, Vista, …, etc.
• Linux: Fedora Code, SuSE, Debian, …, etc.
• Mac: Mac Pro, G5 …, etc.
CLI supports both 32-bit and 64-bit versions. Be sure you are using the correct version.
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: mknod /dev/ACS_CDEVi c NUM i where number NUM is determined by referencing the Character devices listed in
/proc/devices in which the string ACS_CDEV is located. The number i should be 0 when only one controller is found. If other controllers are found, use 1, 2.. for i to make node of each controller one by one.
Anyway, the necessity of this procedure depends on how the driver is installed.
Example for Linux special case:
1. Type: insmod acs_ame.ko [Enter] under the folder where the driver “acs_ame.ko” is located.
2. Type: cat /proc/devices [Enter], a list of Character devices will appear, in which the device number of ACS_CDEV is 253(The value alters through different systems.)
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 commands and parameters must follow the CLI command format to be executed normally.
2.2.1 Interactive Mode
To trigger CLI interactive mode, simply run the CLI execution file under the command line of the OS. If the controller has been found, a password verification prompt for the default controller will appear. After inputting the correct password, the CLI prompt “CLI>” will appear. All CLI commands can be executed under this prompt.
2.2.2 Non-interactive Mode
There are two types of non-interactive mode for CLI. One calls the CLI command "RunScript" to execute pre-written script files which contain bunches of CLI commands. The other one calls CLI commands by adding them as the parameter of the CLI execution file individually.
The scripts of both types of non-interactive mode are written based on the following format: acs_cli <CLI command> [Parameters of the CLI command] which can be executed as a single command under the command line of the OS.
2.2.2.1 CLI script Mode
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 acs_sample2.script Both acs_sample1.script and acs_sample2.script contain a bunch of CLI commands.
2.2.2.2 Shell script Mode
This mode is implemented by executing all CLI commands following the format:
acs_cli <CLI command> [Parameters of the CLI command] For example: In Sample2.sh under Linux, it contains commands like ./acs_cli CtrlIndex 0
./acs_cli CheckPassword 00000000 … The first line sets the controller index to 0 and the second line verifies the password
of the controller with index 0.
To complete both Sample1.sh and Sample2.sh successfully, the active controller must have 4 Spare drives(On slot 1~4) connected. For both scripts, all 4 drives will be restored to Spare after completing the script successfully.
Loading...
+ 18 hidden pages
Buy Points How it Works FAQ Contact Us Questions and Suggestions Privacy Policy Cookie Policy Terms of Use