3Ware 720-0127-02, Manual

Page 1: ...3ware Serial ATA RAID Controller Command Line Interface Supports the 9000 Series 9500S and 9550SX PN 720 0127 02 November 2005 CLI Guide ...

Page 2: ... 215 Moffett Park Drive Sunnyvale CA 94089 Trademarks 3ware Escalade and 3DM are all registered trademarks of AMCC The 3ware logo 3BM StorSwitch TwinStor and R5 Fusion are all trademarks of AMCC All other trademarks herein are property of their respective owners Disclaimer While every attempt is made to make this document as accurate as possible AMCC assumes no responsibility for errors or omissio...

Page 3: ...LI to a Text File 9 Conventions 9 Understanding RAID Concepts and Levels 10 Available RAID Configurations 11 Determining What RAID Level to Use 14 StorSave Profiles 16 Chapter 2 Primary CLI Syntax Reference 19 Common Tasks Mapped to CLI Commands 19 Primary Syntax Overview 21 Shell Object Commands 23 focus Object 23 show 24 show ver 25 show alarms reverse 25 show diag 25 show rebuild 25 show verify...

Page 4: ...erify 43 cx show selftest 44 cx add rebuild ddd hh duration 45 cx add verify ddd hh duration 46 cx add selftest ddd hh 47 cx del rebuild slot_id 48 cx del verify slot_id 48 cx del selftest slot_id 48 cx set rebuild enable disable 1 5 48 cx set verify enable disable 1 5 49 cx set selftest enable disable task UDMA SMART 49 cx set exportjbod on off 49 cx set ondegrade cacheoff follow 50 cx set spinup...

Page 5: ...67 cx px show 67 cx px show attribute attribute 67 cx px show status 67 cx px show model 68 cx px show serial 68 cx px show firmware 68 cx px show identify 68 cx px show ncq 68 cx px show lspeed 69 cx px show capacity 69 cx px show smart 69 cx px show all 70 cx px export noscan quiet 70 cx px set identify on off 71 BBU Object Commands 72 cx bbu show 72 cx bbu show attribute attribute 73 cx bbu sho...

Page 6: ...o cid numdrives 90 info cid unitstatus 90 info cid allunitstatus 90 info cid drivestatus 91 info cid exportjbod 91 info cid ondegrade 91 info cid spinup 91 info cid stagger 92 info cid uid 92 info cid uid status 92 info cid uid rebuildstatus 93 info cid uid verifystatus 93 info cid uid initializestatus 93 info cid pid 93 info cid pid status 94 info cid pid model 94 info cid pid serial 94 info cid ...

Page 7: ... tduration 106 sched verify cid remove slot_id 107 sched verify cid enable 107 sched verify cid disable 107 sched selftest cid 107 sched selftest cid add dday hhour 108 sched selftest cid remove slot_id 108 sched selftest cid enable selftest_task_id 108 sched selftest cid disable selftest_task_id 109 Alarms Commands 109 Syntax 110 alarms cid 110 Set Commands 111 set rebuild cid 1 5 111 set verify ...

Page 8: ...vi 3ware 9000 Series Serial ATA Controller CLI Guide ...

Page 9: ... 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 the user guide that came with your 3ware RAID controller Table 1 Sections in this Guide Chapter Descriptio...

Page 10: ...2 3ware 9000 Series Serial ATA Controller CLI Guide ...

Page 11: ...r the latest versions and upgrade instructions Features 3ware CLI is a command line interface storage management application for 3ware RAID Controllers It provides controller logical unit drive and BBU Battery Backup Unit management It can be used in both interactive and batch mode providing higher level API application programming interface functionalities The 3ware CLI provides the functionality...

Page 12: ...gy Logical Units Usually shortened to units These are block devices presented to operating systems A logical unit can 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 un...

Page 13: ...hese are located in packages cli tw_cli 8 html or tw_cli 8 nroff To install 3ware CLI on Windows copy the file tw_cli exe to the directory from which you want to run the program CLI is located on the 3ware CD in the directory packages cli windows Note CLI comes in both 32 bit and 64 bit versions Be sure to copy the correct version for the version of the operating system you are using CLI can only ...

Page 14: ...so available in nroff and html formats These are located in packages cli tw_cli 8 html or tw_cli 8 nroff You will need to be root or have root privileges to install the CLI to usr sbin and to run the CLI Filename tw_cli To install the CLI to a different location change usr sbin to the desired location Notes The installation location needs to be in the environment path for root to execute the CLI w...

