background image

Chapter 1. Introduction to the 3ware Command Line Interface

4

3ware Serial ATA RAID Controller CLI Guide

Installing the 3ware CLI 

                                      

Installing the 3ware CLI on Mac OS X

3ware CLI can be installed from the 3ware software CD, or the latest version 
can be downloaded from the 3ware web site, 

 http://www.3ware.com/support/

download.asp.

 

To install 3ware CLI on Mac OS X

Run the installer and select CLI as the software to be installed.

Permissions Required to Run CLI

To run CLI, you must be logged onto the Power Mac G5 with one of the 
following sets of permissions:

Administrator

Root

You can also use SUDO to run CLI.

To start CLI

In a Terminal window, type

sudo ./tw_cli

If prompted, enter your password.

Installing the 3ware CLI on Windows

3ware CLI can be installed or run directly from the 3ware software CD, or the 
latest version can be downloaded from the 3ware web site,
 

http://www.3ware.com

. Online manual pages are also available in nroff and 

html formats. These are located in 

/packages/cli/tw_cli.8.html

 or 

tw_cli.8.nroff.

Warning!

If you are using 3DM, as opposed to 3DM2, AMCC does not recommend installing 
both 3DM and CLI on the same system. Conflicts may occur. For example, if both 
are installed, alarms will be captured only by 3DM. You should use either CLI or 
3DM to manage your 3ware RAID controllers.

This is not an issue for 3DM2. It can be installed with CLI.

(3DM was an earlier version of the software, which worked with 7/8000 model 
3ware controllers. 3DM 2 works with the 9000-series.)

Содержание 9650SE-2LPB-10 - Sataii Raid Hardware 10Pk

Страница 1: ...3ware Serial ATA RAID Controller Command Line Interface Supports the 9000 Series 9500S 9550SX 9590SE 9650SE PN 720 0162 00 March 2007 CLI Guide...

Страница 2: ...Apple logo and PowerMac are trademarks of Apple Computer Inc registered in the United States and or other countries Safari is a trademark of Apple Computer Inc PowerPC and the PowerPC logo are tradema...

Страница 3: ...tting the CLI to a Text File 9 Conventions 9 Understanding RAID Levels and Concepts 10 RAID Concepts 10 Available RAID Configurations 11 Determining What RAID Level to Use 17 Chapter 2 CLI Syntax Refe...

Страница 4: ...show alarms reverse 45 cx show diag 46 cx show rebuild 46 cx show verify 48 cx show selftest 49 cx add rebuild ddd hh duration 50 cx add verify ddd hh duration 51 cx add selftest ddd hh 52 cx del reb...

Страница 5: ...icy on off 70 cx ux set storsave protect balance perform quiet 70 cx ux migrate type RaidType disk p p group 3 4 5 6 7 8 9 10 11 12 stripe Stripe noscan nocache autoverify 72 Port Object Commands 77 c...

Страница 6: ...ex show temp 89 ex show all 89 ex slotx show 90 ex slotx show identify 90 ex slotx set identify on off 90 ex fanx show 91 ex tempx show 91 Help Commands 91 Help with specific commands 91 Help with att...

Страница 7: ...ith the command 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 th...

Страница 8: ...in both interactive and batch mode providing higher level API application programming interface functionalities Note Some CLI commands are supported only for particular models of 3ware RAID controller...

Страница 9: ...orted for the 3ware CLI see the Release Notes Terminology 3ware Serial ATA RAID Controller CLI Guide uses the following terminology Logical Units Usually shortened to units These are block devices pre...

Страница 10: ...ow type sudo tw_cli If prompted enter your password Installing the 3ware CLI on Windows 3ware CLI can be installed or run directly from the 3ware software CD or the latest version can be downloaded fr...

Страница 11: ...administrator rights Domain administrator Domain user with Domain Admin or Administrator membership Without the correct privileges CLI will prompt and then exit when the application is executed If yo...

Страница 12: ...installed type autorun console and select Install Software More detailed information about using this installer is supplied in Appendix B of 3ware Serial ATA RAID Controller User Guide Or copy the fil...

Страница 13: ...sing the command interface interactively You can use 3ware CLI interactively entering commands at the main prompt and observing the results on the screen To use the CLI interactively 1 If necessary ch...

Страница 14: ...ch you have entered in advance Each command must be on a separate line Syntax tw_cli f filename Where filename is the name of the text file you want to execute Example tw_cli f clicommand txt This exa...

