Command Line Interface Supports the 9000 Series (9500S, 9550SX, 9590SE, 9650SE) PN: 720-0145-00 October 2006 CLI Guide 3ware® Serial ATA RAID Controller
Copyright ©2003-2006 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 numdrives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 /cx show numports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 /cx show numunits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 /cx show ctlbus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 /cx show exportjbod . . . . . . . . .
/cx/ux show serial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . /cx/ux show qpolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . /cx/ux show storsave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . /cx/ux show identify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . /cx/ux show autoverify . . . . . . . . . . . .
/cx/bbu test [quiet] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . /cx/bbu enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . /cx/bbu disable [quiet] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enclosure Object Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . /ex show . . . . . . . . . . . . . . . . . . . .
About this CLI Guide 3ware Serial ATA Controller CLI Guide provides instructions for configuring and maintaining your 3ware controller using 3ware’s command line interface (CLI). Table 1: Sections in this CLI Guide Chapter Description 1. Introduction to 3ware Command Line Interface Installation, features, concepts 2.
1 Introduction to the 3ware Command Line Interface The 3ware SATA RAID Controller Command Line Interface (CLI) for Linux, Windows, and FreeBSD is provided to manage 7000, 8000, and 9000-series 3ware ATA and Serial ATA RAID controllers. Multiple 3ware RAID controllers can be managed using the CLI via a command line or script. Note: Some CLI commands are supported only for particular models of 3ware RAID 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 19. Supported Operating Systems The 3ware CLI is supported under the following operating systems: • Windows®.
Chapter 1. Introduction to the 3ware Command Line Interface Installing the 3ware CLI Warning! If you are using 3DM, as opposed to 3DM2, AMCC does not recommend installing both 3DM and CLI on the same system. Conflicts may occur. For example, if both are installed, alarms will be captured only by 3DM. You should use either CLI or 3DM to manage your 3ware RAID controllers. This is not an issue for 3DM2. It can be installed with CLI.
Installing the 3ware CLI If you are uncertain whether you have the correct permissions, contact your network administrator. To start CLI, do one of the following: • Start the 3ware CD and at the 3ware Escalade menu, click Run CLI. • Or, open a console window, change to the directory where tw_cli is located, and at the command prompt, enter tw_cli • OR, double-click the CLI icon in a folder. The CLI prompt is displayed in a DOS console window.
Chapter 1. Introduction to the 3ware Command Line Interface Working with 3ware CLI You can work with the 3ware CLI in different ways: • • • Interactively, entering commands at the main prompt As a series of single commands By creating a script—an input file with multiple commands The next few topics shows examples of these different methods.
Working with 3ware CLI Using a single command with output You can use 3ware CLI with line arguments, processing a single command at a time. To do so, simply enter the command and the arguments. Single commands can be useful when you want to perform 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 Example tw_cli /c0 show diag > /tmp/3w_diag.
Chapter 1. Introduction to the 3ware Command Line Interface 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.
Understanding RAID Levels and Concepts Understanding RAID Levels and Concepts 3ware RAID controllers use RAID (Redundant Array of Inexpensive Disks) to increase your storage system’s performance and provide fault tolerance (protection against data loss).
Chapter 1. Introduction to the 3ware Command Line Interface • Array Roaming. The process of removing a unit from a controller and putting it back later, either on the same controller, or a different one, and having it recognized as a unit. The disks may be attached to different ports than they were originally attached to, without harm to the data. For definitions of other terms used throughout the documentation, see the “Glossary”.
Understanding RAID Levels and Concepts 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 ?). This gives your system fault tolerance by preserving the data on one drive if the other drive fails. Fault tolerance is a basic requirement for critical systems like web and database servers.
Chapter 1. Introduction to the 3ware Command Line Interface Figure 3. RAID 5 Configuration Example RAID 6 RAID 6 requires a 3ware 9650SE 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.
Understanding RAID Levels and Concepts 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 ?). 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.
Chapter 1. Introduction to the 3ware Command Line Interface 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.
Understanding RAID Levels and Concepts 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. Single drives are not fault tolerant and therefore not recommended for high availability systems unless additional precautions are taken to prevent system hangs and data loss.
Chapter 1. Introduction to the 3ware Command Line Interface 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.
Understanding RAID Levels and Concepts Table 3: Possible Configurations Based on Number of Drives # Drives Possible RAID Configurations 3 RAID 0 RAID 1 with hot spare RAID 5 4 RAID 5 with hot spare RAID 10 Combination of RAID 0, RAID 1, single disk 5 RAID 6 RAID 5 with hot spare RAID 10 with hot spare Combination of RAID 0, RAID 1, hot spare, single disk 6 or more RAID 6 RAID 6 with hot spare RAID 50 Combination of RAID 0, 1, 5, 6,10, hot spare, single disk Using Drive Capacity Efficiently To mak
Chapter 1. Introduction to the 3ware Command Line Interface Table 4: Drive Capacity RAID Level Capacity RAID 50 (number of drives - number of groups of drives) X (capacity of the smallest drive) 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.
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. 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.
Chapter 2.
Syntax Overview Table 5: Common Tasks Mapped to CLI Commands Task CLI Command Page Enable/disable autoverify /cx/ux set autoverify 68 Identify all drives that make up a unit by blinking associated LEDs /cx/ux set identify 64 Locate drive by blinking an LED /cx/px set identify 81 Check if LED is set to on or off /cx/px show identify 78 View information for specific drive /cx/px show 77 View the status of specific drive /cx/px show status 78 Check on charge and condition of battery /cx/
Chapter 2. CLI Syntax Reference 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.
Shell Object Commands 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 91.
Chapter 2. CLI Syntax Reference //hostname specifies the root of host hostname. .. specifies one level up (the parent object). / specifies the root at the current focused hostname. ./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..
Shell Object Commands background tasks. (Definitions of the unit statuses are available in the 3ware Serial ATA RAID Controller User Guide.) For a system with an enclosure unit that includes support for an EPCT (Enclosure Port Configuration Table), applicable firmware and software, and an appropriate controller (9550SX, 9590SE, or 9650SE), a global view of the environment also includes summary information about detected enclosures.
Chapter 2. CLI Syntax Reference show alarms [reverse] This command shows the alarms or AEN messages of all controllers in the system. The default is to display the most recent message first. The reverse attribute displays the most recent message last. show diag This command shows the diagnostic information of all controllers in the system. show rebuild This command displays all rebuild schedules for the 9000 controllers in the system.
Shell Object Commands show verify This command displays all verify schedules for the 9000 controllers in the system.
Chapter 2. CLI Syntax Reference flush This command sends a flush command to all 3ware controllers in the system. For more information, see “/cx flush” on page 44. rescan This command sends a rescan command to all 3ware controllers in the system. For more information, see “/cx rescan [noscan]” on page 43. commit This command sends a commit command to all 3ware controllers in the system. For more information, see “/cx commit” on page 44.
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 attribute [attribute ...
Chapter 2. CLI Syntax Reference /cx /cx /cx /cx set set set set autorebuild=on|off (9550SX, 9590SE, 9650SE) autodetect=on|off disk=|all verify=enable|disable|1..5 (9000 only) selftest=enable|disable [task=UDMA|SMART](9000 only) /cx /cx /cx /cx /cx /cx flush update fw=filename_with_path [force] (9000 only) commit (Windows only. Also known as shutdown) start mediascan (7000/8000 only) stop mediascan (7000/8000 only) rescan [noscan] (Does not import non-JBOD on 7000/8000 models.
Controller Object Commands backup the controller cache in the event of power loss), temperature, voltage, readiness, and so forth. Additional attributes about controllers, units, ports and disks can be obtained by querying for them explicitly. For details, see the other show subcommands. Typical output looks like: //localhost> /c2 show Unit UnitType Status %RCmpl %V/I/M Stripe Size(GB) Cache AVrfy --------------------------------------------------------------------------u0 RAID-5 OK 64K 596.
Chapter 2. CLI Syntax Reference /cx show driver This command reports the device driver version associated with controller /cx. Example: //localhost> /c0 show driver /c0 Driver Version = 2.x /cx show model This command reports the controller model of controller /cx. Example: //localhost> /c0 show model /c0 Model = 9500-x /cx show firmware This command reports the firmware version of controller /cx. Example: //localhost> /c0 show firmware /c0 Firmware Version = FE9X 3.03.06.
Controller Object Commands /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 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.
Chapter 2. CLI Syntax Reference /cx show numports This command reports the port capacity (number of physical ports) of the specified controller /cx. Example: //localhost> /c0 show numports /c0 Number of Ports = 12 /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).
Controller Object Commands /cx show spinup This feature only applies to 9000 series controllers. This command reports the number of concurrent disks that will spin up when the system is powered on, after waiting for the number of seconds specified with the set stagger command. Example: //localhost> /c0 show spinup /c0 Disk Spinup Policy = 1 /cx show stagger This feature only applies to 9000 series controllers. This command reports the time delay between each group of spinups at the power on.
Chapter 2. CLI Syntax Reference 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. When the autocarve policy is off, all newly created units will consist of one single volume.
Controller Object Commands /cx show autorebuild This feature only applies to 9550SX, 9590SE, and 9650SE model controllers. This command shows the Auto-Rebuild policy. If the policy is enabled, the firmware will select drives to use for rebuilding a degraded unit using the following priority order. For more information, see “/cx set autorebuild=on|off” on page 57. 1. Smallest usable spare. 2. Smallest usable unconfigured (available) drive. 3. Smallest usable failed drive.
Chapter 2. CLI Syntax Reference /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.
Controller Object Commands /cx show all This command shows the current setting of all of the following attributes on the specified controller: driver, model, memory, firmware, bios, monitor, serial, pcb, pchip, achip, numports, numunits, numdrives, unitstatus, drivestatus, allunitstatus, exportjbod, ondegrade, spinup, stagger and autocarve. Example: (where x represents the actual version number) //localhost> /c0 show all /c0 Driver Version = 3.
Chapter 2. CLI Syntax Reference /cx add type= disk= [stripe=Stripe] [noscan] [group=<3|4|5|6|7|8>] [nocache] [autoverify] [noqpolicy][ignoreECC] [name=string] [storsave=] This command allows you to create a new unit on the specified controller. You specify type, disks, and optional stripe size. By default the host operating system will be informed of the new block device, write cache will be enabled, and a storsave policy of protect will be set.
Controller Object Commands stripe=Stripe consists of the stripe size to be used. The following table illustrates the supported and applicable stripes on unit types and controller models. Stripe size units are in K (kilobytes). If no stripe size is specified, 64K is used by default, if applicable. If you need to change the stripe size after the unit is created, you can do so my migrating the unit.
Chapter 2. CLI Syntax Reference grouped into groups of 3 or 5 drives. For 16 disks, the disks can be grouped into groups of 4 or 8 drives. 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 application of this feature is to prevent the operating system from creating block special devices such as /dev/sdb and /dev/sdc as some implementations might create naming fragmentation and a moving target.
Controller Object Commands name=string attribute allows you to name the new unit. (This feature is for 9000 series and above controllers.) The string can be up to 21 characters and cannot contain spaces. 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 70 and “/cx/ux show name” on page 62.
Chapter 2. CLI Syntax Reference /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 and FreeBSD 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.
Controller Object Commands Given the above recommendation... Do you want to continue ? Y|N [N]: y Downloading the firmware from file /tmp/prom0006.img ... Done. The new image will take effect after reboot. force attribute is optional. If you include it, the compatibility checks are bypassed. /cx show alarms [reverse] Asynchronous events (also referred to as AENs or alarms) are originated by firmware and captured by their respective device drivers.
Chapter 2. CLI Syntax Reference /cx show diag This command extracts controller diagnostics suitable for technical support usage. Note that some characters might not be printable or rendered correctly (human readable). It is recommended to save the output from this command to a file, where it can be communicated to technical support 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.
Controller Object Commands A status of “disabled” indicates that the task schedule is disabled. In this case, the controller will not use the defined schedule timeslots. If the rebuild command is entered manually, rebuilding will start within 10 to 15 minutes. It will begin automatically if a 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.
Chapter 2. CLI Syntax Reference -------------------------------------------------------------------------u0 RAID-5 INITIALIZING 0 64K 521.466 ON 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.
Controller Object Commands //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 12:00am 24 hr(s) disabled A status of “disabled” indicates that the controller will not use the define
Chapter 2. CLI Syntax Reference 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.
Controller Object Commands 3 Use the /cx add rebuild command to create the rebuild schedule slots you want (described above.) 4 Use the /cx set rebuild=enable command to enable the schedule (this enables all rebuild schedule slots). (For details, see page 53.) Warning: If all time slots are removed, be sure to also disable the schedule. Otherwise the applicable background task will never occur.
Chapter 2. CLI Syntax Reference 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. Warning: If all time slots are removed, be sure to also disable the schedule.
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 models, however the rebuild rate (1..5) applies to all controllers.
Controller Object Commands /cx set exportjbod=on|off This command allows you to set the JBOD Export Policy to on or off. By default, exportjbod is off. If the JBOD export policy is off, CLI will not be able to create JBODs. During reboot, firmware will not export JBOD units to the operating system. The JBOD Export Policy is only supported on 9000-series controllers. Previous models did not have such a policy enforcement feature. A JBOD is an unconfigured disk attached to your 3ware RAID controller.
Chapter 2. CLI Syntax Reference /cx set stagger=nn This command is only for 9000 series controllers. This command allows you to set a controller-based Disk Spinup Stagger Time Policy that specifies the delay between spin-ups. The value must be a positive integer between 0 to 60 seconds. This policy, in conjunction with Disk Spinup Policy, specifies how the controller should spin up disks at boot time. The default is 6 seconds. /cx set autocarve=on|off This command is only for 9000 series controllers.
Controller Object Commands /cx set autorebuild=on|off This command is only for 9550SX , 9590SE, and 9650SE 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 failed drive.
Chapter 2. CLI Syntax Reference autodetect=on|off enables or disables automatic detection of drives on the controller’s ports for staggered spin-up. disk=|all specifies one or many disks (that is, drives or ports). If a port is empty (no drive is inserted), this feature is disabled for that port and its port number is shown. The example below shows that autodetect has been set to off to initiate staggered spin-up during hot-swapping, where port 3 was empty and ports 5 and 6 had drives inserted.
Unit Object Commands /cx stop mediascan This command applies only to 7000/8000 controllers. This commands stops a media scan operation on the specified controller /cx. (Media scans are started using /cx start mediascan.) 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).
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. Example: //localhost> /c0/u5 show name /c0/u5 name = Joe /cx/ux show serial This feature only applies to 9000 series controllers.
Unit Object Commands /cx/ux show storsave This feature only applies to 9550SX, 9590SE, and 9650SE model controllers. This command reports the storsave policy on the unit. For more information see, “/cx/ux set storsave=protect|balance|perform [quiet]” on page 70. Example: //localhost> /c0/u5 show storsave /c0/u5 Command Storsave Policy = protect /cx/ux show identify This feature only applies to 9550SX, 9590SE, and 9650SE model controllers. This command is related to the /cx/ux set identify command.
Chapter 2. CLI Syntax Reference /cx/ux show ignoreECC This feature only applies to 9000 series controllers. This command shows the current setting of the ignoreECC policy for the specified unit. Example: //localhost> /c0/u0 show ignoreECC /c0/u0 Ignore ECC policy = off /cx/ux show volumes This feature only applies to 9000 series controllers. This command reports the number of volumes in the specified unit.
Unit Object Commands Unit UnitType Status %RCmpl %V/I/M Port Stripe Size(GB) -----------------------------------------------------------------------u1 RAID-0 OK 64K 3576.06 u1-0 DISK OK p0 298.01 u1-1 DISK OK p1 298.01 u1-2 DISK OK p2 298.01 u1-3 DISK OK p3 298.01 u1-4 DISK OK p4 298.01 u1-5 DISK OK p5 298.01 u1-6 DISK OK p6 298.01 u1-7 DISK OK p7 298.01 u1-8 DISK OK p8 298.01 u1-9 DISK OK p9 298.01 u1-10 DISK OK p10 298.01 u1-11 DISK OK p11 298.01 u1/v0 Volume 2047.00 u1/v1 Volume 1529.
Chapter 2. CLI Syntax Reference /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) associated with the unit will be part of the free pool of managed disks. Warning: This is a destructive command and should be used with care.
Unit Object Commands /cx/ux start verify This command starts a background verification process on the specified unit /cx/ux. The following table shows the supported matrix as a function of the controller model and logical unit type. N/A (Not Applicable) refers to cases where the given logical unit type is not supported on that controller model.
Chapter 2. CLI Syntax Reference 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 67 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 specified unit /ux associated with controller /cx.
Unit Object Commands Table 10: Supported RAID Types for Caching Model R0 R1 R5 R6 R10 R50 Single JBOD Spare 7K/8K Yes Yes Yes N/A Yes N/A N/A Yes No 9000a Yes Yes Yes N/A Yes Yes Yes Yes No 9650SE Yes Yes Yes Yes Yes Yes Yes Yes No a. Models 9500S, 9550SX, and 9590SE The quiet attribute turns off interactive mode. /cx/ux set identify=on|off This feature only applies to 9550SX, 9590SE, and 9650SE model controllers.
Chapter 2. CLI Syntax Reference /cx/ux set name=string This command allows you to name the unit with an arbitrary name. You can use this name in conjunction with the unit serial number to cross-reference with the unit. The system does not check to ensure uniqueness of names, so be careful to assign different names to each unit. Note: The unit’s serial number is automatically assigned when the unit is created and is not changeable.
Unit Object Commands protect provides the maximum data protection among the controller settings. When storsave is set to protect mode, it means: • When the unit becomes degraded, the write cache will be disabled. • Write journaling is enabled. All data flushing from controller cache will be flushed to media. • Incoming FUA (Force Unit Access) host requests will be honored unless a BBU is installed and enabled, in which case, they will be ignored.
Chapter 2. CLI Syntax Reference /cx/ux migrate type=RaidType [disk=p:-p] [group=3|4|5|6|7|8] [stripe=Stripe] [noscan] [nocache] [autoverify] This feature only applies to 9000 series controllers. This command allows you to change the existing configuration of a unit with type=RaidType.
Unit Object Commands : Table 11: Valid Migration Paths Destination Source R0 R1 R5 R6 R10 R50 Single JBOD Spare R0 Yes No Yes Yes Yes Yes No No No R1 Yes No Yes Yes Yes Yes Yes No No R5 Yes No Yes Yes Yes Yes No No No R6 Yes No Yes Yes Yes Yes No No No R10 Yes No Yes Yes Yes Yes No No No R50 Yes No Yes Yes Yes Yes No No No Single Yes Yes Yes Yes Yes Yes No No No JBOD No No No No No No No No No Spare No No No No
Chapter 2. CLI Syntax Reference the best of net capacity and performance). For 15 disks, the disks can be grouped into groups of 3 or 5 drives. For 16 disks, the disks can be grouped into groups of 4 or 8 drives. Note that RAID-10 always has group=2, so an attribute specifying it’s group is not necessary. stripe=Stripe consists of the stripe size to be used. The following table illustrates the supported and applicable stripes on unit types and controller models. Stripe size units are in KB (kilobytes).
Unit Object Commands autoverify attribute enables the autoverify attribute on the unit that is to be migrated. For more details on this feature, see “/cx/ux set autoverify=on|off” on page 68. Migration Process In all cases of migration, the background migration process must be completed before the newly sized unit is available for use. You can continue using the original unit during this time. Once the migration is finished, a reboot will be required if you are booted from the unit.
Chapter 2. CLI Syntax Reference Example of migrate output The following is an example of how migrating units will be displayed. In this example, the report indicates that /c0/u3 is a migrating unit with 39% completion. The report also indicate that Source Unit su0 is of type RAID-1 and Destination Unit du0 is of type RAID-10. 3ware CLI> /c0 show Unit UnitType Status %RCmpl %V/I/M Stripe Size(GB) Cache AVrfy --------------------------------------------------------------------------u0 RAID-5 OK 64K 596.
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, 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 /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 model This command displays the model of the drive attached to the specified port.
Port Object Commands /cx/px show ncq This command applies only to 9550SX, 9590SE, and 9650SE 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.
Chapter 2. CLI Syntax Reference Example: //localhost> /c0/p5 Drive 10 00 01 0B 00 9A 96 BC 00 00 00 00 ... 00 00 00 00 /c0/p5 show SMART Data: 00 C8 C8 00 14 00 00 00 00 00 05 33 smart 00 00 00 00 00 00 03 07 00 00 04 32 00 64 64 7A 00 C8 C8 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 2C Note: The SMART data is not decoded. If the drive attached to the specified port is not present or if there are cabling problems reaching the drive, CLI will return an error.
Port Object Commands /cx/px remove [noscan] [quiet] This command allows you to remove (or export) a port (or drive) /cx/px. Exporting a port instructs the firmware to remove the specified port from its pool of managed ports, but does not retain the DCB (Disk Configuration Block) metadata on the attached disk. You can import (or re-introduce) the port by rescanning the controller. noscan is used to not inform the operating system of this change. The default is to inform the operating system.
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 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 status This command shows the status of the BBU. Possible values are: Testing. A battery test is currently in progress.
Chapter 2. CLI Syntax Reference /cx/bbu show batinst This command shows the date when the current battery was installed. /cx/bbu show lasttest This command shows the date the battery capacity was last measured. If the battery capacity test has never been run, then 'xx-xxx-xxxx' will be displayed. Note: The estimated BBU capacity hours displayed is based on the measurement taken during the last test. If you have not run the BBU test command for some time, this number can be misleading.
BBU Object Commands /cx/bbu show serial This command shows the BBU serial number. /cx/bbu show fw This command shows the BBU firmware version number. /cx/bbu show pcb This command shows the PCB revision number on the BBU. /cx/bbu show bootloader This command shows the BBU's boot loader version. /cx/bbu show all This command shows the current settings of all BBU-related attributes: ready, status, batinst, lasttest, volt, temp, cap, serial, fw, pcb, bootloader.
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 /e0 and its elements, such as /e0/slot0. Enclosure object elements include slot, fan, and temperature sensor elements. These commands are supported on the 9550SX, 9590SE, and 9650SE controllers, when an appropriate enclosure is used. The enclosure must use an integrated AMCC/3ware CCU (chassis control unit).
Chapter 2. CLI Syntax Reference Typical output looks like: //localhost> /e0 show Encl Controllers ------------------------e0 /c0 Fan Status ---------------------fan0 OK TempSensor Temperature ------------------------------temp0 24~C(75~F) Slot Status Port Identify ---------------------------------------------------slot0 OK /c0/p0 No slot1 OK /c0/p1 Yes slot2 NO-DEVICE No slot3 NO-DEVICE No /ex show attribute [attribute ...] This command shows the current setting of the given attribute(s).
Enclosure Object Commands /ex show slots This command reports the slots in enclosure /ex and their associated information. Example: //localhost> /e0 show slots Slot Status Port Identify ---------------------------------------------------slot0 OK /c0/p0 No slot1 OK /c0/p1 Yes slot2 NO-DEVICE No slot3 NO-DEVICE No /ex show fans This command lists the fans in enclosure /ex and shows their status. Possible statuses are OK and Unknown.
Chapter 2. CLI Syntax Reference /ex/slotx show This command shows information about the specified /slotx on the specified enclosure /ex. The slot name is followed by its status. If a slot has been inserted with a drive and no fault has been detected, the status is OK. If the slot is empty the status would indicate NO-DEVICE. The port that is correlated to the slot is indicated in the next column. If no device is found in the slot, that is indicated with a dash (-) in the Port column.
Help Commands /ex/fanx show This command shows the information about the specified fan element /fanx in the specified enclosure /ex. The fan name is followed by its status. If a fan is on and no fault has been detected, the status would indicate OK. Example: //localhost> /e0/fan0 show Fan Status ------------------fan0 OK /ex/tempx show This command shows the information about the specified temperature sensor element /fanx in the specified enclosure /ex.
Chapter 2. CLI Syntax Reference //localhost> help /cx /cx show /cx show attribute [attribute ...] where attribute is: achip|allunitstatus|autocarve|autorebuild (9550SX, 9590SE, 9650SE only)|bios|carvesize(9000 series)| ctlbus (9550SX, 9590SE, 9650SE)|driver|drivestatus| exportjbod|firmware|memory|model|monitor|numdrives| numports|numunits|pcb|pchip|serial|spinup|stagger| unitstatus|ondegrade(9000S only) /cx show all where all means attributes and configurations.
Help Commands Help with attributes As you work with specific objects or commands, you can also use ? to get help. For example: If you enter the command /c0 show and then need help on what specific attribute syntax is possible, you can use ? to get help as following: //localhost> /c0 show ? /cx show /cx show attribute [attribute ...
Chapter 2. CLI Syntax Reference Certain commands are qualified with constraints of controller type/model support. Please consult the tw_cli documentation for explanation of the controller-qualifiers. The controller-qualifiers of the Enclosure commands (/ex) also apply to Enclosure Element specific commands (e.g., /ex/elementx). Type help to get more details about a particular command. For more detail information see tw_cli's documentation.
Help Commands help focus This command provides specific focus related help, illustrating various 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 29 for more information.
Chapter 2. CLI Syntax Reference help /ex/fanx This command provides specific fan /ex/fanx related help, illustrating various ways to use the /ex/fanx command. See the section “Enclosure Object Commands” on page 87 for more information. help /ex/tempx This command provides specific temperature sensor /ex/tempx related help, illustrating various ways to use the /ex/tempx command. See the section “Enclosure Object Commands” on page 87 for more information.
Return Code For example, if you had a 3ware controller with an ID of 0, you could type this command: tw_cli /c0 show (c0 information displayed here) echo $? 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....
