Page 1
® 3ware Serial ATA RAID Controller Command Line Interface Supports the 9000 Series (9500S, 9550SX, 9590SE, 9650SE) PN: 720-0145-00 October 2006...
Page 2
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.
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 1. Introduction to 3ware Command Line Interface 2.
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: RAID controllers.
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”...
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.
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 • Or, open a console window, change to the directory where tw_cli is located, and at the command prompt, enter tw_cli •...
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.
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.
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 >>...
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). This section organizes information about RAID concepts and configuration levels into the following topics: •...
RAID levels 0, 1, 10 and 5 are the most popular. AMCC's 3ware controllers support RAID 0, 1, 5, 6, 10, 50, JBOD and Single Disk. The information below provides a more in-depth explanation of the different RAID levels.
Page 17
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 ?).
Page 18
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.
Page 19
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 ?).
Page 20
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.
Page 21
A JBOD (acronym for “Just a Bunch of Disks”) is an unconfigured disk attached to your 3ware RAID controller. JBOD configuration is no longer supported in the 3ware 9000 series. AMCC recommends that you use Single Disk as a replacement for JBOD, to take advantage of advanced features such as caching, OCE, and RLM.
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.
Page 23
Table 3: Possible Configurations Based on Number of Drives # Drives 6 or more Using Drive Capacity Efficiently To make the most efficient use of drive capacity, it is advisable to use drives of the same capacity. This is because the capacity of each drive is limited to the capacity of the smallest drive in the unit.
Page 24
Chapter 1. Introduction to the 3ware Command Line Interface Table 4: Drive Capacity RAID Level RAID 50 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.
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.
Page 26
Chapter 2. CLI Syntax Reference Table 5: Common Tasks Mapped to CLI Commands Task Enable/disable unit write cache Set the queue policy Set the storsave profile Unit Configuration Changes Change RAID level Change stripe size Expand unit capacity Delete a unit Remove a unit (export) Name a unit Controller Maintenance Tasks...
Table 5: Common Tasks Mapped to CLI Commands Task Enable/disable autoverify Identify all drives that make up a unit by blinking associated LEDs Port Tasks Locate drive by blinking an LED Check if LED is set to on or off View information for specific drive View the status of specific drive BBU Tasks...
Page 28
Chapter 2. CLI Syntax Reference 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.
Enclosure Object Commands. 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. all commands and attributes. For details, see “Help Commands” on page 91. Shell Object Commands Shell object commands are either applicable to all the controllers in the system (such as show, rescan, flush, commit), or redirect the focused object.
Chapter 2. CLI Syntax Reference //hostname specifies one level up (the parent object). specifies the root at the current focused hostname. ./object specifies the next level of the object. /c0/bbu hostname. Example: //localhost> focus /c0/u0 //localhost/c0/u0> //localhost/c0/u0> focus.. //localhost/c0> //localhost> focus u0 //localhost/c0/u0>...
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 verify This command displays all verify schedules for the 9000 controllers in the system. Example: //localhost> show verify Verify Schedule for Controller /c0 ======================================================== Slot -------------------------------------------------------- For additional information about verify schedules, see “/cx add verify=ddd:hh:duration” on page 51, and see the discussion of background tasks and schedules in 3ware Serial ATA RAID Controller User Guide.
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]”...
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.
Page 36
Chapter 2. CLI Syntax Reference /cx set autorebuild=on|off /cx set autodetect=on|off disk=<p:-p>|all /cx set verify=enable|disable|1..5 /cx set selftest=enable|disable [task=UDMA|SMART](9000 only) /cx flush /cx update fw=filename_with_path [force] (9000 only) /cx commit /cx start mediascan (7000/8000 only) /cx stop mediascan /cx rescan [noscan] (Does not import non-JBOD on 7000/8000 models.
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>...
Chapter 2. CLI Syntax Reference show driver This command reports the device driver version associated with controller /cx. Example: //localhost> /c0 show driver /c0 Driver Version = 2.x show model This command reports the controller model of controller /cx. Example: //localhost>...
show serial This command reports the serial number of the specified controller /cx. Example: //localhost> /c0 show serial /c0 Serial Number = F12705A3240009 show pcb This command reports the PCB (Printed Circuit Board) version of the specified controller /cx. Example: //localhost>...
Page 40
Chapter 2. CLI Syntax Reference 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 show numunits This command reports the number of units currently managed by the specified controller /cx.
Page 41
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 Example: //localhost> /c0 show spinup /c0 Disk Spinup Policy = 1 show stagger This feature only applies to 9000 series controllers.
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.
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”...
Page 44
Chapter 2. CLI Syntax Reference show allunitstatus This command presents a count of total and Not Optimal units managed by the specified controller /cx. For more about the meaning of Not Optimal, see “Shell Object Commands” on page 23. Example: //localhost>...
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: //localhost>...
Chapter 2. CLI Syntax Reference =<RaidType> add type Stripe [stripe= ] [noscan] [group= [nocache] [autoverify] [noqpolicy][ignoreECC] string [name= [storsave=<protect|balance|perform>] 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.
Page 47
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.
Page 48
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.
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 ("...
Chapter 2. CLI Syntax Reference 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.
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.
Chapter 2. CLI Syntax Reference 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).
Page 53
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 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 -------------------------------------------------------------------------- RAID-5 Port Status --------------------------------------------------------------- NOT-PRESENT NOT-PRESENT NOT-PRESENT NOT-PRESENT Name OnlineState --------------------------------------------------------------------------- show verify 9000 series controllers support background tasks and allow you to schedule a regular time when they occur. Verify is one of the supported background tasks. Rebuild and selftest are other background tasks for which there are separate schedules.
//localhost> /c1 show verify Verify Schedule for Controller /c1 ======================================================== Slot -------------------------------------------------------- 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.
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. //localhost> /c1 show selftest Selftest Schedule for Controller /c1 ======================================================== Slot --------------------------------------------------------...
Use the /cx add rebuild command to create the rebuild schedule slots you want (described above.) Use the /cx set rebuild=enable command to enable the schedule (this enables all rebuild schedule slots). (For details, see page 53.) Warning: Otherwise the applicable background task will never occur. ddd:hh:duration add verify= This command adds a new background verify task to be executed on the day...
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: Otherwise the applicable background task will never occur add selftest= This command adds a new background selftest task to be executed on the day ddd (where ddd is Sun, Mon, Tue, Wed, Thu, Fri, and Sat), at hour hh...
slot_id del rebuild= 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: Otherwise the applicable background task will never occur slot_id del verify= This command removes the verify background task in slot slot_id. Example //localhost>...
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.
Previous models did not have such a policy enforcement feature. A JBOD is an unconfigured disk attached to your 3ware RAID controller. AMCC recommends that you use Single Disk as a replacement for JBOD, to take advantage of features such as RAID level migration.
Chapter 2. CLI Syntax Reference set stagger= 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.
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.
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=<p:-p>|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.
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 logical disk object commands for such tasks as seeing the rebuild, verify, or initialize status of a unit, starting, stopping, and resuming rebuilds and...
Chapter 2. CLI Syntax Reference 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.
attribute show 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. Possible attributes are: initializestatus, name (9000 series), qpolicy (9550SX, 9590SE, and 9650SE only), rebuildstatus, serial (9000 series), status, storsave (9550SX, 9590SE, and 9650SE only), verifystatus, volumes (9000 series), autoverify (9000 series), cache, ignoreECC (9000 series), and identify (9550SX, 9590SE, and 9650SE only).
Chapter 2. CLI Syntax Reference 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 show name This feature only applies to 9000 series controllers. This command reports the name (if any) of the specified unit.
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 show identify This feature only applies to 9550SX, 9590SE, and 9650SE model controllers.
Chapter 2. CLI Syntax Reference 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 show volumes This feature only applies to 9000 series controllers.
Unit ------------------------------------------------------------------------ u1-0 u1-1 u1-2 u1-3 u1-4 u1-5 u1-6 u1-7 u1-8 u1-9 u1-10 u1-11 u1/v0 u1/v1 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.
Chapter 2. CLI Syntax Reference 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.
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. 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.
This feature only applies to 9550SX, 9590SE, and 9650SE model controllers. This feature requires an enclosure that uses an integrated AMCC/3ware CCU (chassis control unit). (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...
Chapter 2. CLI Syntax Reference set name= 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.
Page 77
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.
Chapter 2. CLI Syntax Reference migrate type= [group=3|4|5|6|7|8] [stripe= [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. You can make three types of changes: •...
Page 79
Table 11: Valid Migration Paths Source Single JBOD Spare disk=p:-p.. consists of a list of ports (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.
Page 80
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.
Page 81
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.
Page 82
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 completion. The report also indicate that Source Unit and Destination Unit 3ware CLI> /c0 show Unit UnitType ---------------------------------------------------------------------------...
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.
Chapter 2. CLI Syntax Reference 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 show model This command displays the model of the drive attached to the specified port.
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.
Note: page 90. Note: This feature requires an enclosure that uses an integrated AMCC/3ware CCU (chassis control unit). (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”...
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.
attribute /bbu show 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. /bbu show status This command shows the status of the BBU.
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 is time to replace the battery. (Contact AMCC to obtain a replacement battery.) /bbu show temp This command OK, HIGH, LOW, TOO-HIGH, and TOO-LOW.
/bbu show serial This command /bbu show fw This command /bbu show pcb This command /bbu show bootloader This command /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. Example: //localhost>...
Chapter 2. CLI Syntax Reference /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.
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). (Check the 3ware web site for a list of chassis vendors that support enclosure services, as they become available.) If you purchased an enclosure directly from a third-party...
Chapter 2. CLI Syntax Reference Typical output looks like: //localhost> /e0 show Encl ------------------------- ---------------------- fan0 TempSensor ------------------------------- temp0 Slot ---------------------------------------------------- slot0 slot1 slot2 slot3 attribute /ex show This command shows the current setting of the given attribute(s). One or many attributes can be requested.
/ex show slots This command reports the slots in enclosure /ex and their associated information. Example: //localhost> /e0 show slots Slot ---------------------------------------------------- slot0 slot1 slot2 slot3 /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.
/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>...
Page 98
Chapter 2. CLI Syntax Reference //localhost> help /cx /cx show /cx show attribute [attribute ...] 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 /cx show diag /cx show alarms [reverse] /cx show rebuild /cx show verify /cx show selftest /cx add type=<RaidType>...
This help command provide a table of contents, providing help with the overall navigation of the CLI commands. Typical output looks like the following. //localhost> help Copyright(c) 2004-2006 Applied Micro Circuits Corporation (AMCC). All rights reserved. AMCC/3ware CLI (version 2.x) Commands -------------------------------------------------------------- show...
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 <command>...
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 /c This command provides specific controller /cx related help, illustrating various commands associated with the controller /cx.
Chapter 2. CLI Syntax Reference help /e /fan 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 /e /temp This command provides specific temperature sensor /ex/tempx related help, illustrating various ways to use the /ex/tempx command.
Page 103
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 $? If you type: tw_cli /c7 show error: (CLI003) specified controller does not exist. echo $? This example fails (returns 1) because there is no controller 7.