Страница 15: ...ons and explanations of commands a bold font indicates the name of commands and parameters for example c0 p0 show all In commands an italic font indicates items that are variable but that you must spe...

Страница 16: ...software Single disk units can also be configured in the 3ware software Mirroring Mirrored arrays RAID 1 write data to paired drives simultaneously If one drive fails the data is preserved on the pai...

Страница 17: ...RAID units see Configuring a New Unit on page 33 RAID 0 RAID 0 provides improved performance but no fault tolerance Since the data is striped across more than one disk RAID 0 disk arrays achieve high...

Страница 18: ...ad operation The adaptive algorithms in TwinStor technology boost performance by distinguishing between random and sequential read requests For the sequential requests generated when accessing large f...

Страница 19: ...oss all the drives of a unit instead of the single block of RAID 5 Due to the two parities a RAID 6 unit can tolerate two hard drives failing simultaneously This also means that a RAID 6 unit may be i...

Страница 20: ...t tolerant array using RAID 1 The third and fourth drives are mirrored as a second fault tolerant array using RAID 1 The two mirrored arrays are then grouped as a striped RAID 0 array using a two tier...

Страница 21: ...3 means that the RAID 5 arrays used have 3 disks each four of these 3 drive RAID 5 arrays are striped together to form the 12 drive RAID 50 array On a 16 port controller you can have a grouping of 4 o...

Страница 22: ...and therefore not recommended for high availability systems unless additional precautions are taken to prevent system hangs and data loss JBOD A JBOD acronym for Just a Bunch of Disks is an unconfigur...

Страница 23: ...ID 0 Provides performance but no fault tolerance RAID 1 Provides fault tolerance and a read speed advantage over non RAID disks RAID 5 This type of unit provides performance fault tolerance and high s...

Страница 24: ...of RAID 0 RAID 1 hot spare single disk 6 or more RAID 6 RAID 6 with hot spare RAID 50 Combination of RAID 0 1 5 6 10 hot spare single disk Table 4 Drive Capacity RAID Level Capacity Single Disk Capac...

Страница 25: ...nits Auto carving divides the available unit capacity into multiple chunks of 2 TB or smaller that can be addressed by the operating systems as separate volumes The carve size is adjustable from 1024...

Страница 26: ...Common Tasks Mapped to CLI Commands Task CLI Command Page Controller Configuration Tasks View information about a controller cx show 30 View controller policies cx show attribute attribute 31 Set pol...

Страница 27: ...x add rebuild 50 Add a time slot to a verify schedule cx add verify 51 Add a time slot to a selftest schedule cx add selftest 52 Enable disable the rebuild migrate schedule and set the task rate cx se...

Страница 28: ...include the attribute reverse as in the command show alarms reverse alarms are listed in reverse order The value of name value attributes are expressed in the format attribute value Identify all driv...

Страница 29: ...provide information and perform actions related to a specific unit on a specific controller For example you use unit object commands for such tasks as seeing the rebuild verify or initialize status of...

Страница 30: ...command that applies to the focus instead of having to type the entire object name each time For example where normally you might type hostname c0 u0 show if you set the focus to hostname c0 u0 the pr...

Страница 31: ...4 1 0 2 5 The output above indicates that Controller 0 is a 9590SE model with 4 Ports with 4 Drives detected attached total of 1 Unit with no units in a NotOpt Not Optimal state RRate Rebuild Rate of...

Страница 32: ...rs that are associated with the enclosure show ver This command will show the CLI and API version Example localhost show ver CLI Version 2 00 03 0xx API Version 2 01 00 xx In the above example xx stan...

Страница 33: ...rebuild ddd hh duration on page 50 and see the discussion of background tasks and schedules in 3ware Serial ATA RAID Controller User Guide show verify This command displays all verify schedules for th...

Страница 34: ...see the discussion of background tasks and schedules in 3ware Serial ATA RAID Controller User Guide flush This command sends a flush command to all 3ware controllers in the system For more information...

Страница 35: ...lftest 9000 series serial spinup stagger unitstatus verify 9000 series cx show all where all means attributes and configurations cx show diag cx show alarms reverse cx show rebuild 9000 series cx show...

Страница 36: ...ion of rebuilding V I M percent completion of verifying initializing or migrating stripe size size usable capacity in gigabytes or terabytes and the auto verify policy status on off Possible unit stat...

Страница 37: ...WD WCANM1778008 p8 OK 149 05 GB 312581808 WD WCANM1770998 p9 NOT PRESENT p10 OK u1 149 05 GB 312581808 WD WCANM1869003 p11 OK u1 149 05 GB 312581808 WD WCANM1762464 Name OnlineState BBUReady Status Vo...