Page 15: ... that are used with the Battery Backup Unit BBU Details of the primary syntax are described under Primary CLI Syntax Reference on page 19 Legacy command syntax In the current CLI version the command syntax used in previous versions of the 3ware CLI is still supported to make sure that scripts written with the old syntax will still operate New functions such as BBU related commands StorSave and que...

Page 16: ...erform a task such as redirecting the output of the command to a file It also allows you to use the command line history to eliminate some typing Syntax tw_cli command line arguments Example tw_cli c0 show diag tmp 3w_diag out Using an input file to execute a script You can operate 3ware CLI scripts by executing a file The file is a text file containing a list of CLI commands which you have entere...

Page 17: ...nd parameters for example c0 p0 show all In commands an italic font indicates items that are variable but that you must specify such as a controller ID or a unit ID for example c0 p0 show attribute and cx px show all In commands brackets around an item indicates that it is optional In commands ellipses indicate that more than one parameter at a time can be included for example c0 p0 show attribute...

Page 18: ...g a 3ware controller provides improved performance because 3ware s TwinStor technology reads from both drives simultaneously Striping Striping across disks allows data to be written and accessed on more than one drive at the same time Striping combines each drive s capacity into one large volume Striped disk arrays achieve highest transfer rates and performance at the expense of fault tolerance Di...

Page 19: ...striped disk array see Figure 1 large files are distributed across the multiple disks using RAID 0 techniques Striped disk arrays give exceptional performance particularly for data intensive applications such as video editing computer aided design and geographical information systems RAID 0 arrays are not fault tolerant The loss of any drive results in the loss of all the data in that array and ca...

Page 20: ...simultaneously reading alternating sections of the file For the smaller random transactions the data is read from a single optimal drive head Figure 2 RAID 1 Configuration Example RAID 5 Combines striping data with parity exclusive OR to restore data in case of a drive failure This array type provides performance fault tolerance high capacity and storage efficiency Requires a minimum of three driv...

Page 21: ... the RAID 10 array fail then all of the data will be lost Figure 4 RAID 10 Configuration Example RAID 50 This array is a combination of RAID 5 with RAID 0 This array type provides fault tolerance and high performance Requires a minimum of six drives Several combinations are available with RAID 50 For example on a 12 port controller you can have a grouping of 3 4 or 6 drives A grouping of 3 means t...

Page 22: ... the article RAID Primer on the 3ware website at http www 3ware com products pdf RAID_Primer pdf Determining What RAID Level to Use Select the RAID configuration to use based on the applications to be used on the system whether performance or data protection is of primary importance and the number of disk drives available for use Review the information under Understanding RAID Concepts and Levels ...

Page 23: ...on of RAID 0 RAID 1 hot spare 6 or more RAID 50 Depending on the number of drives a RAID 50 may contain from 2 to 4 subunits For example with 12 drives possible RAID 50 configurations include 2 subunits of 6 3 subunits of 4 or 4 subunits of 3 With 10 drives a RAID 50 will contain 2 subunits of 5 drives each With 16 drives a RAID 50 will contain 2 subunits of 8 drives each or 4 subunits of 4 drives...

Page 24: ... You can set the desired level of data protection versus performance for a unit by specifying the StorSave Profile to be used Three profiles are provided Protection maximum data protection Performance maximum performance less data protection and Balanced a middle ground The default is Protection For details about how to select a StorSave Profile for a unit see cx ux set storsave protect balance pe...

Page 25: ...iod of time up to 72 hours in the event of a power failure Write Journaling Write journaling tracks the writing of data to disk and preserves a copy of data that has not yet been written to the disk media Following a power failure or in the event of accidental drive removal and reinsertion the firmware can recover the unit without data loss All pending writes sitting in the controller cache are re...

Page 26: ...t you must enable the write cache manually using 3DM2 3BM or the CLI The write cache will not automatically reenable when the unit is rebuilt The Protection profile enables this feature so that write cache is disabled the Performance and Balanced profiles disable this feature so that write cache continues to be enabled ...

Page 27: ... Common Tasks Mapped to CLI Commands The table below lists many of the tasks people use to manage their RAID controllers and units and lists the primary CLI command associated with those tasks Table 5 Common Tasks Mapped to CLI Commands Task CLI Command Page Controller Configuration Tasks View information about different controllers cx show 29 View controller policies cx show attribute attribute 3...

