background image

vi

3ware 9000 Series Serial ATA Controller CLI Guide

Summary of Contents for 9500S

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 ot...

Page 3: ...I 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 Refe...

Page 4: ...rify 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 c...

Page 5: ...7 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...

Page 6: ...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...

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_i...

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...

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

Page 11: ...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...

Page 12: ...y 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 unit...

Page 13: ...ese 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 3...

Page 14: ...o 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 C...

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 sy...

Page 16: ...rform 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...

Page 17: ...d 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...

Page 18: ...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 mor...

Page 19: ...triped 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 applicatio...

Page 20: ...imultaneously 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 strip...

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 h...

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...

Page 23: ...n 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 subunit...

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...

Page 25: ...od 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 me...

Page 26: ...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 c...

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...

Page 28: ...apacity 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...

Page 29: ...he 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 t...

Page 30: ...bject 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 initi...

Page 31: ...stead 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...

Page 32: ...m 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...

Page 33: ...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 ta...

Page 34: ...f 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 localho...

Page 35: ...ystem 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 co...

Page 36: ...y 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 st...

Page 37: ...f 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 num...

Page 38: ...eries 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...

Page 39: ...al 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 contro...

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...

Page 41: ...icy 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...

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 112M...

Page 43: ...e 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 to...

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 Spinu...

Page 45: ...ique 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 l...

Page 46: ...or 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 pro...

Page 47: ...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...

Page 48: ...r 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...

Page 49: ...ort 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 dia...

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 t...

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...

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 S...

Page 53: ...ler 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 backgr...

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...

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...

Page 56: ...e 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 selft...

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 y...

Page 58: ...ault 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 t...

Page 59: ...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...

Page 60: ...rs 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...

Page 61: ...ld 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...

Page 62: ...sted 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 spe...

Page 63: ...he 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 specifie...

Page 64: ...f 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...

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...

Page 66: ...dd 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 spe...

Page 67: ...s 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...

Page 68: ...ontroller 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 m...

Page 69: ...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 facto...

Page 70: ...l 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 Comma...

Page 71: ...ore 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...

Page 72: ...ouping 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 I...

Page 73: ...g 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 the...

Page 74: ...IGRATING 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 23...

Page 75: ...d 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...

Page 76: ...he 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 enc...

Page 77: ...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...

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 6...

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 t...

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 Ho...

Page 81: ...e 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...

Page 82: ...tery 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 w...

Page 83: ...er 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...

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 She...

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 med...

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 Interact...

Page 87: ...ous 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...

Page 88: ...LD 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 adminis...

Page 89: ...o 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 be...

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

Page 91: ...ler 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 co...

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...

Page 93: ...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...

Page 94: ...e 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 obtaine...

Page 95: ...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...

Page 96: ...er 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...

Page 97: ...oller 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 ac...

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 complet...

Page 99: ...1808 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 s...

Page 100: ...f 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 R...

Page 101: ...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 in...

Page 102: ...acity 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...

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...

Page 104: ...ot 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...

Page 105: ...m 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 instruc...

Page 106: ...tem 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 Singl...

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 s...

Page 108: ...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...

Page 109: ...em 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 ove...

Page 110: ...ing 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 ser...

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...

Page 112: ...dant 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...

Page 113: ...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...

Page 114: ...ed 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 tduratio...

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 disab...

Page 116: ...l 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 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 a...

Page 118: ...lers 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 C...

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

Page 120: ...ify 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...

Page 121: ...y 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...

Page 122: ...sages 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 whe...

Reviews: