background image

CLI Reference

20

3ware 9000 Series Serial ATA Controller CLI Guide

info 

cid driver

This command reports the device driver version associated with controller 

cid

Example:

 3ware CLI> info c0 driver
 /c0 Driver Version = 1.02.00.036

info 

cid model

This command reports the controller model of controller 

cid

Example:

 3ware CLI> info c0 model
 /c0 Model = 7506-12

info 

cid firmware

This command reports the firmware version of controller 

cid

Example:

 3ware CLI> info c0 firmware
 /c0 Firmware Version = FGXX 2.01.00.025

info 

cid bios

This command reports the BIOS version of controller 

cid

Example:

 3ware CLI> info c0 bios
 /c0 BIOS Version = BG9X 2.01.00.026

info 

cid monitor

This command reports the monitor (firmware boot-loader) version of 
controller 

cid

Example:

 3ware CLI> info c0 monitor
 /c0 Monitor Version = BLDR 1.00.00.008

Summary of Contents for 720-0104-00

Page 1: ...3ware Serial ATA RAID Controller Command Line Interface Supports the 9000 Series PN 720 0104 00 April 2004 CLI Guide ...

Page 2: ...sent of 3ware Inc 455 West Maude Ave Sunnyvale CA 94085 Trademarks 3ware Escalade and 3DM are all registered trademarks of 3ware Inc The 3ware logo 3BM StorSwitch TwinStor and R5 Fusion are all trademarks of 3ware Inc All other trademarks herein are property of their respective owners Disclaimer 3ware Inc assumes no responsibility for errors or omissions in this document nor does 3ware Inc make an...

Page 3: ...onfigurations 8 Determining What RAID Level to Use 11 CLI Reference 15 Conventions 16 Screen Reporting Style 17 Info Commands 18 info 18 info cid 19 info cid driver 20 info cid model 20 info cid firmware 20 info cid bios 20 info cid monitor 20 info cid serial 21 info cid pcb 21 info cid pchip 21 info cid achip 21 info cid numports 21 info cid numunits 21 info cid numdrives 22 info cid unitstatus 2...

Page 4: ...d Commands 36 Syntax 36 sched rebuild cid 37 sched rebuild cid add day hour duration 37 sched rebuild cid remove slot_id 37 sched rebuild cid enable 38 sched rebuild cid disable 38 sched verify cid 38 sched verify cid add day hour duration 38 sched verify cid remove slot_id 39 sched verify cid enable 39 sched verify cid disable 39 sched selftest cid 39 sched selftest cid add day hour 40 sched self...

Page 5: ...tructions How this Guide is Organized There are often multiple ways to accomplish the same configuration and maintenance tasks for your 3ware controller While this manual includes instructions for performing tasks using the command line interface two additional tools are available 3ware BIOS Manager 3DM 2 3ware Disk Manager For information about these tools see 3ware 9000 Series Serial ATA RAID Co...

Page 6: ... for things you type In commands an italic font indicates items that you must specify such as a controller ID or a unit ID In commands brackets around an item indicates that it is optional In commands ellipses indicate that more than one parameter can be included In commands a brace indicates an or situation where the user has a choice between more than one option but only one can be specified Add...

Page 7: ...be used with 3ware 7000 or 8000 series controllers Warning For all of the functions of the 3ware CLI to work properly you must have the proper CLI firmware and driver versions installed Check www 3ware com for the latest versions and upgrade instruc tions Features 3ware CLI is a command line interface storage management application for 3ware ATA RAID Controllers It provides controller logical unit...

Page 8: ...n be a one tier two tier or three tier arrangement JBOD Spare and Single logical units are examples of one tier units RAID 1 and RAID 5 are examples of two tier units and as such will have sub units RAID 10 and RAID 50 are examples of three tier units and as such will have sub sub units Port A controller has one or many ports typically 4 8 12 Each port can be attached to a single disk drive For ad...