Страница 38: ...roller cx Example localhost c0 show model c0 Model 9500 x cx show firmware This command reports the firmware version of controller cx Example localhost c0 show firmware c0 Firmware Version FE9X 3 03 0...

Страница 39: ...version of the specified controller cx Example localhost c0 show pchip c0 PCHIP Version 1 x cx show achip This command reports the ACHIP ATA Interface Chip version of the specified controller cx Examp...

Страница 40: ...s Example localhost c0 show numunits c0 Number of Units 1 cx show ctlbus This feature only applies to 9550SX 9590SE and 9650SE controllers This command reports the controller host bus type bus speed a...

Страница 41: ...9500S controllers This command reports the cache policy for degraded units If the ondegrade policy is Follow Unit Policy a unit cache policy stays the same when the unit becomes degraded If the ondeg...

Страница 42: ...0 show autocarve c0 Auto Carving Policy on cx show carvesize This feature only applies to 9000 series controllers This command shows the maximum size of the volumes that will be created if the autocar...

Страница 43: ...oller cx and shows their types capacity status and unit policies Possible statuses include OK VERIFYING VERIFY PAUSED INITIALIZING INIT PAUSED REBUILDING REBUILD PAUSED DEGRADED MIGRATING MIGRATE PAUS...

Страница 44: ...which they are associated their size in gigabytes and blocks and the serial number assigned by the drive manufacturer Definitions of the drive statuses are available in the 3ware Serial ATA RAID Contr...

Страница 45: ...Total Units 2 c0 JBOD Export Policy off c0 Disk Spinup Policy 7 c0 Spinup Stagger Time Policy sec 4 c0 Cache on Degrade Policy Follow Unit Policy c0 Auto Carving Policy off c0 Auto Carving Size 2047 G...

Страница 46: ...to be created Possible unit types include raid0 raid1 raid5 raid6 9650SE only raid10 raid50 single spare and JBOD Example type raid5 When a new unit is created it is automatically assigned a unique s...

Страница 47: ...per group for a RAID 50 type This attribute can only be used when type raid50 Recall that a RAID 50 is a multi tier array At the bottom most layer N number of disks per group are used to form the RAI...

Страница 48: ...nless there is a BBU battery backup unit or UPS uninterruptible power supply installed autoverify attribute enables the autoverify attribute on the unit that is to be created For more details on this...

Страница 49: ...e all units The controller will update its list of ports attached disks and attempts to read every DCB Disk Configuration Block in order to re assemble its view and awareness of logical units Any newl...

Страница 50: ...ith_path attribute allows you to specify the firmware image file name along with its absolute path The new image specified by this filename_with_path is checked for compatibility with the current cont...

Страница 51: ...generated on 7000 8000 controllers do not have dates so you will see a in the Date column This means that it is not applicable In addition alarm messages on 7000 8000 controllers contain the severity...

Страница 52: ...k up to 7 time periods can be registered known as slots 1 through 7 Each task schedule can be managed by a set of commands including add del show and set a task Background task schedules have a slot i...

Страница 53: ...Status Unit Size Blocks Serial p0 NOT PRESENT p1 OK u0 76 33 GB 160086528 Y2NXL7FE p2 NOT PRESENT p3 OK u0 76 33 GB 160086528 Y2NXLB9E p4 NOT PRESENT p5 OK u0 76 33 GB 160086528 Y2NXQPZE p6 NOT PRESEN...

Страница 54: ...the same schedule as rebuild For each background task up to 7 time periods can be registered known as slots 1 through 7 Each task schedule can be managed by a set of commands including add del show a...

Страница 55: ...hat follow the same schedule as rebuild For each background task up to 7 time periods can be registered known as slots 1 through 7 Each task schedule can be managed by a set of commands including add...

Страница 56: ...the day ddd where ddd is Sun Mon Tue Wed Thu Fri and Sat at the hour hh range 0 23 for a duration of duration range 1 24 hours A maximum of seven rebuild tasks can be scheduled This command will fail...

Страница 57: ...s Setting Up a Verify Schedule Setting up a verify schedule requires several steps and several different CLI commands in addition to cx add verify To set up the verify schedule you want to use follow...

Страница 58: ...in addition to cx add selftest To set up the selftest schedule you want to use follow this process 1 Use the cx show selftest command to display the current schedule for selftest tasks For details see...

