Command Line Interface Version 9.
Copyright ©2003-2007 Applied Micro Circuits Corporation (AMCC). All rights reserved. This publication may be copied or reproduced for reference purposes only. All other purposes require the express written consent of AMCC, 215 Moffett Park Drive, Sunnyvale, CA 94089. AMCC shall not be responsible or liable for, and shall be held harmless against, any and all damages, claims, and/or disputes that arise from the copying or reproduction of this publication.
Table of Contents About this CLI Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 Chapter 1. Introduction to the 3ware Command Line Interface. . . . . . . . . . . . . . . . . .2 Features of the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Supported Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Terminology . . . . . . . . . . . . . . . . . . . . .
/cx show driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . /cx show drivestatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . /cx show firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . /cx show memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . /cx show model . . . . . . . . . . . . . . . . . . . . . . . . . . .
/cx/ux show ignoreECC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . /cx/ux show initializestatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . /cx/ux show name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . /cx/ux show qpolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . /cx/ux show rebuildstatus . . . . . . . . . . . . . . . . . . . . . . . . . . .
/cx/bbu show pcb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 /cx/bbu show serial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 /cx/bbu show status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 /cx/bbu show temp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 /cx/bbu show volt . . . . . . . . . . . . . . . . . . . . . .
About this CLI Guide 3ware SAS/SATA RAID Controller CLI Guide provides instructions for configuring and maintaining your 3ware controller using 3ware’s command line interface (CLI). This guide assumes that you have already installed your 3ware RAID controller in your system. If you have not yet done so, see the installation guide that came with your 3ware RAID controller for instructions.
1 Introduction to the 3ware Command Line Interface The 3ware SATA RAID Controller Command Line Interface (CLI) manages multiple 7000, 8000, and 9000-series 3ware ATA and Serial ATA RAID controllers via a command line or script. Note: Some CLI commands are supported only for particular models of 3ware RAID controllers. Wherever possible, commands are labeled to indicate when they are supported for only a subset of controllers.
Supported Operating Systems You can use the CLI to view unit status and version information and perform maintenance functions such as adding or removing drives. 3ware CLI also includes advanced features for creating and deleting RAID units online. For a summary of what you can do using the CLI, see “Common Tasks Mapped to CLI Commands” on page 20. Supported Operating Systems The 9.5 version of the 3ware CLI is supported under the following operating systems: • Windows®.
Chapter 1. Introduction to the 3ware Command Line Interface more expanders. The VPort ID allows a drive to be consistently identified, used in a RAID unit, and managed. For additional information about 3ware controller concepts and terminology, see the user guide that came with your 3ware RAID controller or the user guide portions of the 3ware HTML Bookshelf.
Installing the 3ware CLI Permissions Required to Run CLI To run CLI, you can be logged onto Windows with one of the following sets of permissions: • Administrator • User with 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 you are uncertain whether you have the correct permissions, contact your network administrator.
Chapter 1. Introduction to the 3ware Command Line Interface • If no GUI is installed, navigate to packages/installer/linux/x86 (or /86-64, depending on your system) on the 3ware CD. Type: ./setupLinux_x86.bin -console or ./setupLinux_x64.bin -console (depending upon which directory you are in) and press Enter to begin installing the CLI. More detailed information about using this installer is supplied in Appendix B of 3ware Serial ATA RAID Controller User Guide.
Working with 3ware CLI Examples shown in the CLI Syntax Reference chapter reflect the interactive method. Using 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, change to the directory that contains CLI. 2 Enter the following command: tw_cli (Under Linux, if the directory containing the CLI is not in your path, you may need to type .
Chapter 1. Introduction to the 3ware Command Line Interface 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 entered in advance. Each command must be on a separate line. Syntax tw_cli -f Where is the name of the text file you want to execute. Example tw_cli -f clicommand.
Understanding RAID Levels and Concepts Outputting the CLI to a Text File You can have the output of the 3ware CLI, including errors, sent to a text file by adding 2>&1 to the end of the line. This could be useful, for example, if you want to email the output to AMCC Technical Support. Examples tw_cli /c2/p0 show >> controller2port0info.txt 2>&1 or tw_cli /c0 show diag >> Logfile.
Chapter 1. Introduction to the 3ware Command Line Interface This section organizes information about RAID concepts and configuration levels into the following topics: • “RAID Concepts” on page 10 • “Available RAID Configurations” on page 11 • “Determining What RAID Level to Use” on page 17 RAID Concepts The following concepts are important to understand when working with a RAID controller: • Arrays and Units.
Understanding RAID Levels and Concepts Available RAID Configurations RAID is a method of combining several hard drives into one unit. It offers fault tolerance and higher throughput levels than a single hard drive or group of independent hard drives. RAID levels 0, 1, 10 and 5 are the most popular. AMCC's 3ware controllers support RAID 0, 1, 5, 6, 10, 50, and Single Disk. The information below provides a more in-depth explanation of the different RAID levels.
Chapter 1. Introduction to the 3ware Command Line Interface RAID 1 RAID 1 provides fault tolerance and a speed advantage over non-RAID disks. RAID 1 is also known as a mirrored array. Mirroring is done on pairs of drives. Mirrored disk arrays write the same data to two different drives using RAID 1 algorithms (see Figure 2). This gives your system fault tolerance by preserving the data on one drive if the other drive fails.
Understanding RAID Levels and Concepts Figure 3. RAID 5 Configuration Example RAID 6 RAID 6 requires a 3ware 9650SE or 9690SA RAID controller. RAID 6 provides greater redundancy and fault tolerance than RAID 5. It is similar to RAID 5, but has two blocks of parity information (P+Q) distributed across 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.
Chapter 1. Introduction to the 3ware Command Line Interface Figure 4. RAID 6 Configuration Example RAID 10 RAID 10 is a combination of striped and mirrored arrays for fault tolerance and high performance. When drives are configured as a striped mirrored array, the disks are configured using both RAID 0 and RAID 1 techniques, thus the name RAID 10 (see Figure 5). A minimum of four drives are required to use this technique. The first two drives are mirrored as a fault tolerant array using RAID 1.
Understanding RAID Levels and Concepts Figure 5. RAID 10 Configuration Example RAID 50 RAID 50 is a combination of RAID 5 with RAID 0. This array type provides fault tolerance and high performance. RAID 50 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.
Chapter 1. Introduction to the 3ware Command Line Interface Figure 6. RAID 50 Configuration Example Single Disk A single drive can be configured as a unit through 3ware software. (3BM, 3DM 2, or CLI). Like disks in other RAID configurations, single disks contain 3ware Disk Control Block (DCB) information and are seen by the OS as available units.
Understanding RAID Levels and Concepts Hot Spare A hot spare is a single drive, available online, so that a redundant unit can be automatically rebuilt in case of drive failure. Determining What RAID Level to Use Your choice of which type of RAID unit (array) to create will depend on your needs. You may wish to maximize speed of access, total amount of storage, or redundant protection of data. Each type of RAID unit offers a different blend of these characteristics.
Chapter 1.
Understanding RAID Levels and Concepts Through drive coercion, the capacity used for each drive is rounded down so that drives from differing manufacturers are more likely to be able to be used as spares for each other. The capacity used for each drive is rounded down to the nearest GB for drives under 45 GB (45,000,000,000 bytes), and rounded down to the nearest 5 GB for drives over 45 GB. For example, a 44.3 GB drive will be rounded down to 44 GB, and a 123 GB drive will be rounded down to 120 GB.
2 CLI Syntax Reference This chapter provides detailed information about using the command syntax for the 3ware CLI. Throughout this chapter the examples reflect the interactive method of executing 3ware CLI. Note: The output of some commands varies somewhat for different types of controllers, and may vary if you have an enclosure attached. For most commands where this is the case, examples are provided to show the differences.
Common Tasks Mapped to CLI Commands Table 5: Common Tasks Mapped to CLI Commands Task CLI Command Page Create a new unit /cx add 40 Create a hot spare /cx add 40 Enable/disable unit write cache /cx/ux set cache 70 Set the queue policy /cx/ux set qpolicy 72 Set the storsave profile /cx/ux set storsave 72 Change RAID level /cx/ux migrate 73 Change stripe size /cx/ux migrate 73 Expand unit capacity /cx/ux migrate 73 Delete a unit /cx/ux del 67 Remove a unit (export) /cx/ux remov
Chapter 2.
Syntax Overview Attributes are either Boolean Attributes or Name-Value Attributes. • The value of a boolean attribute is deduced by presence or lack of—that is, the attribute is either specified, or not. For example, the command show alarms by default lists alarms with the most recent alarm first. If you 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.
Chapter 2. CLI Syntax Reference Enclosure Object Commands. Enclosure object commands provide information and perform actions related to a particular enclosure. For example, you can use enclosure object commands to see information about an enclosure and its elements (slots, fan, and temperature sensor elements). Help Commands. Help commands allow you to display help information for all commands and attributes. For details, see “Help Commands” on page 98.
Shell Object Commands / specifies the root ./object specifies the next level of the object. specifies a relative path with respect to the current focused hostname. /c0/bbu Example: //localhost> focus /c0/u0 //localhost/c0/u0> //localhost/c0/u0> focus.. //localhost/c0> //localhost> focus u0 //localhost/c0/u0> //localhost/c0> focus / //localhost> The focus command is available by default. You can disable focus by setting TW_CLI_INPUT_STYLE to old. (See “Return Code” on page 103.
Chapter 2. CLI Syntax Reference Note that the device drivers for the appropriate operating system should be loaded for the list to show all controllers. The intention is to provide a global view of the environment.
Shell Object Commands show rebuild This command displays all rebuild schedules for the 9000 series controllers in the system. The rebuild rate is also applicable for initializing, migrating, and recovery background tasks.
Chapter 2. CLI Syntax Reference 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” stands for the actual version. See the Release Notes for details. show verify This command displays all verify schedules for the 9000 series controllers in the system.
Controller Object Commands Controller Object Commands Controller object commands provide information and perform actions related to a specific controller, such as /c0. For example, you use controller object commands to see alarms specific to a controller, to create schedules for when background tasks are run, and to set policies for the controller. You also use the controller object command /cx add type to create RAID arrays. Syntax /cx show /cx show [pause [lines=n]] /cx show attribute [attribute ...
Chapter 2. CLI Syntax Reference /cx /cx /cx /cx /cx /cx /cx /cx set stagger=nn (9000 series) set autocarve=on|off (9000 series SX/SE/SA only) set carvesize=[1024...2048] (9000 series SX/SE/SA only) set rebuild=enable|disable|1..5 (9000 series) set autorebuild=on|off (9000 series SX/SE/SA only) set autodetect=on|off disk=|all set verify=enable|disable|1..
Controller Object Commands The Port summary section lists all present ports (or virtual 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 few important attributes such as hours left (in which the current BBU can backup the controller cache in the event of power loss), temperature, voltage, readiness, and so forth.
Chapter 2. CLI Syntax Reference /cx show attribute [attribute ...] This command shows the current setting of the specified attributes on the specified controller. One or many attributes can be specified. Specifying an invalid attribute will terminate the loop.
Controller Object Commands default carvesize is 2TB. For more information see, “/cx show memory”, below. For operating systems that support units larger than 2TB, there is no need to set the policy to on unless you want the operating system to have multiple smaller volumes. If you use a 32-bit operating system, it is recommended that you keep the policy on unless you know that your operating system supports disks that are larger than 2 TB.
Chapter 2. CLI Syntax Reference /cx show carvesize This feature only applies to 9000 series SX/SE/SA model controllers. This command shows the maximum size of the volumes that will be created if the autocarve policy is set to on. The carvesize can be set between 1024 GB and 2048 GB. Default carvesize is 2048 GB (2 TB). For more information see, “/cx show autocarve” above.
Controller Object Commands p5 p6 p7 p8 p9 p10 p11 OK OK OK OK NOT-PRESENT NOT-PRESENT NOT-PRESENT u2 - 149.05 149.05 149.05 149.05 - GB GB GB GB 312581808 312581808 312581808 312581808 - 3JS0VH1P 3JS0TF0P 3JS0VF43 3JS0VG8D - Example for 9690SA controller: //localhost> /c2 show drivestatus VPort Status Unit Size Type Phy Encl-Slot Model -------------------------------------------------------------------------p0 OK u0 34.25 GB SAS /c2/e0/slt0 MAXTOR ATLAS15K2_36 p1 OK u0 34.
Chapter 2. CLI Syntax Reference /cx show memory This command reports the available memory on the controller. Note: Some memory is reserved for use by the controller, so the amount of memory available will be less than the controller actually has installed. The 9690SA controller has 512MB of memory of which 448MB is available. Example: //localhost> /c2 show memory /c2 Available Memory = 448MB /cx show model This command reports the controller model of controller /cx.
Controller Object Commands Example: //localhost> /c0 show numports /c0 Number of Ports = 12 For the 9690SA, this command reports the number of virtual ports being used. Example for 9690SA: //localhost> /c2 show numports /c2 Number of Ports = 32 /cx show numunits This command reports the number of units currently managed by the specified controller /cx. This report does not include off-line units (or removed units).
Chapter 2. CLI Syntax Reference /cx show serial This command reports the serial number of the specified controller /cx. Example: //localhost> /c0 show serial /c0 Serial Number = F12705A3240009 /cx show spinup This feature only applies to 9000 series controllers. This command reports the number of concurrent SAS and SATA disks that will spin up when the system is powered on, after waiting for the number of seconds specified with the set stagger command.
Controller Object Commands Example: //localhost> /c2 show unitstatus Unit UnitType Status %RCmpl %V/I/M Stripe Size(GB) Cache AVrfy ------------------------------------------------------------------------u0 RAID-5 OK 64K 596.004 ON OFF u1 RAID-0 OK 64K 298.002 ON OFF u2 SPARE OK 149.042 OFF u3 RAID-1 OK 149.
Chapter 2. CLI Syntax Reference p4 p5 p6 p7 p8 p9 OK OK OK OK OK OK u0 u1 u1 - 34.25 34.25 68.36 34.25 34.18 34.
Controller Object Commands /cx show phy This command is for the 9690SA only. It reports a list of the phys for the controller. Example of 9690SA-8E connected to drives in an enclosure: Device --- Link Speed (Gbps) --Phy SAS Addesss Type Device Supported Enabled Limit -------------------------------------------------------------------------phy0 500050e000030232 ENCL N/A 1.5-3.0 3.0 Auto phy1 500050e000030232 ENCL N/A 1.5-3.0 3.0 Auto phy2 500050e000030232 ENCL N/A 1.5-3.0 3.
Chapter 2. CLI Syntax Reference enabled. For in depth information about rebuild and other background tasks, see “About Background Tasks” in the 3ware Serial ATA RAID Controller User Guide. The show rebuild command displays the current rebuild background task schedule as illustrated below.
Controller Object Commands If you then enable the rebuild schedules, the unit initialization will be paused until the next scheduled time slot, as reflected in the examples below: //localhost> /c1 set rebuild=enable Enabling scheduled rebuilds on controller /c1 ...Done.
Chapter 2. CLI Syntax Reference For details about setting up a schedule for background selftest tasks, see “Setting Up a Selftest Schedule” on page 54. Selftest activity provides two types of selftests; UDMA (Ultra Direct Memory Access) and SMART (Self Monitoring Analysis and Reporting). Both self tests are checked once each day by default. Note: UDMA mode is applicable only for PATA (parallel ATA) drives on earlier 3ware controllers. It is not applicable for SATA or SAS drives.
Controller Object Commands Selftest Schedule for Controller /c1 ======================================================== 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 Thu 12:00am enabled enabled 6 Fri 12:00am enabled enabled 7 Sat 12:00am enabled enabled /cx show verify 9000 series controllers support background tasks and allow you to schedule a regula
Chapter 2. CLI Syntax Reference A status of “disabled” indicates that the controller will not use the defined schedule timeslots and will start verifying immediately (within 10 to 15 minutes), if the verify command is entered manually, or it will begin automatically if the autoverify option is set. Rebuilds, migrations, and initializations will take priority over verifies.
Controller Object Commands The following table shows supported types and controller models. Table 6: Supported RAID Types Model R0 R1 R5 R6 R10 R50 Single Spare 7K/8K Yes Yes Yes No Yes No No Yes 9000a Yes Yes Yes No Yes Yes Yes Yes 9650SE and 9690SA Yes Yes Yes Yes Yes Yes Yes Yes a. Models 9500S, 9550SX, and 9590SE 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.
Chapter 2. CLI Syntax Reference Table 7: Supported Stripe Sizes (KB) Model R0 R1 R5 9650SE and 9690SA 16 N/A 16 64 64 256 256 R6 64 R10 Spare R50 Single 16 N/A 16 N/A 64 64 256 256 a. Models 9500S, 9550SX, and 9590SE group=3|4|5|6|7|8|9|10|11|12/13|14|15|16 indicates the number of disks 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.
Controller Object Commands noqpolicy attribute instructs CLI to disable the qpolicy (drive queuing for SATA drives only) on the newly created unit. The default is for the qpolicy to be on (in other words, noqpolicy is not specified). For a spare unit, drive queuing is not meaningful, so the noqpolicy cannot be set. During unit creation, specifying noqpolicy for a spare returns an error. (If the spare unit becomes a true unit, it will adopt the qpolicy of the “new” unit.
Chapter 2. CLI Syntax Reference Creating new unit on Controller /c0 ... Done. The new unit is / c0/u0. Setting write cache=ON for the new unit ... Done. Setting default Command Queuing Policy for unit /c0/u0 to [on] ... Done. After the unit creation, a subsequent ``show'' command for the unit shows the the volume size(s): //localhost> /c0/u0 show Unit UnitType Status %RCmpl %V/I/M VPort Stripe Size(GB) -----------------------------------------------------------------------u0 RAID-5 OK 64K 1117.
Controller Object Commands /cx commit This command only applies to the Windows operating system. It commits all changes if a faster shutdown method is needed when running certain database applications. Linux file systems do not require this command since they have their own ways of notifying the controller to do clean up for shut down. /cx flush This command forces the controller to write all cached data to disk for the specified controller.
Chapter 2. CLI Syntax Reference Example: //localhost> /c0 update fw=/tmp/prom0006.img Warning: Updating the firmware can render the device driver and/or management tools incompatible. Before you update the firmware, it is recommended that you: 1) Back up your data. 2) Make sure you have a copy of the current firmware image so that you can roll back, if necessary. 3) Close all applications. Examining compatibility data from firmware image and /c0 ... Done.
Controller Object Commands To set up the rebuild schedule you want to use, follow this process: 1 Use the /cx show rebuild command to display the current schedule for rebuild tasks. (For details, see page 41.) 2 If any of the scheduled tasks do not match your desired schedule, use the /cx del rebuild command to remove them. (For details, see page 55.) 3 Use the /cx add rebuild command to create the rebuild schedule slots you want (described above.
Chapter 2. CLI Syntax Reference 4 Use the /cx set verify=enable command to enable the schedule (this enables all rebuild schedule slots). (For details, see page 56.) 5 Use the /cx/ux set autoverify=on command to turn on autoverify for each unit you want to follow the schedule. (For details, see page 70.) Note: If you do not enable autoverify for units or start a verification manually, your verify schedule will not run, even if it is enabled with the /cx set verify=enable command.
Controller Object Commands /cx del rebuild=slot_id This command removes the rebuild background task in slot slot_id. Example: //localhost> /c1 del rebuild=2 removes the rebuild background task in slot 2. Warning: If all time slots are removed, be sure to also disable the schedule. Otherwise the applicable background task will never occur /cx del verify=slot_id This command removes the verify background task in slot slot_id. Example: //localhost> /c1 del verify=3 removes verify background task in slot 3.
Chapter 2. CLI Syntax Reference The priority of rebuild versus I/O operations is specified with 1..5, where 1 is more resources and 5 the least. Setting the value to 1 gives maximum processing time to rebuilds rather than I/O. Setting the value to 5 gives maximum processing time to I/O rather than rebuilds. Enabling and disabling rebuild schedules is only for 9000 series controllers, however the rebuild rate (1..5) applies to all controllers.
Controller Object Commands /cx set ondegrade=cacheoff|follow This command is only for 9500S controllers. This command allows you to set a controller-based write cache policy. If the policy is set to cacheoff and a unit degrades, the firmware will disable the write-cache on the 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.
Chapter 2. CLI Syntax Reference 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 systems. For example, using the 2 TB default carvesize, a 3 TB unit will be configured into one 2 TB volume and one 1 TB volume. A 5 TB unit will be configured into two 2 TB volumes and one 1 TB volume. When auto-carve policy is set to off, all new units are created as a single large volume.
Controller Object Commands having to specify it as a spare. It also means that if you accidentally disconnect a drive (causing the controller to see it as a failed drive) and then reconnect it, the controller will automatically try to use it again. If the policy is off, spares are the only candidates for rebuild operations. Example: //localhost> /c0 set autorebuild=enable Setting Auto-Rebuild Policy on /c0 to enable ... Done.
Chapter 2. CLI Syntax Reference Example: //localhost>> /c0 set autodetect=off disk=all Setting Auto-Detect on /c2 to [off] for all disks/ports... 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 command (set autodetect=off) to disable automatic detection of the ports for staggered spin-up.
Unit Object Commands Unit Object Commands Unit Object commands provide information and perform actions related to a specific unit, such as /c0/u1 (unit 1 on controller 0). For example, you use logical disk object commands for such tasks as seeing the rebuild, verify, or initialize status of a unit, starting, stopping, and resuming rebuilds and verifies, and setting policies for the unit. Syntax /cx/ux show /cx/ux show attribute [attribute ...
Chapter 2. CLI Syntax Reference /cx/ux show This command shows summary information about the specified unit /cx/ux. If the unit consists of sub-units as with the case of RAID-1, RAID-5, RAID-10, RAID-50, then each sub-unit is further presented. If the Auto-Carving 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 information.
Unit Object Commands /cx/ux show attribute [attribute ...] This command shows the current setting of the specified attributes. One or many attributes can be requested. Specifying an invalid attribute will terminate the loop.
Chapter 2. CLI Syntax Reference /cx/ux show initializestatus This command reports the initializestatus (if any) of the specified unit. Example: //localhost> /c0/u5 show initializestatus /c0/u5 is not initializing, its current state is OK /cx/ux show name This feature only applies to 9000 series controllers. This command reports the name (if any) of the specified unit.
Unit Object Commands /cx/ux show serial This feature only applies to 9000 series controllers. This command reports the unique serial number of the specified unit. Example: //localhost> /c0/u5 show serial /c0/u5 Serial Number = 12345678901234567890 /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.
Chapter 2. CLI Syntax Reference /cx/ux show volumes This feature only applies to 9000 series controllers. This command reports the number of volumes in the specified unit. The number of volumes will normally be “1” unless auto-carving is enabled and/ or a boot LUN was specified. Example: //localhost> /c0/u0 show volumes /c0/u0 volume(s) = 1 /cx/ux show all This command shows the current setting of all above attributes.
Unit Object Commands u1-11 u1/v0 u1/v1 DISK Volume Volume OK - - - p11 - - 298.01 2047.00 1529.06 /cx/ux remove [noscan] [quiet] This command allows you to remove (previously called “export”) a unit. Removing a unit instructs the firmware to 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 operating system of this change.
Chapter 2. CLI Syntax Reference Example of interactive mode: //localhost> /c0/u0 del Deleting /c0/u0 will cause the data on the unit to be permanently lost. Do you want to continue ? Y|N [N]: /cx/ux start rebuild disk=p [ignoreECC] This command allows you to rebuild a degraded unit using the specified disk=p. Rebuild only applies to redundant arrays such as RAID 1, RAID 5, RAID 6, RAID 10, and RAID 50. During rebuild, bad sectors on the source disk will cause the rebuild to fail.
Unit Object Commands Table 9: Supported RAID (Logical Unit) Types for Verification Model R0 R1 R5 R6 R10 R50 Single Spare 9000a Yes Yes Yes N/A Yes Yes Yes Yes 9650SE Yes Yes Yes Yes Yes Yes Yes Yes a. Models 9500S, 9550SX, and 9590SE When you issue this command, the specified verify will begin if schedules are disabled; otherwise it will pause until the next scheduled verify. Verify will also pause if a rebuild or initialization is currently in progress.
Chapter 2. CLI Syntax Reference /cx/ux flush This command allows you to flush the write cache on the specified unit /ux associated with controller /cx. Note that this command does not apply to spare unit types. /cx/ux set autoverify=on|off This feature only applies to 9000 series controllers. This command allows you to turn on and off the autoverify operation on a specified unit /cx/ux during allocated schedule windows. You can use the show verify command to display the existing schedule windows.
Unit Object Commands /cx/ux set identify=on|off This feature only applies to 9000 series SX/SE/SA model controllers. This feature requires an enclosure that uses an integrated AMCC/3ware CCU (chassis control unit), such as the 3ware Sidecar, or a chassis from a thirdparty vendor. (Check the 3ware web site for a list of chassis vendors that support enclosure services, as they become available.) For additional information about enclosure-related commands, see “Enclosure Object Commands” on page 91.
Chapter 2. CLI Syntax Reference /cx/ux set qpolicy=on|off This feature only applies to 9000 series SX/SE/SA model controllers. This command sets the queue policy of the firmware. If the queue policy is on, the firmware utilizes the drive’s queueing policy. If any drives do not support a queueing policy, this policy will have no effect on those drives. For a spare unit, drive queuing is not meaningful or applicable.
Unit Object Commands • Incoming FUA (Force Unit Access) host requests will be honored. If you set the storsave policy to perform, a confirmation 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 provides better performance than protect mode but less performance than perform mode.
Chapter 2. CLI Syntax Reference The destination unit must use all source disks and potentially augment the number of disks in the disk=p:-p disk list. Unspecified parameters are assigned the default values (stripe size of 64K, write cache enabled, autoverify 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 destination unit has a type of single.
Unit Object Commands disk=p:-p.. consists of a list of ports or VPorts (disks) to be used in addition to the source disks in the construction of the destination unit. One or more ports can be specified. Multiple ports can be specified using a colon (:) or a dash (-) as port index separators. A dash indicates a range and can be mixed with colons. For example disk=0:1:2-5:9:12 indicates port or VPort 0, 1, 2 through 5 (inclusive), 9 and 12.
Chapter 2. CLI Syntax Reference Table 12: Supported Stripe Sizes Model R0 R1 R5 R6 R10 Spare R50 Single 7/8000 64 N/A 64 N/S 64 N/A N/S N/S N/A 16 N/S 9000a 9650SE and 9690SA 128 128 256 256 512 512 1024 1024 16 16 N/S 16 64 64 N/S 64 64 256 256 N/S 256 256 16 N/A N/A 16 64 64 256 256 16 64 N/A 16 64 64 256 256 N/S a.
Unit Object Commands then use CLI commands to ‘remove’ and ‘rescan’ the unit so that the operating system can see the new capacity, and then remount the unit. For details see “/cx/ux remove [noscan] [quiet]” on page 67 and “/cx rescan [noscan]” on page 50. You may also need to resize the file system or add a new partition. For instructions, consult the documentation for your operating system. Warning: It is important that you allow migration to complete before adding drives to the unit.
Chapter 2. CLI Syntax Reference p3 p4 p5 p6 p7 p8 p9 p10 p11 OK OK OK OK OK OK NOT-PRESENT OK OK u0 u2 u3 u0 u3 u3 u3 149.05 149.05 149.05 149.05 149.05 149.05 149.05 149.
Port Object Commands Port Object Commands Port Object Messages are commands that provide information and perform actions related to a specific disk, attached to a port (or virtual port), such as / c0/p0. You use port object commands for such tasks as seeing the status, model, or serial number of the drive. Syntax /cx/px show /cx/px show attribute [attribute ...
Chapter 2. CLI Syntax Reference The VPort number provides a handle by which to identify the drive, even though the drive may not be directly attached to the controller. To find the Block and Serial information, use the specific show attribute command (/cx/px show capacity or /cx/px show serial), or the show all command. /cx/px show attribute [attribute ...] This command shows the current setting of the given attributes on the specified port or drive. One or many attributes can be requested.
Port Object Commands /cx/px show firmware This command displays the firmware version of the drive attached to the specified port. Example: //localhost> /c0/p5 show firmware /c0/p5 Firmware Version = 65.13G65 /cx/px show identify This command only applies to 9000 series SX/SE/SA 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.
Chapter 2. CLI Syntax Reference /cx/px show ncq This command only applies to 9000 series SX/SE/SA model controllers. This command displays the NCQ (Native Command Queueing) information for the drive attached to the specified port, including whether NCQ is supported by the drive, and whether it is enabled at the drive. For queuing to be used, it must be enabled for the unit and supported by the drive. Queuing information is not available for SAS drives.
Port Object Commands /cx/px show status This command displays the status of the drive attached to the specified port. (Definitions of the drive statuses are available in the 3ware Serial ATA RAID Controller User Guide.) Example: //localhost> /c0/p5 show status /c0/p5 Status = OK /cx/px show all This command shows the current setting for all port-related attributes: status, model, serial, firmware, capacity, and smart.
Chapter 2.
Phy Object Commands /cx/px set identify=on|off This command applies only to 9000 series SX/SE/SA 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 command is equivalent to “/cx/ex/slotx set identify=on|off” on page 95. Example: //localhost> /c0/p5 set identify=on Setting Port Identify on /c0/p5 to [on] ... Done.
Chapter 2. CLI Syntax Reference BBU Object Commands BBU (Battery Backup Unit) Object Commands are commands that provide information and perform actions related to a specific BBU installed on a specific controller, such as /c0/bbu. This object is only available on 9000 series controllers on which a BBU is actually installed. (The BBU is not supported on 9590SE-4ME.) Syntax /cx/bbu show (9000 series only) /cx/bbu show attribute [attribute ...
BBU Object Commands /cx/bbu show attribute [attribute ...] This command shows the current setting of the given attribute(s) on the BBU board. One or many attributes can be specified. Specifying an invalid attribute will terminate the loop. Possible attributes are: batinst, bootloader, cap, fw, lasttest, pcb, ready, status, serial, temp, volt. /cx/bbu show batinst This command shows the date when the current battery was installed. /cx/bbu show bootloader This command shows the BBU's boot loader version.
Chapter 2. CLI Syntax Reference /cx/bbu show serial This command shows the BBU serial number. /cx/bbu show status This command shows the status of the BBU. Possible values are: Testing. A battery test is currently in progress. This 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 the RAID controller is also disabled.
BBU Object Commands /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 volt This command shows the voltage status of the battery. The status can be OK, HIGH, LOW, TOO-HIGH, and TOO-LOW.
Chapter 2. CLI Syntax Reference /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 re-enabled. Note: Once started, the test can not be terminated before it completes.
Enclosure Object Commands Enclosure Object Commands Enclosure object commands provide information and perform actions related to a specific enclosure, such as /c0/e0 and its elements, such as /c0/e0/slot0. Enclosure object elements include slot, fan, and temperature sensor elements. These commands are supported on 9690SA controllers. Syntax /cx/ex show /cx/ex show attribute [attribute ...
Chapter 2.
Enclosure Object Commands /cx/ex/ show diag=helptext This command is used with the 9690SA controller. This command allows you to view the enclosure diagnostic log. What is reported by this log will vary depending upon the manufacturer of the enclosure.The enclosure diagnostic log may be requested by 3ware Customer Support to help troubleshoot problems on your controller. /cx/ex show slots This command is used with the 9690SA controller.
Chapter 2. CLI Syntax Reference The maximum temperature for successful use of a drive should be noted in the documentation for the drive.
Enclosure Object Commands /cx/ex/slotx show identify This command is used by 9690SA controllers. This command shows the identify status of the specified slot. The status can be either on or off. Example: //localhost> c0/e0/slot1 show identify /e0/slot1 Identify status = on /cx/ex/slotx set identify=on|off This command is used by 9690SA controllers. This command causes the slot to be identified by blinking the LED associated with it, or turns off identification of the LED for this slot.
Chapter 2. CLI Syntax Reference /cx/ex/fanx set identify=on|off This command is used by 9690SA controllers. This command causes the fan to be identified by blinking the LED associated with it, or turns off identification of the LED for this fan. Setting identify to on will cause the LED associated with that fan to blink. Example: //localhost> c0/e0/fan1 set identify=on Sending Identify request to Fan c0/e0/fan1 to [on] ... Done. /cx/ex/pwrsx show This command is used by the 9690SA controller.
Enclosure Object Commands /cx/ex/pwrsx set identify=on|off This command is used by 9690SA controllers. This command causes the power supply to be identified by blinking the LED associated with it, or turns off identification of the LED for this power supply. Setting identify to on will cause the LED associated with that power supply to blink. Example: //localhost> c0/e0/pwrs1 set identify=on Sending Identify request to Power Supply c0/e0/pwrs1 to [on] ... Done.
Chapter 2. CLI Syntax Reference Setting identify to on will cause the LED associated with that temp sensor to blink. Example: //localhost> c0/e0/temp1 set identify=on Sending Identify request to Temp Sensor c0/e0/temp1 to [on] ... Done. Help Commands The Help commands provides brief on-line help. 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 100.
Help Commands [nocache][group=<3|4|5|6|7|8|9|10|11|12|13|14|15|16>] [autoverify][ignoreECC] [name=string (9000 series)] [storsave=(9KSX/SE/SA only)] RaidType={raid0, raid1, raid5, raid6 (9650SE), raid10, raid50, single, spare} /cx add rebuild=ddd:hh:duration (9000 series) /cx add verify=ddd:hh:duration (9000 series) /cx add selftest=ddd:hh (9000 series) /cx del rebuild=slot_id /cx del verify=slot_id /cx del selftest=slot_id /cx /cx /cx /cx /cx /cx (9000 series) (9000 series
Chapter 2. CLI Syntax Reference SX/SE/SA only)|serial|ondegrade (9500S only)|pcb| pchip|spinup|stagger|unitstatus| /cx show all where all means attributes and configurations. /cx show diag /cx show alarms [reverse] /cx show rebuild (9000 only) /cx 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 the following.
Help Commands help flush This command provides specific flush-related help, illustrating various ways to use the flush command. See the section “Shell Object Commands” on page 24 for more information. help rescan This command provides specific rescan related help, illustrating various ways to use the rescan command. See the section “Shell Object Commands” on page 24 for more information. help update This command provides specific update-related help.
Chapter 2. CLI Syntax Reference help /cx/ux This command provides specific unit /cx/ux related help, illustrating various commands to use on a unit /cx/ux. See the section “Unit Object Commands” on page 61 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 79 for more information.
Command Logging help /cx/ex/pwrsx This command provides specific power supply /cx/ex/pwrsx related help, illustrating various ways to use the /cx/ex/pwrsx command. See the Enclosure Element Power Supply section for more. Command Logging This feature logs controller commands from both CLI and 3DM2 into a file. You may be asked to supply this logfile to tech support for troubleshooting.
Chapter 2. CLI Syntax Reference 0 If you 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 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.