Page 9: ... Start the 3ware CD and at the 3ware Escalade menu click Run CLI Or open a console window and at the command prompt enter tw_cli OR double click the CLI icon in a folder The CLI prompt is displayed in a DOS console window Installing the 3ware CLI on Linux and FreeBSD 3ware CLI can be installed from the 3ware software CD ROM or downloaded from the 3ware web site www 3ware com You will need to be ro...

Page 10: ...d observing the results on the screen To use the CLI interactively 1 Enter the following command tw_cli The main prompt is displayed indicating that the program is awaiting a command 3ware CLI 2 At the CLI prompt you can enter commands to get set or maintain 3ware controllers For example 3ware CLI info Displays all of the controllers in the system To display details of a single controller assumed ...

Page 11: ...and runs the CLI commands included in that file Scripting Example Here is an example using a text file called info txt containing the following two commands info c0 u0 info c1 u0 To run the script enter tw_cli f info txt 3ware CLI displays information about unit 0 on controller 0 and unit 0 on controller 1 Understanding RAID Concepts and Levels The next few pages introduce RAID concepts you may fi...

Page 12: ...riped disk arrays achieve high transfer rates and provide improved performance Distributed Parity Parity works in combination with striping on RAID 5 and RAID 50 Parity information is written to each of the striped drives in rotation Should a failure occur the data on the failed drive can be reconstructed from the data on the other drives Hot Swap The process of swapping out a drive without having...

Page 13: ...gure 1 RAID 0 Configuration Example RAID 1 Also known as a mirrored array Mirroring is done on pairs of drives Mirrored disk arrays write data to two drives using RAID 1 algorithms see Figure 2 This gives your system fault tolerance by preserving the data on one drive if the other drive fails Fault tolerance is a basic requirement for mission critical systems like web and database servers 3ware us...

Page 14: ...high performance Requires a minimum of four drives to use both RAID 0 and RAID 1 techniques When drives are configured as a striped mirrored array the disks are configured using both RAID 0 and RAID 1 techniques thus the name RAID 10 see Figure 4 A minimum of four drives are required to use this technique The first two drives are mirrored as a fault tolerant array using RAID 1 The third and fourth...

Page 15: ...are seen by the OS as available units JBOD A JBOD is an unconfigured disk attached to your 3ware RAID controller JBOD configuration is no longer supported in the 3ware 9000 series 3ware recommends that you use Single Disk as a replacement for JBOD to take advantage of advanced features such as caching If you are migrating JBODS from a 7000 8000 controller you can enable support for them For more i...

Page 16: ...ou can configure all drives in one unit or you can configure multiple units if you have enough drives Table 2 Possible Configurations Based on Number of Drives Drives Possible RAID Configurations 1 Single or spare drive 2 RAID 0 or RAID 1 3 RAID 0 RAID 5 or RAID 1 spare 4 RAID 5 hot spare RAID 10 Combination of RAID 0 RAID 1 single disk 5 RAID 5 hot spare RAID 10 hot spare Combination of RAID 0 RA...

Page 17: ...ve Capacity RAID Level Capacity RAID 0 number of drives X capacity of the smallest drive RAID 1 capacity of the smallest drive RAID 5 number of drives 1 X capacity of the smallest drive Storage efficiency increases with the number of disks storage efficiency number of drives 1 number of drives RAID 10 number of drives 2 X capacity of smallest drive RAID 50 number of drives number of groups of driv...

Page 18: ...Introduction to the 3ware Command Line Interface 14 3ware 9000 Series Serial ATA Controller CLI Guide ...

Page 19: ...ons include create array delete array rebuild array verify array and remove array from the controller For details see Maint Commands on page 28 Warning Operations under the maint command can destroy data so care should be taken before using this command CLI does not prompt before the operation is committed Sched Scheduling commands only affect the 9000 controller Schedule commands allow you to sch...