Страница 59: ...x set rebuild enable disable 1 5 This command enables or disables all rebuild background task slots on controller cx and sets the priority of rebuild versus I O operations When enabled rebuild tasks w...

Страница 60: ...ns When enabled verify tasks will only be run during the time slots scheduled for verifies If a verify is taking place when the schedule is enabled it will be paused until the next scheduled time The...

Страница 61: ...e degraded unit regardless of what the unit based write cache policy is If the policy is set to follow and a unit degrades firmware will follow whatever cache policy has been set for that unit For det...

Страница 62: ...s and a remaining volume Each volume can then be treated as an individual disk with its own file system The default carvesize is 2 TB This feature is useful for operating systems limited to 2TB file s...

Страница 63: ...c0 set autorebuild enable Setting Auto Rebuild Policy on c0 to enable Done cx set autodetect on off disk p p all This command is only for 9000 series controllers This command is associated with the st...

Страница 64: ...rts Done Usage Scenario If you are hot plugging a large number of drives at the same time and are concerned that you might overload the power supply you might use this command as follows 1 Issue the c...

Страница 65: ...series qpolicy 9550SX 9590SE 9650SE rebuildstatus serial 9000 series status verifystatus storsave 9550SX 9590SE 9650SE volumes 9000 series ignoreECC 9000 series identify 9550SX 9590SE 9650SE cx ux sh...

Страница 66: ...X One application of the cx ux show command is to see which sub unit of a degraded unit has caused the unit to degrade and which disk within that sub unit is the source of degradation Another applicat...

Страница 67: ...e OK VERIFYING VERIFY PAUSED INITIALIZING INIT PAUSED REBUILDING REBUILD PAUSED DEGRADED MIGRATING MIGRATE PAUSED RECOVERY INOPERABLE and UNKNOWN Definitions of the unit statuses are available in the...

Страница 68: ...ed unit Example localhost c0 u5 show serial c0 u5 Serial Number 12345678901234567890 cx ux show qpolicy This feature only applies to 9550SX 9590SE and 9650SE model controllers This command reports the...

Страница 69: ...9550SX 9590SE and 9650SE model controllers This command is related to the cx ux set identify command It shows the identify status of the specified unit either on or off Example localhost c0 u0 show i...

Страница 70: ...above attributes If the auto carve policy was on at the time the unit was created and the unit is over the carve size multiple volumes were created and are displayed at the end of the summary informat...

Страница 71: ...o remove the specified unit from its poll of managed units but retains the DCB Disk Configuration Block metadata A removed unit can be moved to a different controller noscan is used to not inform the...

Страница 72: ...rebuild bad sectors on the source disk will cause the rebuild to fail RAID 6 arrays are less susceptible to failing since two copies of the data exist You can allow the operation to continue by using...

Страница 73: ...ons can be scheduled to take place at specified start and stop times The cx ux pause rebuild command is provided to enable 7000 8000 users to achieve similar functionality with use of Linux provided s...

Страница 74: ...o run the verify function once every 24 hours If verify schedule windows are set up and enabled then the controller will only start an automatic verify task during the schedule time slots If the verif...

Страница 75: ...unit Example localhost c0 u0 set identify on Sending Identify request for unit c0 u0 to on Done cx ux set ignoreECC on off This feature only applies to 9000 series controllers This command allows you...

Страница 76: ...policy of the new parent unit Thus this command does not set the queue policy for the spare unit type By default qpolicy is on Example localhost c0 u5 set qpolicy on Setting Command Queuing Policy for...

Страница 77: ...firmation message will warn you that there could be data loss in the event of a power failure balance provides more data protection than perform mode but less data protection than protect mode and pro...

Страница 78: ...ify disabled and ignoreECC disabled Both source name and serial number will be carried over to the destination unit A special case of this command is when the source unit has a type of RAID1 and desti...

Страница 79: ...s of RAID 5 at the bottom layer of RAID 50 Note that a sufficient number of disks are required for a given pattern or disk group For example given 6 disks specifying 3 will create two RAID 5 arrays Wi...

Страница 80: ...some implementations might create naming fragmentation and a moving target nocache attribute instructs CLI to disable the write cache on the migrated unit Enabling write cache increases write performa...

Страница 81: ...at u3 should be split into Single units In this case u3 is a RAID 1 and the Migrate command splits u3 into u3 and ux each with a RAID type of Single Example of capacity expansion localhost c0 u3 migra...