Page 28: ...capacity cx ux migrate 62 Delete a unit cx ux del 57 Remove a unit export cx ux export 57 Name a unit cx ux set name 61 Controller Maintenance Tasks Add a time slot to a rebuild schedule cx add rebuild 45 Add a time slot to a verify schedule cx add verify 46 Add a time slot to a selftest schedule cx add selftest 47 Enable disable the rebuild migrate schedule and set the task rate cx set rebuild 48...

Page 29: ...The value of name value attributes are expressed in the format attribute value Example When adding creating a unit to the controller with the following command string c1 add type raid1 disk 0 1 c1 is the object add is the command type for type of array is an attribute with raid1 as the value of the attribute and disk is another attribute with 0 1 as the value ports 0 through 1 Unit Maintenance Tas...

Page 30: ...object commands 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 a unit starting stopping and resuming verifies starting and stopping rebuilds and setting policies for the unit You also use the controller object command cx ux migrate to change the ...

Page 31: ...nstead 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 prompt changes to reflect that and you only have to type show The concept is similar to being in a particular location in a file system and requesting a listing of the current directory object can have the following forms hostname cx ux ...

Page 32: ...em should be loaded for the list to show all controllers The intention is to provide a global view of the environment Typical output of the Show command looks like localhost show Ctl Model Ports Drives Units NotOpt RRate VRate BBU c0 7500 12 12 8 3 1 2 c1 9506S 12 12 6 1 0 3 5 TESTING Indicating that Controller 0 is a 7500 model with 12 Ports with 8 Drives detected attached total of 3 Units with o...

Page 33: ...s in the system show rebuild This command displays all rebuild schedules for the 9000 controllers in the system The rebuild rate is also applicable for initializing migrating and recovery background tasks Example localhost show rebuild Rebuild Schedule for Controller c0 Slot Day Hour Duration Status 1 Sun 12 00am 24 hr s disabled 2 Mon 12 00am 24 hr s disabled 3 Tue 12 00am 24 hr s disabled 4 Wed ...

Page 34: ...of background tasks and schedules in 3ware 9550SX Serial ATA RAID Controller User Guide show selftest This command displays all selftest schedules for the 9000 controllers in the system Example localhost show selftest Selftest Schedule for Controller c0 Slot Day Hour UDMA SMART 1 Sun 12 00am enabled enabled 2 Mon 12 00am enabled enabled 3 Tue 12 00am enabled enabled 4 Wed 12 00am enabled enabled 5...

Page 35: ...system For more information see cx flush on page 40 rescan This command sends a rescan command to all 3ware controllers in the system For more information see cx rescan noscan on page 39 commit This command sends a commit command to all 3ware controllers in the system For more information see cx commit on page 40 ...

Page 36: ...fy 9000 series cx show all cx add type RaidType disk p p stripe Stripe noscan nocache group 3 4 5 6 autoverify ignorECC RaidType raid0 raid1 raid5 raid10 raid50 single spare jbod 7000 8000 only name string 9000 only storsave protect balance perform 9550sx only cx add rebuild ddd hh duration 9000 only cx add verify ddd hh duration 9000 only cx add selftest ddd hh 9000 only cx del rebuild slot_id 90...

Page 37: ...if the condition no longer exists Cmpl reports the percent completion of REBUILDING VERIFYING INITIALIZING or MIGRATING units The Port summary section lists all present ports and specifies the port number disk status unit affiliation size in gigabytes and blocks 512 bytes and the serial number assigned by the disk vendor The BBU summary lists details about the BBU if one is installed It includes a...

Page 38: ...series driver drivestatus exportjbod 9000 series firmware memory model monitor numdrives numports numunits ondegrade 9500S pcb pchip qpolicy serial spinup 9000 series stagger 9000 series and unitstatus Example To see the driver and firmware installed on controller 0 enter the following localhost c0 show driver firmware c0 Driver Version 2 x c0 Firmware Version FE9X 2 x Where x actual version cx sh...

Page 39: ...ial number of the specified controller cx Example localhost c0 show serial c0 Serial Number F12705A3240009 cx show pcb This command reports the PCB Printed Circuit Board version of the specified controller cx Example localhost c0 show pcb c0 PCB Version RevX cx show pchip This command reports the PCHIP PCI Interface Chip version of the specified controller cx Example localhost c0 show pchip c0 PCH...