Page 20: ...larms through reboot you can either extract the alarms from CLI and store them in a file or install 3DM 2 which does log alarm messages For more information see the 3ware 9000 Series Serial ATA RAID Controller User Guide Set Setting commands can be used to modify and change controller and array settings Settings that can be changed include rebuild rate verify rate and turning on or off cache autov...

Page 21: ...g style for screen displays Using this format information is easier to read and analyze The new style also accommodates automation by providing consistent columns with or without values so that it can be easily parsed The original non tabular style is still available for a limited time To use the old style set the TW_CLI_STYLE to OLD as shown below depending on your operating system For Redhat and...

Page 22: ...formation you want to see info Provides information on all detected controllers The appropriate device driver must be loaded for the list to show all controllers The intention is to provide a global view of the environment Typical output looks like the following 3ware CLI info Ctl Model Ports Drives Units NotOpt RRate VRate c0 7500 12 12 5 1 1 2 c1 8506 12 12 6 1 0 3 5 The output indicates that co...

Page 23: ...f 512 bytes and the serial number assigned by the disk vendor Additional attributes about units ports and disks can be obtained by querying for them explicitly See other info sub commands below Typical output looks like 3ware CLI info c0 Unit UnitType Status Cmpl Stripe Size Cache AVerify OvrECC u0 RAID 1 OK 149 05 ON OFF OFF u1 RAID 5 OK 64k 298 22 ON OFF OFF u2 SPARE OK 149 05 ON OFF Port Status...

Page 24: ... Example 3ware CLI info c0 model c0 Model 7506 12 info cid firmware This command reports the firmware version of controller cid Example 3ware CLI info c0 firmware c0 Firmware Version FGXX 2 01 00 025 info cid bios This command reports the BIOS version of controller cid Example 3ware CLI info c0 bios c0 BIOS Version BG9X 2 01 00 026 info cid monitor This command reports the monitor firmware boot lo...

Page 25: ...r cid Example 3ware CLI info c0 pchip c0 PCHIP Version 1 30 33 info cid achip This command reports the ACHIP ATA Interface Chip version of the specified controller cid Example 3ware CLI info c0 achip c0 ACHIP Version 3 20 info cid numports This command reports the number of ports of the specified controller cid Example 3ware CLI info c0 numports c0 Number of Ports 12 info cid numunits This command...

Page 26: ...0 Number of Drives 5 info cid unitstatus This command presents status of units managed by the specified controller cid It provides a list of units their types current status percent complete if rebuilding or verifying size in GB and the number of blocks of 512 bytes Example 3ware CLI info c0 unitstatus Unit UnitType Status Cmpl Stripe Size GB Cache AVerify OvrECC u0 RAID 5 VERIFYING 79 16K 819 446...

Page 27: ...81808 3JS0VH1P p6 OK 149 05 GB 312581808 3JS0TF0P p7 OK 149 05 GB 312581808 3JS0VF43 p8 OK 149 05 GB 312581808 3JS0VG8D p9 NOT PRESENT p10 NOT PRESENT p11 NOT PRESENT info cid exportjbod This command shows whether the Export JBOD policy is enabled or disabled Example 3ware CLI info c0 exportjbod c0 JBOD Export Policy off info cid ondegrade This command shows whether the write cache will be disable...

Page 28: ...d unit has caused the unit to degrade and which disk within that sub unit is the source of degradation Example 3ware CLI info c0 u0 Unit UnitType Status Cmpl Port Stripe Size GB Blocks u0 RAID 5 VERIFYING 0 16K 819 446 718503424 u0 0 DISK OK p0 74 4951 156227584 u0 1 DISK OK p1 74 4951 156227584 u0 2 DISK OK p2 74 4951 156227584 u0 3 DISK OK p3 74 4951 156227584 u0 4 DISK OK p4 74 4951 156227584 u...

Page 29: ...t Example 3ware CLI info c0 u5 verifystatus c0 u5 is not verifying info cid uid initializestatus This command presents the initialize status if any of the specified unit Example 3ware CLI info c0 u5 initializestatus c0 u5 is not initializing info cid pid This command presents various information on the specified disk attached to port pid Typical information looks like Example 3ware CLI info p5 Por...