Страница 82: ...81808 WD WCANM1766952 p5 OK u3 149 05 GB 312581808 WD WCANM1882472 p6 OK u0 149 05 GB 312581808 WD WCANM1883862 p7 OK u3 149 05 GB 312581808 WD WCANM1778008 p8 OK 149 05 GB 312581808 WD WCANM1770998 p...

Страница 83: ...9590SE 9650SE cx px show This command shows summary information about the specified disk attached to port cx px Typical information looks like Example localhost c1 p5 show Port Status Unit Size Block...

Страница 84: ...al This command displays the serial number of the drive attached to the specified port Example localhost c0 p5 show serial c0 p5 Serial WD WMACK140649 cx px show firmware This command displays the fir...

Страница 85: ...maximum SATA link speed supported by the drive attached to the port and the present SATA link speed setting Example localhost c0 p5 show lspeed c0 p5 SATA Link Speed Supported 3 0 Gb s c0 p5 SATA Link...

Страница 86: ...e Version BANC1980 c0 p0 Serial B605X31H c0 p0 Capacity 279 48 GB 586114704 Blocks c0 p0 Identify Status NA c0 p0 SATA Link Speed Supported 1 5 Gb s c0 p0 SATA Link Speed 1 5 Gb s c0 p0 NCQ Supported...

Страница 87: ...D of the port on the controller and causes it to blink Note This command is equivalent to ex slotx set identify on off on page 90 Example localhost c0 p5 set identify on Setting Port Identify on c0 p5...

Страница 88: ...the test cx bbu enable 9000 only cx bbu disable quiet 9000 only cx bbu show This command presents a summary report on the specified BBU object Example localhost c0 bbu show Name OnlineState BBUReady S...

Страница 89: ...ion and the write cache is disabled Once the test is completed with no error and the BBU status changes to OK the write cache will be re enabled If a FAULT or ERROR occurs during the test the write ca...

Страница 90: ...IGH and TOO LOW The HIGH and LOW are in warning range TOO HIGH and TOO LOW are out of the operating range and indicate that it may be time to replace the battery Contact AMCC to obtain a replacement b...

Страница 91: ...ows the current settings of all BBU related attributes ready status batinst lasttest volt temp cap serial fw pcb bootloader Example localhost c1 bbu show all c1 bbu Firmware Version BBU 1 04 00 007 c1...

Страница 92: ...status Check for AENs with the alarms command cx show alarms reverse Using the reverse attribute displays the most recent AEN message at the bottom of the list For a list of all AENs see the user guid...

Страница 93: ...ontroller in order to take advantage of these commands If you have a 3ware Sidecar Kit the required EPCT file is already installed Syntax ex show 9550SX 9590SE 9650SE only ex show attribute attribute...

Страница 94: ...ot1 OK c0 p1 Yes slot2 NO DEVICE No slot3 NO DEVICE No ex show attribute attribute This command shows the current setting of the given attribute s One or many attributes can be requested An invalid at...

Страница 95: ...ts the fans in enclosure ex and shows their status Possible statuses are OK and Unknown Example localhost e0 show fans Fan Status fan0 OK ex show temp This command lists the temperature sensors in enc...

Страница 96: ...lot Example localhost e0 slot1 show Slot Status Port Identify slot1 OK c0 p1 Yes ex slotx show identify This command shows the identify status of the specified slot The status can be either on or off...

Страница 97: ...You can get overview help by typing Help at the top level prompt This displays a brief definition of commands For an example see the discussion of the command help on page 93 You can also get help wit...

Страница 98: ...50SX 9590SE 9650SE RaidType raid0 raid1 raid5 raid6 9650SE raid10 raid50 single spare JBOD 7000 8000 only cx add rebuild ddd hh duration 9000 only cx add verify ddd hh duration 9000 only cx add selfte...

Страница 99: ...x show verify 9000 only cx show selftest 9000 only localhost help This help command provide a table of contents providing help with the overall navigation of the CLI commands Typical output looks like...

Страница 100: ...t provides reports on Controllers Units and Drives See the section Shell Object Commands on page 24 for more information help flush This command provides specific flush related help illustrating vario...

Страница 101: ...e 59 for more information help cx px This command provides specific cx px related help illustrating various ways to use the cx px command See the section Port Object Commands on page 77 for more infor...

Страница 102: ...or OFF to enable or disable logging of controller commands into a log file called tw_mgmt log By default TW_CLI_LOG is set to OFF The command to start command logging varies by operating system For Ma...

Страница 103: ...u type tw_cli c7 show error CLI003 specified controller does not exist echo 1 This example fails returns 1 because there is no controller 7 To view the return code for Windows in a command window type...

Отзывы: