Accusys eXpeRAID User Manual

Accusys inc. command line interface user guide

Advertisement

Quick Links

eXpeRAID

Command Line Interface

User Guide

Nov 05, 2007
Version: 1.0

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the eXpeRAID and is the answer not in the manual?

Questions and answers

Summary of Contents for Accusys eXpeRAID

  • Page 1: Command Line Interface

    Command Line Interface User Guide Nov 05, 2007 Version: 1.0...
  • Page 2: Revision History

    TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 Revision History Rev – A JeffChang 11-JUN -2007 Rev – B ShoneCheng 10-AUG -2007 Rev – C ShoneCheng 14-AUG -2007 Rev – D ShoneCheng 03-SEP -2007 Rev – E...
  • Page 3: Table Of Contents

    TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 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.
  • Page 4 TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” 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 5 TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 3.3.7.1 UpdateSystemCode 3.3.7.2 UpdateBootCode 3.3.7.3 UpdateBIOSEFI Appendix I..27 ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. DOCUMENT STATUS OFFICIAL RELEASE PAGE 5 OF 27...
  • Page 6: Supported Operating Systems

    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.
  • Page 7: Using Cli

    TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 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: Execution Mode

    TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 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.
  • Page 9: Shell Script Mode

    TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 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...
  • Page 10: Cli Command Line Configuration

    TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 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 Format field description: Command Name: CLI Command Name.
  • Page 11: Cli Reply Status

    TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 3.2 CLI Reply Status InBand(Controller) command success. InBand command failed. CLI will display “Reason: <Error reason description>”. Invalid command: CLI receives unrecognized commands. Invalid parameter “Param”: CLI receives incorrect parameter of the input command.
  • Page 12: Cli Command Set

    TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 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.3 Command Name CheckPassword Parameter 1 Password: <CHARS>...
  • Page 13: Setpassword

    TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 3.3.1.4 Command Name SetPassword Parameter 1 Password: <CHARS> 3.3.1.5 Command Name CtrlName Parameter 1 Controller Name: <CHARS> 3.3.1.6 Command Name RunScript Parameter 1 File Path: <[DIR] <FileName>> 3.3.1.7...
  • Page 14: Information Display Commands

    TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 3.3.2 Information Display Commands 3.3.2.1 Command Name DumpArrayInfo Parameter 1 Array No.: <1~4> 3 .3.2.2 Command Name DumpSliceInfo Parameter 1 Array No.: <1~4> 3.3.2.3 Command Name DumpJBODInfo 3.3.2.4...
  • Page 15: Dumplockdriveinfo

    TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. 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 ACCUSYS, INC. 5F, 38 TAIYUAN ST, JHUBEI, HSINCHU, TAIWAN, R.O.C. DOCUMENT STATUS Command Description Use this command to display information of all locked drives.
  • Page 16 TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 3.3.3 Basic Array Configuration Commands 3.3.3.1 Command Name CreateArray Parameter 1 RAID Level: <Level=<R0:R1:R5:R6: R01>> Parameter 2 Stripe Size: <Stripe=<8:16:32:64:128:2 56>> Parameter 3 Initialization Type: <Type=<Fly:Evaluation>> Parameter 4 Member Drives: <Drive=<z1,x~y,z2>>...
  • Page 17 TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 3.3.3.2 Command Name DeleteArray Parameter 1 Array No.: <1~4> 3.3.3.3 Command Name CreateJBOD Parameter 1 Drive No.: <1~n> 3.3.3.4 Command Name DeleteJBOD Parameter 1 JBOD No.: <1~n> 3.3.3.5...
  • Page 18 TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 3.3.3.6 Command Name SetLunMap Parameter 1 LUN No.: <Lun=<0~63>> Parameter 2 Array No.: <Array=<1~4>: JBOD= <1~n>> Parameter 3 Slice No.: <Slice= <0~15>> 3.3.3.7 Command Name DeleteLunMap Parameter 1 LUN No.:...
  • Page 19: Advanced Array Configuration Commands

    TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 3.3.4 Advanced Array Configuration Commands 3.3.4.1 Command Name ExpandArray Parameter 1 Array No.: <Array=<1~4>> Parameter 2 Drive Count: <DriveCnt=<1~n>> 3.3.4.2 Command Name MigrateArray Parameter 1 Array No.: <Array=<1~4>>...
  • Page 20: Rebuildparity

    TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 3.3.4.3 Command Name RebuildParity Parameter 1 Array No.: <Array=<1~4>> Parameter 2 State setting: <State=<Start:Stop>> 3.3.4.4 Command Name VerifyParity Parameter 1 Array No.: <Array=<1~4>> Parameter 2 State setting: <State=<Start:Stop>>...
  • Page 21: Refreshpriority

    TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 3.3.4.6 Command Name RefreshPriority Parameter 1 <High:Medium:Low> 3.3.4.7 Command Name UnlockDrive Parameter 1 Drive No.: <1~n> 3.3.5 Mirror Snapshot Configuration Commands 3.3.5.1 Command Name CreateShot Parameter 1 Shot No.: <Shot=<1~8>>...
  • Page 22: Deleteshot

    TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 3.3.5.2 Command Name DeleteShot Parameter 1 Shot No.: <1~8> 3.3.5.3 Command Name ResyncShot Parameter 1 Shot No.: <1~8> 3.3.5.4 Command Name SplitShot Parameter 1 Shot No.: <1~8> 3.3.5.5...
  • Page 23: Cancelsplitschedule

    TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 3.3.5.6 Command Name CancelSplitSchedule Parameter 1 Shot No.: <1~8> 3.3.6 Miscellaneous Commands 3.3.6.1 Command Name DiskLagProof Parameter 1 <Enable:Disable> 3.3.6.2 Command Name NCQMode Parameter 1 <Enable:Disable> 3.3.6.3 Command Name...
  • Page 24: Smartpollingperiod

    TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 3.3.6.4 Command Name SMARTPollingPeriod Parameter 1 Polling Time: <1Min:15Min:30Min: 60Min:2Hr:4Hr:8Hr> 3.3.6.5 Command Name BeeperMode Parameter 1 <Enable:Disable> 3.3.6.6 Command Name EQMode Parameter 1 <Enable:Disable> 3.3.6.7 Command Name CtrlCache Parameter 1 <Enable:Disable>...
  • Page 25: Prefetchnumber

    TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. 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.: <Drive=<1~n:All>> Parameter 2 Switch setting: <Switch =<Enable:Disable>> 3.3.6.11 Command Name CtrlTime...
  • Page 26: Firmware Update Commands

    TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 3.3.7 Firmware Update Commands 3.3.7.1 Command Name UpdateSystemCode Parameter 1 File Path: <[DIR] <FileName>> 3.3.7.2 Command Name UpdateBootCode Parameter 1 File Path: <[DIR] <FileName>> 3.3.7.3 Command Name UpdateBIOSEFI...
  • Page 27 TITLE EXPERAID COMMAND LINE INTERFACE USER GUIDE PROJECT “DESKTOP RAID” REV. G–05-NOV-2007 Appendix I. Array Migration Matrix: Target RAID Level Source RAID Level R0 (N Disks) ≧2 R1 (N Disks) ≧N-1 R5 (N Disks) ≧N/2 R0+1 (N Disks) ≧N-2 R6 (N Disks) Note: Most RAID levels can be migrated to other levels.

Table of Contents