Page 30: ...mputed based on division by 1024 not 1000 as is popular with hard disk vendors For additional information see the explanation at info cid on page 19 Example 3ware CLI info c0 p5 capacity c0 p5 Capacity 149 05 GB 312581808 info cid pid smart This command extracts SMART Self Monitoring Analysis and Reporting data from the specified disk The data is extracted live from the disk therefore this command...

Page 31: ... Acoustic 1 Feat Ext TimeLimited R W 0 WDMA FUA 0 Stream 0 Acoustic 0xFE def 0xC0 0xFE best performance Security Status 0x7 ENABLED LOCKED SATA NCQ 0 Udma Mode 0x5 UDMA 100 Pwr Cycles 14 SELF TEST all tests completed UA SpareUnit 0 checking for spare needed UA SpareUnit done Auto Clean 0 DcbMgr UpdateStatus UNIT 0 time 7704019 DcbMgr WriteSegment map 0xFFE segID 0x8 events 22 error 0x0 DcbMgr Upda...

Page 32: ...on JBOD on 7000 8000 models remove c c u u noscan remove c c p p deleteunit c c u u noscan createunit c c r RaidType p p p k stripe nos can nocache g 3 4 5 6 autoverify ignoreECC RaidType raid0 raid1 raid5 raid10 raid50 sin gle spare rebuild c c u u p p p ignoreECC rebuild c c u u pause 7000 8000 only rebuild c c u u resume 7000 8000 only flush c c u u verify c c u u stop mediascan c c start stop ...

Page 33: ...em administrator to export units to the OS a later time rather than having the CLI do it for them maint remove cid uid noscan This command allows you to remove or export a unit Exporting a unit instructs the firmware to remove the specified unit from its poll of managed units but retains the Disk Configuration Block DCB metadata You can import re introduce the unit via rescan By default the OS is ...

Page 34: ...emoving a drive causes a redundant array to degrade Drives cannot be removed if they are part of a degraded or non redundant array with the exception of Single and JBOD drives Warning Single and JBOD Drives You must first unmount any Single or JBOD drive before issuing the remove command Failure to do so may cause the system to hang or become corrupted maint deleteunit cid uid noscan This command ...

Page 35: ...and controller models pid_list is a list of ports disks to be used in the construction of the specified unit One or more ports can be specified Multiple ports can be specified using a colon to separate port indexes and a dash to include a range of port indexes A dash indicates a range and can be mixed with colons For example p0 1 2 5 9 12 indicates port 0 1 2 through 5 inclusive 9 and 12 kstripe i...

Page 36: ...instructs CLI not to notify OS of the creation of the new unit By default CLI informs the OS One application of this feature is to avoid OS creating block special devices such as dev sdb dev sdc as some implementations might create naming fragmentation and creating a moving target nocache switch instructs CLI not to enable the write cache Enabling write cache increases performance at the cost of h...

Page 37: ...signed when you create or set later Refer to the set overwriteECC cid uid on off on page 44 for more info The rebuild process is a background process and changes the state of a unit to REBUILDING Various info commands also show a percent completion as rebuilding progresses Ports that are to be used to rebuild a unit must be a Spare type or an unconfigured drive You must first use remove to remove ...

Page 38: ...r the 9000 series the verify function includes the features of the media scan command maint commit cid This command only applies to the Windows operating system This command instructs the controller to commit its dirty DCBs to persistent storage disks While the controller is processing I O requests against underlying disks an in transaction bit is set If a failure such as power failure is experien...

Page 39: ...Maint Commands www 3ware com 35 Note that block devices cooked devices do not require this command Clients of block devices such as File system send such requests via ASPI SRB_SHUTDOWN_REQUEST ...