Page 40: ... report does not include logically removed or exported drives Also note that physically removed disk s will not be detected unless I O is performed against the disk See cx px show smart on page 69 for a workaround Example localhost c0 show numdrives c0 Number of Drives 5 cx show exportjbod This feature only applies to 9000 series controllers This command reports the current JBOD Export Policy on o...

Page 41: ...licy cx show autocarve This feature only applies to 9000 series controllers This command reports the Auto Carve policy If the policy is on all newly created or migrated units larger than the carvesize will be automatically carved into multiples of carvesize volumes plus one remainder volume Each volume can be treated as an individual drive with its own file system The default carvesize is 2TB For ...

Page 42: ... 9500S controllers ship with 128 MBytes of cache yet only 112MB shows as memory installed The other 16 MB is reserved for use by the controller Example localhost c0 show memory c0 Memory Installed 112MB cx show autorebuild This feature only applies to 9550SX model controllers This command shows the Auto Rebuild policy If the policy is enabled the firmware will select drives to use for rebuilding a...

Page 43: ...pe Status Cmpl Stripe Size GB Cache AVerify IgnECC u0 RAID 5 OK 64K 223 485 OFF OFF ON u1 JBOD OK 76 3352 OFF OFF u2 RAID 0 OK 64K 148 99 ON ON cx show allunitstatus This command presents a count of total and Not Optimal units managed by the specified controller cx For more about the meaning of Not Optimal see Shell Object Commands on page 23 Example localhost c0 show allunitstatus c0 Total Optima...

Page 44: ... Version 3 xx c0 Number of Ports 12 c0 Number of Units 2 c0 Number of Drives 12 c0 Total Optimal Units 2 c0 NotOptimalUnits 0 c0 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 GB c0 Auto Rebuild Policy enable Unit UnitType Status Cmpl Stripe Size G...

Page 45: ...nique serial number In addition users can assign the unit a name Note The unit s serial number cannot be changed The following table shows supported types and controller models disk p p consists of a list of ports disks to be used in the construction of the specified unit type One or more ports can be specified Multiple ports can be specified using a colon or a dash as port index separators A dash...

Page 46: ...For 10 disks the default grouping is 5 and for 12 disks the default grouping is 4 In the case of 12 the disks could be grouped into groups of 3 4 or 6 drives A grouping of 4 is set by default as it provides the best of net capacity and performance noscan attribute instructs CLI not to notify the operating system of the creation of the new unit By default CLI will inform the operating system One ap...

Page 47: ...s In order to use reserved characters etc put double quotes around the name string The name can be changed after the unit has been created For more information see cx ux set name string on page 61 and cx ux show name on page 55 storsave protect balance perform attribute allows user to set the storsave policy of the new unit This feature is only for 9550SX controllers For more information see cx ux...

Page 48: ...or the specified controller cx show alarms reverse Asynchronous events also referred to as AENs or alarms are originated by firmware and captured by their respective device drivers These events reflect warning debugging and or informative messages for the end user These events are kept in a finite queue inside the kernel awaiting extraction by user space programs such as CLI and or 3DM The cx show...

Page 49: ...port or further studied with Linux utilities such as od 1 In order to redirect the output you must run the following command from a command line not from within the tw_cli shell tw_cli c0 show diag diag txt cx show rebuild 9000 series controllers support background tasks and allow you to schedule a regular time when they occur Rebuild is one of the supported background tasks Migrate and initialize...

Page 50: ... rebuild is needed and a proper spare drive is set up If the rebuild schedule is enabled while a rebuild process is underway the rebuild will pause until a scheduled time slot Example If a unit is in the initialization state at noon on Wednesday and the rebuild schedule shown above is in use with schedules disabled you would see the following status using the show command localhost c1 show Unit Un...

Page 51: ... 5 INIT PAUSED 0 64K 521 466 ON OFF OFF Port 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 PRESENT p7 OK u0 76 33 GB 160086528 Y2NXM4VE p8 OK u0 74 53 GB 156301488 3JV3WTSE p9 OK u0 74 53 GB 156301488 3JV3WRHC p10 OK u0 74 53 GB 156301488 3JV3WQLQ p11 ...

Page 52: ... that came with your 3ware RAID controller The show verify command displays the current verify background task schedule as illustrated below localhost c1 show verify Verify Schedule for Controller c1 Slot Day Hour Duration Status 1 Mon 2 00am 4 hr s disabled 2 disabled 3 Tue 12 00am 24 hr s disabled 4 Wed 12 00am 24 hr s disabled 5 Thu 12 00am 24 hr s disabled 6 Fri 12 00am 24 hr s disabled 7 Sat ...

Page 53: ...ller to check certain SMART supported thresholds by the disk vendor An AEN is logged to the alarms page if a drive reports a SMART failure The show selftest command displays the current selftest background task schedule as illustrated below Selftests do not have a time duration since they are completed momentarily localhost c1 show selftest Selftest Schedule for Controller c1 Slot Day Hour UDMA SM...

Page 54: ... to also disable the schedule Otherwise the applicable background task will never occur cx add verify ddd hh duration This command adds a new background verify task to be executed on the day ddd where ddd is Sun Mon Tue Wed Thu Fri and Sat at hour hh range 0 23 for a duration of duration range 1 24 hours A maximum of seven verify tasks can be scheduled This command will fail if no empty task slot ...

Page 55: ... Fri and Sat at hour hh range 0 23 Notice that selftest runs to completion and as such no duration is provided A maximum of seven selftest tasks can be scheduled This command will fail if no empty task slot is available Example localhost c1 add selftest Sun 16 adds a selftest background task schedule to be executed on Sundays at 16 hours 4 00 PM Setting Up a Selftest Schedule Setting up a selftest...

Page 56: ...he schedule Otherwise the verify background task will never occur cx del selftest slot_id This command removes or unregisters the selftest background task in slot slot_id Example localhost c1 del selftest 3 Will remove selftest background task in slot 3 Warning If all time slots are removed be sure to also disable the schedule Otherwise the selftest background task will never occur cx set rebuild ...

Page 57: ... 1 implies fastest verify and 5 implies fastest I O Enabling and disabling verify is only for 9000 models however the verify rate 1 5 applies to all controllers Note When enabling the verify schedule you must also remember to enable the autoverify setting for the units to be verified For more information see cx ux set autoverify on off on page 59 cx set selftest enable disable task UDMA SMART This...

Page 58: ...fault is 1 This policy is used to stagger spinups of disks at boot time in order to spread the power consumption on the power supply For example given a spinup policy of 2 the controller will spin up two disks at a time pause and then spin up another 2 disks The amount of time to pause can be specified with the Spinup Stagger Time Policy cx set stagger Not all drives support staggered spinup If yo...

Page 59: ...g Size on c0 to 2000 GB Done cx set autorebuild on off This command is only for 9550SX controllers This command turns the Auto Rebuild policy on or off By default autorebuild is on If the policy is on the firmware will select drives to use for rebuilding a degraded unit using the following priority order 1 Smallest usable spare 2 Smallest usable unconfigured available drive 3 Smallest usable faile...

Page 60: ...ers For 9000 series controllers use the verify command This command provides media scrubbing for validating the functionality of a disk including bad block detection remapping and so forth The command starts a media scan operation on the specified controller cx cx stop mediascan This command applies only to 7000 8000 controllers This commands stops a media scan operation on the specified controlle...

Page 61: ...ild 7000 8000 only cx ux resume rebuild 7000 8000 only cx ux stop verify cx ux flush cx ux del noscan quiet cx ux set autoverify on off cx ux set cache on off quiet cx ux set ignoreECC on off cx ux set qpolicy on off 9550SX only cx ux set name string 9000 series cx ux set storsave protect balance perform 9550SX only cx ux migrate type RaidType disk p p group 3 4 5 6 stripe Stripe noscan nocache au...

Page 62: ...ested Specifying an invalid attribute will terminate the loop Possible attributes are initializestatus rebuildstatus status and verifystatus cx ux show status This command reports the status of the specified unit Possible statuses include OK VERIFYING VERIFY PAUSED INITIALIZING INIT PAUSED REBUILDING REBUILD PAUSED DEGRADED MIGRATING MIGRATE PAUSED RECOVERY INOPERABLE and UNKNOWN Examples localhos...

Page 63: ...the specified unit Examples localhost c0 u5 show name c0 u5 name Joe cx ux show serial This feature only applies to 9000 series controllers This command reports the unique serial number of the specified unit Examples localhost c0 u5 show serial c0 u5 Serial Number 12345678901234567890 cx ux show qpolicy This feature only applies to 9550SX model controllers This command reports the queue policy of ...

Page 64: ...If the auto carve policy was on at the time the unit was created and the unit is over 2TB the number of multiple volumes will be displayed Example localhost c0 u1 show all c0 u1 status OK c0 u1 is not rebuilding its current state is OK c0 u1 is not verifying its current state is OK c0 u1 is not initializing its current state is OK c0 u1 volume s 2 c0 u1 name 1234567 c0 u1 serial number C6CPR7JMF98...

Page 65: ... swap carriers are required to do this while the system is online Otherwise you must power down the system to prevent system hangs and damage cx ux del noscan quiet This command allows you to delete a unit Deleting a unit not only removes the specified unit from the controller s list of managed units but also destroys the DCB Disk Configuration Block metadata After deleting a unit ports or disks a...

Page 66: ...add new drives or to retry the original drive If you are rebuilding a RAID 50 or RAID 10 unit multiple drives can be specified if more than one sub array is degraded When you issue this command the specified rebuild will begin if schedules are disabled otherwise it will pause until the next scheduled rebuild A file system check is recommended following rebuild when using the ignoreECC option cx ux...

Page 67: ...rs to achieve similar functionality with use of Linux provided schedulers such as cron 8 or at 1 or user supplied programs cx ux stop verify This command stops a background verification process on the specified unit cx ux Table 9 on page 58 shows the supported matrix as a function of the controller model and logical unit type cx ux flush This command allows you to flush the write cache on the spec...

Page 68: ...controller model and logical unit type N A Not Applicable refers to cases where the given logical unit type is not supported on a particular controller model The quiet attribute turns off interactive mode cx ux set ignoreECC on off This feature only applies to 9000 series controllers This command allows you to set the ignoreECC policy for a given unit When ignoreECC policy is set to off if a rebui...

Page 69: ...l controllers This command sets the storsave policy to be either protect balance or perform when the unit write cache is enabled The default setting is protect The storsave policy adjusts several factors that control the balance between protection and performance on a unit There is a trade off among the available settings The following description about the settings should help you to decide which...

Page 70: ...ll be ignored For additional information see Setting the StorSave Profile for a Unit in the 3ware 9550SX Serial ATA RAID Controller User Guide Example localhost c0 u5 set storsave protect Setting Command Storsave Policy for unit c0 u5 to protect Done cx ux migrate type RaidType disk p p group 3 4 5 6 stripe Stripe noscan nocache autoverify This feature only applies to 9000 series controllers This ...

Page 71: ...more capacity as the existing one A four drive RAID 5 unit can migrate to a four drive RAID 0 but a four drive RAID 0 unit cannot migrate to a four drive RAID 5 without adding another drive due to the need for additional storage capacity for parity bits The following table illustrates valid migration paths disk p p consists of a list of ports disks to be used in addition to the source disks in the...

Page 72: ...rouping varies based on number of disks For 6 and 9 disks default grouping is 3 For 8 disks the default grouping is 4 For 10 disks the default grouping is 5 and for 12 disks the default grouping is 4 In the case of 12 the disks could be grouped into groups of 3 4 or 6 drives A grouping of 4 is set by default as it provides the best of net capacity and performance Note that RAID 10 always has group...

Page 73: ...ng this time Once the migration is finished a reboot will be required if you are booted from the unit For secondary storage depending on your operating system you may need to first unmount the unit then use CLI commands to export and rescan the unit so that the operating system can see the new capacity and then remount the unit For details see cx ux export noscan quiet on page 57 and cx rescan nos...

Page 74: ...MIGRATING 0 74 4951 ON OFF OFF Port Status Unit Size Blocks Serial p0 OK u0 74 53 GB 156301488 3JV2Q1VA p1 OK u0 232 83 GB 488281250 WD WMAEH15764 p2 OK u0 232 83 GB 488281250 WD WMAEH17004 p3 OK u0 232 83 GB 488281250 WD WMAEH17000 p4 NOT PRESENT p5 NOT PRESENT p6 NOT PRESENT p7 NOT PRESENT p8 NOT PRESENT p9 NOT PRESENT p10 NOT PRESENT p11 NOT PRESENT 3ware CLI c0 u0 show Unit UnitType Status Cmp...

Page 75: ...nd 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 Blocks Serial p5 OK u0 149 05 GB 312581808 3JS0L9QW The above report indicates that port 5 of controller 1 is attached to one l disk with status OK participating in unit 0 cx px show attribute attribute This command shows the current setting...

Page 76: ...the specified port Example localhost c0 p5 show firmware c0 p5 Firmware Version 65 13G65 cx px show identify This command applies only to 9550SX model controllers that have chassis control hardware enclosure services attached This command shows whether the LED of the drive attached to the specified port is set to on or off For details see cx px set identify on off on page 71 Example localhost c0 p...

Page 77: ...f the drive attached to the specified port in two formats GB and blocks Note that of this version the GB format is computed based on division by 1000 not 1024 Example localhost c0 p5 show capacity 149 05 GB 312581808 cx px show smart This command extracts SMART Self Monitoring Analysis and Reporting data from the specified disk Because the data is extracted live from the disk this command can be u...

Page 78: ... Speed Supported 1 5 Gb s c0 p0 SATA Link Speed 1 5 Gb s c0 p0 NCQ Supported No c0 p0 NCQ Enabled No c0 p0 Belongs to Unit u1 c0 p0 Drive Smart Data 0A 00 01 0F 00 3D 33 25 8C BA 03 00 00 00 03 03 00 61 60 00 00 00 00 00 00 00 04 32 00 64 64 00 00 00 00 00 00 00 05 33 00 64 64 00 00 00 00 00 00 00 07 0F 00 4E 3E 05 13 D8 03 00 00 00 09 32 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 8D cx px expor...

Page 79: ... controllers This command sets the LED status of the port to on or off If identify is set to on the firmware activates the setting of the corresponding LED of the port on the controller and causes it to blink Note This feature will be supported by chassis vendors It requires a chassis with support for Chassis Control Unit CCU The CCU will also support the monitoring of fan speed temperature sensor...

Page 80: ... bbu enable 9000 only cx bbu disable 9000 only cx bbu show This command presents a summary report on the specified BBU object Example localhost c0 bbu show Name OnlineState BBUReady Status Volt Temp Hours LastCapTest bbu ON No Testing OK OK 72 01 Jul 2004 The command output indicates that the battery capacity was last measured on 01 Jul 2004 The battery is estimated to last for 72 hours from the l...

Page 81: ...he 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 cache remains in the disabled state until the problem is fixed Fault A battery fault is detected The BBU is not capable of backup operation and the write cache is disabled Replace the battery and or the BBU board as soon as possible so that the...

Page 82: ...ttery Contact AMCC to obtain a replacement battery cx bbu show temp This command shows the temperature status of the battery The status can be OK HIGH LOW TOO HIGH 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 battery cx bbu show cap This command show...

Page 83: ...der Version BBU 0 02 00 002 c1 bbu PCB Revision 65 localhost cx bbu test quiet This command starts the battery capacity test The test may take up to 24 hours to complete During the test the BBU is not capable of backup operation and the write cache of all units attached to that controller is disabled Once the test is completed with no error and the BBU status returns to OK the write cache will be ...

Page 84: ... a question mark at the point in a command where you are uncertain what the attributes are Help with specific commands If you enter the help command at the top level you are considered to be in the Shell Object and the help command will provide help on the Shell commands focus show flush rescan and commit Using the help command on objects such as cx cx ux cx px and cx bbu displays all possible sub...

Page 85: ... only cx set selftest enable disable task UDMA SMART 9000 only cx set autorebuild on off 9550SX only cx flush cx commit Windows only Also known as shutdown cx start mediascan 7000 8000 only cx stop mediascan 7000 8000 only cx rescan noscan NOTE Does not import non JBOD on 7000 8000 models localhost Help with attributes As you work with specific objects or commands you can also use to get help For ...

Page 86: ... Displays or modifies controller and unit settings sched Schedules background tasks on controller s 9000 only quit Exits the CLI New Command Syntax focus Changes from one object to another For Interactive Mode Only show Displays information about controller s unit s and port s flush Flush write cache data to units in the system rescan Rescan all empty ports for new unit s and disk s commit Commit ...

Page 87: ...ious ways to use the focus command See the section Shell Object Commands on page 23 for more information help cx This command provides specific controller cx related help illustrating various commands associated with the controller cx See the section Controller Object Commands on page 28 for more information help cx ux This command provides specific unit cx ux related help illustrating various com...

Page 88: ...OLD To keep the new CLI Input Style following a reboot or when a new window or shell is opened you must edit the environment variables in both Windows and Linux Refer to your operating system s administration guide for more details Return Code While informative messages are written to standard output error messages are written to standard error On success 0 is returned On failure 1 is returned at ...

Page 89: ...To view the return code for Windows in a command window type tw_cli c0 show c0 info displayed here if errorlevel 0 echo 0 0 tw_cli c7 show error if errorlevel 1 echo 1 1 This example fails returns 1 because there is no controller 7 ...

Page 90: ...Chapter 2 Primary CLI Syntax Reference 82 3ware 9000 Series Serial ATA Controller CLI Guide ...

Page 91: ...ller Typical operations include create array delete array rebuild array verify array and remove array from the controller For details see Maint Commands on page 96 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 comma...

Page 92: ... 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 autoverify or overwriteECC For details see Set Commands on page 111 Help Help commands Options in this category allow you to display help information on the other commands and...

Page 93: ...h or sh enter export TW_CLI_STYLE OLD For Linux csh C shell enter setenv TW_CLI_STYLE OLD For Windows enter set TW_CLI_STYLE OLD To keep the new CLI output style following a reboot or when a new window or shell is opened you must edit the environment variables in both Windows and Linux To use the new style enter TW_CLI_STYLE or TW_CLI_STYLE NEW The examples in this document use the new style of re...

Page 94: ...he example shows that the controller s rebuild rate RRate is set to 2 and the verify rate VRate is not applicable Additional attributes about individual controllers units ports and disks can be obtained by querying for them explicitly using for example info cid or info cid uid See the other info sub commands below info cid Provides overall summary information on controller cid The report consists ...

Page 95: ...9 05 GB3125818083JS0VG85 p3 OK u1 149 05 GB3125818083JS0VGCY p4 OK u1 149 05 GB3125818083JS0VGGQ p5 OK u2 149 05 GB3125818083JS0VH1P p6 OK 149 05 GB3125818083JS0TF0P p7 OK 149 05 GB3125818083JS0VF43 p8 OK 149 05 GB3125818083JS0VG8D p9 NOT PRESENT p10 NOT PRESENT p11 NOT PRESENT 3ware CLI calculates one megabyte as 1024 x 1024 the same calculation that Windows and Linux use 3DM 2 uses 1024 x 1024 s...

Page 96: ...ler cid Example localhost info c0 firmware c0 Firmware Version FGXX 2 01 00 025 info cid bios This command reports the BIOS version of controller cid Example localhost 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 localhost info c0 monitor c0 Monitor Version BLDR 1 00 00 008 ...

Page 97: ...roller cid Example localhost 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 localhost info c0 achip c0 ACHIP Version 3 20 info cid numports This command reports the number of ports of the specified controller cid Example localhost info c0 numports c0 Number of Ports 12 info cid numunits This co...

Page 98: ... numdrives c0 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 localhost info c0 unitstatus Unit UnitType Status Cmpl Stripe Size GB Cache AVerify OvrECC u0 RAID 5 VERIFYING 79...

Page 99: ...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 localhost info c0 exportjbod c0 JBOD Export Policy off info cid ondegrade This command shows whether the write cache will be disable...

Page 100: ...of a degraded unit has caused the unit to degrade and which disk within that sub unit is the source of degradation Example localhost 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...

Page 101: ...t Example localhost 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 localhost 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 localhost info p5 Por...

Page 102: ...pacity is computed 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 86 Example localhost 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 ...

Page 103: ... 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 104: ...not import non 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 Raid Type raid0 raid1 raid5 raid10 raid50 single 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...

Page 105: ...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 106: ...stem Alert Removing 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 T...

Page 107: ... types 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 ks...

Page 108: ...e best of net capacity and performance noscan switch 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 Enabli...

Page 109: ...tem check is recommended once the rebuild is complete Note The ignoreECC option is not required for the 9000 series if the variable is already assigned when you create or set later Refer to the set overwriteECC cid uid on off on page 112 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 re...

Page 110: ...bing for validating the operationality of a disk including bad block detection and remapping The start or stop operations start or stop media scan operation on the specified controller For 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 ...

Page 111: ... the process by instructing the controller to finish pending requests and clear the DCBs in transaction flag as the disk is going down 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 112: ...ndant units On 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 ...

Page 113: ...our 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 localhost 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 114: ...led 1 2 Tue 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 dday hhour tduration 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 wil...

Page 115: ... enabling the verify schedule you must also remember to also enable the autoverify setting for the arrays to be verified For details see set autoverify cid uid on off on page 112 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 localhost tw_cli sched selfte...

Page 116: ...al order Also 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 localhost 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 se...

Page 117: ... 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 fir...

Page 118: ...llers Note A 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 ...

Page 119: ...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 relation...

Page 120: ...rify command 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 series controllers 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...

Page 121: ...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 122: ...ssages are written 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 inf...