Page 40: ...n the 9000 series non redundant units including spares are also verified by doing a background scrub which reads each sector Verifying RAID 1 involves checking that both drives contain the exact data On RAID 5 the parity information is used for error correction RAID 10 and 50 are composite types and follow their respective array types selftest activity provides two types of selftests Ultra Direct ...

Page 41: ...ur range 0 23 for a duration of duration range 1 24 hours This command will fail if no empty slot is available Note The new schedule is added to the first available slot Events do not need to be added in sequential order For example 3ware CLI tw_cli sched rebuild c1 add d0 h16 t3 Adds a rebuild background task to be executed on Sundays at 4 00 PM for a duration of 3 hours sched rebuild cid remove ...

Page 42: ... 12 00am 24 hr s disabled 3 Wed 12 00am 24 hr s disabled 4 Thu 12 00am 24 hr s disabled 5 Fri 12 00am 24 hr s disabled 6 Sat 12 00am 24 hr s disabled sched verify cid add day hour duration This command adds a new background verify task to be executed on day range 0 6 where Sunday is zeroth day of the week at hour range 0 23 for a duration of duration range 1 24 hours This command will fail if no e...

Page 43: ...s on controller cid Note When enabling the verify schedule you must also remember to also enable the autoverify setting for the arrays to be verified sched verify cid disable This command disables all verify background tasks on controller cid sched selftest cid This command displays the current selftest background task as illustrated below 3ware CLI tw_cli sched selftest c1 Selftest Schedule for c...

Page 44: ... the selftests are completed almost sched selftest cid remove slot_id This command removes or unregisters the selftest background task in slot slot_id For example 3ware CLI tw_cli sched selftest c1 remove 3 Removes rebuild selftest task in slot 3 Warning If all timeslots are removed be sure to also disable the schedule Otherwise the applicable background task will never occur sched selftest cid en...

Page 45: ...following levels of severity Errors Warnings Information When the alarms command is executed only AENs that have been logged since the last time the command was executed are displayed For Linux AENs are also saved in a text file at var log messages Windows users can see the AEN messages in the Windows System Event Logs that can be seen in the Event Viewer Asynchronous events are originated by firm...

Page 46: ... listing of AEN codes can be found in the Troubleshooting Problems and Solutions section of 3ware 9000 Series Serial ATA RAID Controller User Guide Typical output looks like tw_cli alarms Ctl Date Severity Message c0 ERROR Unit degraded Unit 0 c1 Fri Nov 28 04 26 31 2003 ERROR 0x04 0x0002 Degraded unit detected unit 0 port 2 c1 Fri Nov 28 06 13 54 2003 INFO 0x04 0x000B Rebuild started unit 0 c1 Fr...

Page 47: ... unit basis overwriteECC enables or disables the ignoreECC function dring rebuild per unit basis Note A value of 1 indicates slowest I O and fastest rebuild rate A value of 5 indicates fastest I O and slowest rebuild Interim values scale linearly e g a value of 3 indicates a rebuild rate half as fast as a rebuild of 1 set rebuild cid 1 5 This command allows you to set the priority of rebuild in re...

Page 48: ...ommand allows you to specify times for the verify operation it does not associate the operation with a unit This command allows you to associate a unit with the verify operation This feature only applies to 9000 models set overwriteECC cid uid on off Setting overwriteECC to on means ignoreEcc This command allows you to set the ignoreECC policy for a given unit This policy is then automatically enf...

Page 49: ...ly quit exits the CLI Type help command to get more details about a particular command help info This command provides specific info related help illustrating various ways to use the info command Info provides reports on 3ware controllers units and drives help alarms This command provides specific alarms related help illustrating various ways to use the alarms command help set This command provide...

Page 50: ...ritten to standard error On success 0 is returned On failure 1 is returned To view the return code at the shell command prompt type echo The screen prints either a 0 or a 1 depending on whether the command was successful or not For example if you had a 3ware controller with an ID of 0 you could type this command tw_cli info c0 c0 information displayed here echo 0 If you type tw_cli info c7 error C...

Reviews: