Related Manuals for AMCC 720-0127-04
Summary of Contents for AMCC 720-0127-04
-
Page 1: Command Line Interface
3ware ® Serial ATA RAID Controller Command Line Interface Supports the 9000 Series (9500S, 9550SX, 9590SE) PN: 720-0127-04 April 2006... - Page 2 AMCC, 215 Moffett Park Drive, Sunnyvale, CA 94089. Trademarks 3ware, Escalade, and 3DM are all registered trademarks of AMCC. The 3ware logo, 3BM, StorSwitch, TwinStor, and R5 Fusion are all trademarks of AMCC. All other trademarks herein are property of their respective owners.
-
Page 3: Table Of Contents
Table of Contents About This Guide ......... . . 1 How this Guide is Organized . - Page 4 Chapter 3. /cx show numdrives ..........32 /cx show numports .
- Page 5 /cx/ux show storsave ..........57 /cx/ux show volumes .
- Page 6 Chapter 3. help show ........... . . 80 help flush .
- Page 7 [maint] rebuild cid uid pid_list [ignoreECC] ......103 [maint] rebuild cid uid pause ........103 [maint] rebuild cid uid resume .
- Page 8 Chapter 3. 3ware 9000 Series Serial ATA Controller CLI Guide...
-
Page 9: About This Guide
About This Guide 3ware 9000 Series Serial ATA 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 controller in your system. If you have not yet done so, see the user guide that came with your 3ware RAID controller for instructions. - Page 10 3ware 9000 Series Serial ATA Controller CLI Guide...
-
Page 11: Chapter 1. Introduction To The 3Ware Command Line Interface
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. All information contained in this document that describes Note: usage for the 3ware 9000 series products will not work with 3ware... -
Page 12: Supported Operating Systems
Chapter 1. Introduction to the 3ware Command Line Interface Supported Operating Systems Windows. Windows 2000, Windows XP, and Windows Server 2003, both 32-bit and 64-bit. Linux. Redhat, SuSE, both 32-bit and 64-bit. FreeBSD, both 32-bit and 64-bit. For specific versions of Linux and FreeBSD that are supported for the 3ware CLI, see the Release Notes. -
Page 13: Installing The 3Ware Cli
Installing the 3ware CLI 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. -
Page 14: Installing The 3Ware Cli On Linux And Freebsd
Chapter 1. Introduction to the 3ware Command Line Interface 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. -
Page 15: Working With 3Ware Cli
Working with 3ware CLI 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 This first section shows examples of each of these ways. -
Page 16: Using A Single Command With Output
Chapter 1. Introduction to the 3ware Command Line Interface At the CLI prompt, you can enter commands to show or act on 3ware controllers, units, and drives. For example, //localhost> show displays all controllers in the system and shows details about them, like this: Model Ports... -
Page 17: 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 >>... -
Page 18: Understanding Raid Concepts And Levels
Chapter 1. Introduction to the 3ware Command Line Interface Understanding RAID Concepts and Levels The next few pages introduce RAID concepts you may find useful. For additional information about installing and managing your 3ware controller, see the user guide that came with your 3wae RAID controller. 3ware controllers use a Redundant Array of Inexpensive Disks (RAID) to increase your storage system’s performance and provide fault tolerance (protection against data loss). -
Page 19: Available Raid Configurations
Understanding RAID Concepts and Levels Available RAID Configurations The following RAID levels and configurations are available for drives attached to a 3ware controller: RAID 0 RAID 1 RAID 5 RAID 10 RAID 50 Single Disk JBOD Hot Spare RAID 0 Provides striping, but no mirroring. - Page 20 Chapter 1. Introduction to the 3ware Command Line Interface Figure 2). 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 mission critical systems like web and database servers. 3ware uses a patented technology, TwinStor®, on RAID 1 arrays for improved performance during sequential read operations.
- Page 21 Understanding RAID Concepts and Levels 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 4). A minimum of four drives are required to use this technique.
-
Page 22: Determining What Raid Level To Use
Chapter 1. Introduction to the 3ware Command Line Interface Single drives are not fault tolerant and therefore not recommended for high availability systems unless additional precautions are take to prevent system hangs and data loss. JBOD A JBOD is an unconfigured disk attached to your 3ware RAID controller. 3ware recommends that you use Single Disk as a replacement for JBOD, to take advantage of advanced features such as RAID level migration (RLM). - Page 23 Understanding RAID Concepts and Levels Table 2: Possible Configurations Based on Number of Drives # Drives Possible RAID Configurations RAID 5 + hot spare RAID 10 Combination of RAID 0, RAID 1, single disk RAID 5 + hot spare RAID 10 + hot spare Combination of RAID 0, RAID 1, hot spare 6 or more RAID 50...
-
Page 24: Storsave Profiles
Chapter 1. Introduction to the 3ware Command Line Interface Support for Over 2 Terabytes Windows 2000, Windows XP, and Linux 2.4 do not currently recognize unit capacity in excess of 2 TB. If the combined capacity of the drives to be connected to a unit exceeds 2 Terabytes (TB), you can enable auto-carving using the set autocarve command. - Page 25 StorSave Profiles Table 4: StorSave Profile Definitions Protection (Default) Balanced Performance Enabled Disabled, if no BBU Disabled. [If BBU is present. [Enabled, if present, this Write Journaling BBU is present.] essentially disables the BBU for this unit.] Enabled Disabled Disabled Disable Cache on Degrade .
- Page 26 Chapter 1. Introduction to the 3ware Command Line Interface . In the event that a unit degrades, the Write cache disabled on degrade use of write cache can be disabled until the unit is rebuilt. Once the unit is rebuilt, you must enable the write cache manually using 3DM2, 3BM, or the CLI.
-
Page 27: Chapter 2. Primary Cli Syntax Reference
Primary CLI Syntax Reference Information contained throughout this chapter that describes Note: usage only for the 3ware 9000 series products does not work with 3ware 7000 or 8000 series controllers. This chapter provides detailed information about using the primary command syntax for the 3ware CLI. - Page 28 Chapter 2. Primary CLI Syntax Reference Table 5: Common Tasks Mapped to CLI Commands Task CLI Command Page Unit Configuration Tasks Create a new unit /cx add Create a hot spare /cx add Enable/disable unit write cache /cx/ux set cache Set the queue policy /cx/ux set qpolicy Set the storsave profile...
-
Page 29: Primary Syntax Overview
Primary Syntax Overview Table 5: Common Tasks Mapped to CLI Commands Task CLI Command Page Unit Maintenance Tasks Start a rebuild /cx/ux start rebuild Start a verify /cx/ux start verify Pause/resume rebuild /cx/ux pause rebuild and /cx/ux resume rebuild Stop verify /cx/ux stop verify Enable/disable autoverify /cx/ux set autoverify... - Page 30 Chapter 2. Primary CLI Syntax Reference Information about commands is organized by the object on which the commands act: Shell Object Commands. Shell object commands set the focus or provide information (such as alarms, diagnostics, rebuild schedules, and so forth) about all controllers in the system.
-
Page 31: Shell Object Commands
Shell Object Commands 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. Syntax focus object show [attribute [modifier]] alarms [reverse] diag rebuild verify selftest rescan... -
Page 32: Show
Chapter 2. Primary CLI Syntax Reference For example: //localhost> focus //elvis.amcc.com //elvis.amcc.com> //elvis.amcc.com> focus /c0/u0 //elvis.amcc.com/c0/u0> //elvis.amcc.com/c0/u0> focus.. //elvis.amcc.com/c0> //elvis.amcc.com/c0/> focus u0 //elvis.amcc.com/c0/u0> //elvis.amcc.com/c0> focus / //elvis.amcc.com> The focus command is available by default. You can disable focus by setting TW_CLI_INPUT_STYLE to old. -
Page 33: Show Ver
Shell Object Commands show ver This command will show the CLI and API version. Example: //localhost> show ver CLI Version = 2.00.00.0xx API Version = 2.00.00.0xx where xx is the actual version. See the Release Notes for details. show alarms [reverse] This command shows the alarms or AEN messages of all controllers in the system. -
Page 34: Show Verify
Chapter 2. Primary CLI Syntax Reference 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 Hour Duration Status -------------------------------------------------------- 11:00pm 4 hr(s) enabled enabled enabled enabled... -
Page 35: Flush
Shell Object Commands flush This command sends a flush command to all 3ware controllers in the system. For more information, see “/cx flush” on page 41. rescan This command sends a rescan command to all 3ware controllers in the system. For more information, see “/cx rescan [noscan]”... -
Page 36: Controller Object Commands
Chapter 2. Primary CLI Syntax Reference Controller Object Commands Controller object commands provide information and perform actions related to a specific controller, such as . 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. -
Page 37: Cx Show
Controller Object Commands /cx show This command shows summary information on the specified controller /cx. This information is organized into a report containing two to three parts: A Unit summary listing all present units A Port summary section listing of all ports and disks attached to them. A BBU summary section listing, if a BBU is installed on the controller. -
Page 38: Cx Show Attribute [Attribute
Chapter 2. Primary CLI Syntax Reference Typical output looks like: //localhost> /c0 show Unit UnitType Status %Cmpl Stripe Size(GB) Cache AVerify IgnECC ------------------------------------------------------------------------------------ RAID-1 149.05 RAID-5 298.22 SPARE 149.05 Port Status Unit Size Blocks Serial --------------------------------------------------------------- 149.05 GB 312581808 3JS0TF14 149.05 GB 312581808 3JS0TETZ... -
Page 39: Cx Show Model
Controller Object Commands /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 = FGXX 2.x /cx show bios This command reports the BIOS version of controller /cx. -
Page 40: Cx Show Pchip
Chapter 2. Primary CLI Syntax Reference /cx show pchip This command reports the PCHIP (PCI Interface Chip) version of the specified controller /cx. Example: //localhost> /c0 show pchip /c0 PCHIP Version = 1.x /cx show achip This command reports the ACHIP (ATA Interface Chip) version of the specified controller /cx. -
Page 41: Cx Show Ctlbus
Controller Object Commands /cx show ctlbus This feature only applies to 9550SX and 9590SE controllers. This command reports the controller host bus type, bus speed, and bus width. Example: //localhost> /c0 show ctlbus /c0 Controller Bus Type = PCIX /c0 Controller Bus Width = 64 bits /c0 Controller Bus Speed = 133 Mhz /cx show exportjbod This feature only applies to 9000 series controllers. -
Page 42: Cx Show Ondegrade
Chapter 2. Primary CLI Syntax Reference /cx show ondegrade This feature only applies to 9500S controllers. This command reports the cache policy for degraded units. If the ondegrade policy is “Follow Unit Policy,” a unit cache policy stays the same when the unit becomes degraded. -
Page 43: Cx Show Memory
Controller Object Commands /cx show memory This command reports the size of the memory installed on the controller. Note: The 9500S controllers ship with 128 MBytes of cache, yet only 112MB shows as memory installed. The other 16 MB is reserved for use by the controller. -
Page 44: Cx Show Allunitstatus
Chapter 2. Primary CLI Syntax Reference caused by an ECC error, SMART failure, or a device error. Rescanning the controller will clear the drive error status if the condition no longer exists. Example: //localhost> /c0 show unitstatus Unit UnitType Status %Cmpl Stripe Size(GB) -
Page 45: Cx Show All
Controller Object Commands /cx show all This command shows the current setting of all of the following attributes on the specified controller: driver, model, firmware, memory, bios, monitor, serial, pcb, pchip, achip, numports, numunits, numdrives, unitstatus, drivestatus, allunitstatus, exportjbod, ondegrade, spinup, autocarve, and stagger. -
Page 46: [Storsave=
Chapter 2. Primary CLI Syntax Reference =<RaidType> =<p:-p> Stripe /cx add type disk [stripe= <3|4|5|6> [noscan] [group= ] [nocache] [autoverify] string [ignoreECC] [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 and write cache will be enabled. - Page 47 Controller Object Commands Table 7: Supported Stripe Sizes (KB) Model JBOD Spare Single 7K/8K 1024 1024 group=3|4|5|6 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.
-
Page 48: Cx Rescan [Noscan]
Chapter 2. Primary CLI Syntax Reference unless there is a BBU (battery backup unit) or UPS (uninterruptable power supply) installed. autoverify attribute enables the autoverify attribute on the unit that is to be created. For more details on this feature, see “/cx/ux set autoverify=on|off” on page 61. -
Page 49: Cx Commit
Controller Object Commands Note: If you are adding new drives, add them physically before issuing the rescan commands. Hot swap carriers are required unless you first power- down the system to prevent system hangs and electrical damage. Example: //localhost> /c1 rescan Rescanning controller /c1 for units and drives ...Done Found following unit(s): [/c1/u3] Found following drive(s): [/c1/p7, /c1/p8]... -
Page 50: Cx Show Diag
Chapter 2. Primary CLI Syntax Reference Typical output looks like: tw_cli> /c1 show alarms reverse Ctl Date Severity Message ------------------------------------------------------------------------------------- [Fri Nov 28 04:26:31 2003] ERROR (0x04:0x0002): Degraded unit detected:unit=0, port=2 [Fri Nov 28 06:13:54 2003] INFO (0x04:0x000B): Rebuild started: unit=0 [Fri Nov 28 06:30:35 2003] INFO (0x04:0x003B): Background rebuild paused:unit=0 [Fri Nov 28 06:33:00 2003] ERROR... - Page 51 Controller Object Commands command displays the current rebuild background task show rebuild schedule as illustrated below. //localhost> /c1 show rebuild Rebuild Schedule for Controller /c1 ======================================================== Slot Hour Duration Status -------------------------------------------------------- 2:00pm 10 hr(s) disabled 7:00pm 18 hr(s) disabled disabled disabled disabled 1:00am...
- Page 52 Chapter 2. Primary CLI Syntax Reference 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. //localhost>...
-
Page 53: Cx Show Verify
Controller Object Commands /cx 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. Migrate and initialize are additional background tasks that follow the same schedule as rebuild. -
Page 54: Cx Show Selftest
Chapter 2. Primary CLI Syntax Reference /cx show selftest 9000 series controllers support background tasks and allow you to schedule a regular time when they occur. Selftest is one of the supported background tasks. Rebuild and verify are other background tasks for which there are separate schedules. Migrate and initialize are additional background tasks that follow the same schedule as rebuild. -
Page 55: Cx Add Rebuild=Ddd:hh:duration
Controller Object Commands ddd:hh:duration /cx add rebuild= This command adds a new background rebuild task to be executed on the day ddd (where ddd is Sun, Mon, Tue, Wed, Thu, Fri, and Sat), at the hour hh (range 0 .. 23), for a duration of duration (range 1 .. 24) hours. A maximum of seven rebuild tasks can be scheduled. -
Page 56: Cx Add Selftest=Ddd:hh
Chapter 2. Primary CLI Syntax Reference Setting Up a Verify Schedule Setting up a verify schedule requires several steps, and several different CLI commands in addition to /cx add verify. To set up the verify schedule you want to use, follow this process: Use the /cx show verify command to display the current schedule for verify tasks. -
Page 57: Cx Del Rebuild=Slot_Id
Controller Object Commands Setting Up a Selftest Schedule Setting up a selftest schedule requires several steps, and several different CLI commands in addition to /cx add selftest. To set up the selftest schedule you want to use, follow this process: Use the /cx show selftest command to display the current schedule for selftest tasks. -
Page 58: Cx Del Selftest=Slot_Id
Chapter 2. Primary CLI Syntax Reference slot_id /cx del selftest= This command removes (or unregisters) the selftest background task in slot slot_id. Example: //localhost> /c1 del selftest=3 Will remove selftest background task in slot 3. Warning: If all time slots are removed, be sure to also disable the schedule. -
Page 59: Cx Set Selftest=Enable|Disable [Task=Udma|Smart]
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. -
Page 60: Cx Set Stagger=Nn
Chapter 2. Primary CLI Syntax Reference Not all drives support staggered spinup. If you enable staggered spinup and have drives that do not support it, the setting will be ignored. /cx set stagger= This command is only for 9000 series controllers. This command allows you to set a controller-based Disk Spinup Stagger Time Policy. -
Page 61: /Cx Set Autorebuild=On|Off
Controller Object Commands /cx set autorebuild=on|off This command is only for 9550SX and 9590SE 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. -
Page 62: Unit Object Commands
Chapter 2. Primary CLI Syntax Reference Unit Object Commands Unit Object commands provide information and perform actions related to a specific unit, such as (unit 1 on controller 0). For example, you use /c0/u1 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. -
Page 63: Cx/Ux Show Attribute [Attribute
Unit Object Commands One application of the command is to see which sub-unit of a /cx/ux show degraded unit has caused the unit to degrade and which disk within that sub- unit is the source of degradation. Another application is to see the source and destination units during a migration. -
Page 64: Cx/Ux Show Rebuildstatus
Chapter 2. Primary CLI Syntax Reference /cx/ux show rebuildstatus This command reports the rebuildstatus (if any) of the specified unit. Examples //localhost> /c0/u5 show rebuildstatus /c0/u5 is not rebuilding, its current state is OK If the unit is in the process of migrating, the command will return the following: //localhost>... -
Page 65: Cx/Ux Show Qpolicy
Unit Object Commands /cx/ux show qpolicy This feature only applies to 9550SX and 9590SE model controllers. This command reports the queue policy of the firmware. If the queue policy is on, the firmware utilizes the drive queueing policy. If some drives in the unit do not support a queueing policy, this policy will have no effect on those drives. -
Page 66: Cx/Ux Export [Noscan] [Quiet]
Chapter 2. Primary CLI Syntax Reference Example: //localhost> /c0/u1 show all /c0/u1 status = OK /c0/u1 is not rebuilding, its current state is OK /c0/u1 is not verifying, its current state is OK /c0/u1 is not initializing, its current state is OK /c0/u1 volume(s) = 2 /c0/u1 name = 1234567 /c0/u1 serial number = C6CPR7JMF98DA8001DF0... -
Page 67: Cx/Ux Del [Noscan] [Quiet]
Unit Object Commands /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. -
Page 68: Cx/Ux Start Verify
Chapter 2. Primary CLI Syntax Reference /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. -
Page 69: Cx/Ux Flush
Unit Object Commands /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. -
Page 70: /Cx/Ux Set Ignoreecc=On|Off
Chapter 2. Primary CLI Syntax Reference /cx/ux set ignoreECC=on|off This feature only applies to 9000 series controllers. This command allows you to set the ignoreECC policy for a given unit. When ignoreECC policy is set to off, if a rebuild process encounters bad sectors on the source disk, the rebuild will fail. - Page 71 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.
-
Page 72: Cx/Ux Migrate Type=Raidtype [Disk=P:-P]
Chapter 2. Primary CLI Syntax Reference RaidType p:-p /cx/ux migrate type= [disk= Stripe [group=3|4|5|6] [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. - Page 73 Unit Object Commands The following table illustrates valid migration paths: Table 11: Valid Migration Paths Destination Source Single JBOD Spare 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.
- Page 74 Chapter 2. Primary CLI Syntax Reference arrays. With 12 disks, specifying 3 will create four RAID 5 arrays under the RAID 0 level. With only 6 disks a grouping of 6 is not allowed, as you would basically be creating a RAID 5. The default RAID 50 grouping varies, based on number of disks.
- Page 75 Unit Object Commands depending on your operating system, you may need to first unmount the unit, then use CLI commands to ‘export’ and ‘rescan’ the unit so that the operating system can see the new capacity, and then remount the unit. For details see “/ cx/ux export [noscan] [quiet]”...
- Page 76 Chapter 2. Primary CLI Syntax Reference NOT-PRESENT NOT-PRESENT NOT-PRESENT NOT-PRESENT 3ware CLI> /c0/u0 show Unit UnitType Status %Cmpl Port Stripe Size(GB) Blocks ----------------------------------------------------------------------- Migrator MIGRATING RAID-1 74.4951 156227584 su0-0 DISK 74.4951 156227584 su0-1 DISK 74.4951 156227584 RAID-10 148.99 312455168 du0-0 RAID-1 du0-0-0 DISK...
-
Page 77: Port Object Commands
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 . You use /c0/p0 port object commands for such tasks as seeing the status, model, or serial number of the drive. -
Page 78: Cx/Px Show Model
Chapter 2. Primary CLI Syntax Reference /cx/px show model This command displays the model of the drive attached to the specified port. Example: //localhost> /c0/p5 show model /c0/p5 Model = WDC WD1600BB-00DAA0 /cx/px show serial This command displays the serial number of the drive attached to the specified port. -
Page 79: Cx/Px Show Ncq
Port Object Commands /cx/px show ncq This command applies only to 9550SX and 9590SE 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. -
Page 80: Cx/Px Show All
Chapter 2. Primary CLI Syntax Reference Example: //localhost> /c0/p5 show smart /c0/p5 Drive SMART Data: 10 00 01 0B 00 C8 C8 00 00 00 00 00 00 00 03 07 00 9A 96 BC 14 00 00 00 00 00 04 32 00 64 64 7A 00 00 00 00 00 00 05 33 00 C8 C8 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 2C The SMART data is not decoded. -
Page 81: Cx/Px Export [Noscan] [Quiet]
Port Object Commands /cx/px export [noscan] [quiet] This command allows you to export (or remove) 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. -
Page 82: Bbu Object Commands
Chapter 2. Primary 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. -
Page 83: Cx/Bbu Show Attribute [Attribute
BBU Object Commands attribute attribute /cx/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. -
Page 84: Cx/Bbu Show Lasttest
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.) /cx/bbu show temp This command shows the temperature status of the battery. -
Page 85: Cx/Bbu Show Pcb
BBU Object Commands /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 attribute: ready, status, batinst, lasttest, volt, temp, cap, serial, fw, pcb, bootloader. -
Page 86: Cx/Bbu Enable
Chapter 2. Primary CLI Syntax Reference /cx/bbu enable This command enables BBU detection on the controller. If the BBU is Ready, the controller will utilize BBU functionality in the event of a power failure. /cx/bbu disable [quiet] This command disables BBU detection on the controller. When disabled, the controller ignores the existence of the BBU and will show no BBU is installed even if a BBU is physically attached. -
Page 87: Help With Attributes
Help Commands /cx add type=<RaidType> disk=<p:-p..> [stripe=<Stripe>] [noscan] [nocache] [group=<3|4|5|6>] [autoverify] [ignoreECC] [name=string (9000 only)] [storsave=<protect|balance|perform[quiet]>(9550SX and 9590SE only)] RaidType = { raid0, raid1, raid5, raid10, raid50, single, spare, JBOD (7000/8000 only)} /cx add rebuild=ddd:hh:duration (9000 only) /cx add verify=ddd:hh:duration (9000 only) /cx add selftest=ddd:hh (9000 only) -
Page 88: Help
(Details about help commands for the new command syntax are included on the next couple of pages. For details about help commands for the legacy syntax, see “help” on page 115.) //localhost> help Copyright(c) 2004, 2005 Applied Micro Circuits Corporation (AMCC). All rights reserved. AMCC/3ware CLI (version 2.x) Commands... -
Page 89: Help Flush
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 23 for more information. help rescan This command provides specific rescan related help, illustrating various ways to use the rescan command. -
Page 90: Environment Variables
Chapter 2. Primary CLI Syntax Reference Environment Variables There are two environment variables: TW_CLI_INPUT_STYLE (described below) TW_CLI_STYLE is a reporting style variable for the legacy syntax. For details, see “Screen Reporting Style” on page 57. By default, TW_CLI_INPUT_STYLE variable is set to new. If you want to disable the focus command, set the TW_CLI_INPUT_STYLE variable to old. - Page 91 Return Code 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 tw_cli /c7 show error..if errorlevel 1 echo 1 This example fails (returns 1) because there is no controller 7. www.3ware.com...
- Page 92 Chapter 2. Primary CLI Syntax Reference 3ware 9000 Series Serial ATA Controller CLI Guide...
-
Page 93: Chapter 3. Legacy Cli Syntax Reference
Legacy CLI Syntax Reference This chapter provides detailed information about using the legacy syntax for the 3ware CLI, using the commands Info, Maint, Sched, Alarms, Set, and Help. Support for the legacy syntax is available only for a limited time. Information contained in this document that describes usage Note: only for the 3ware 9000 series products does not work with 3ware... -
Page 94: Conventions
Chapter 3. Legacy CLI Syntax Reference In addition, 3ware also includes on the 3ware CD a utility named tw_sched(1), which is a wrapper around tw_cli(1). Used in conjunction with a time-driven scheduler such as crond(1d), it provides background task scheduling features such as rebuild, verify, and mediascan. For details about tw_sched(1), see the manpages for it. -
Page 95: Screen Reporting Style
Screen Reporting Style brackets indicate that you may omit the controller ID, to rescan all controllers, and the noscan parameter, so that the operation will be reported to the operating system. Screen Reporting Style In the previous version of the CLI, 3ware has changed the default reporting style to a tabular reporting style for screen displays. -
Page 96: Info
Chapter 3. Legacy CLI Syntax Reference info c<c> p<p> [status|model|serial|capacity|smart] info c<c> diag Parameters cid - the controller id uid - the unit id pid - the port id option - specifies the kind of information you want to see. info Provides information on all detected controllers. -
Page 97: Info Cid Driver
Info Commands The port summary section lists all present ports specifying the port number, disk status, unit affiliation, size (GB), blocks (of 512 bytes), and the serial number assigned by the disk vendor. Additional attributes about units, ports and disks can be obtained by querying for them explicitly. -
Page 98: Info Cid Firmware
Chapter 3. Legacy CLI Syntax Reference /c0 Model = 7506-12 info firmware This command reports the firmware version of controller cid. Example: //localhost> info c0 firmware /c0 Firmware Version = FGXX 2.01.00.025 info bios This command reports the BIOS version of controller cid. Example: //localhost>... -
Page 99: Info Cid Serial
Info Commands info serial This command reports the serial number of the specified controller cid. Example: //localhost>//localhost> info c0 serial /c0 Serial Number = F12705A3240009 info This command reports the PCB (printed circuit board) revision of the specified controller cid. Example: //localhost>... -
Page 100: Info Cid Numdrives
Chapter 3. Legacy CLI Syntax Reference info numdrives This command reports the number of drives currently managed by the specified controller cid. This report does not include units that have been removed (placed off-line) with the maint remove command. Also note that a physically removed disk is not detected unless I/O is performed against the disk. -
Page 101: Info Cid Drivestatus
Info Commands info drivestatus This command presents a list of port assignments, status, unit affiliation, size in GB, the number of blocks of 512 bytes, and the disk’s serial number. Example: //localhost> info c0 drivestatus Port Status Unit Size Blocks Serial -------------------------------------------------------------- 149.05 GB... -
Page 102: Info Cid Stagger
Chapter 3. Legacy CLI Syntax Reference info stagger This command shows the delay between drive groups that spin up at one time on this controller Example: //localhost> info c0 stagger /c0 Spinup Stagger Time Policy (sec) = 2 cid uid info This command presents detailed information on the specified unit. -
Page 103: Info Cid Uid Rebuildstatus
Info Commands cid uid info rebuildstatus This command presents the rebuild status (if any) of the specified unit. Example: //localhost> info c0 u5 rebuildstatus /c0/u5 is not rebuilding. Or, when the unit is rebuilding: //localhost> info c0 u5 rebuildstatus /c0/u5 is rebuilding with Percent Completion = %14 cid uid v info erifystatus... -
Page 104: Info Cid Pid Status
Chapter 3. Legacy CLI Syntax Reference cid pid info status This command presents the status of the specified port. Example: //localhost> info c0 p5 status /c0/p5 Status = OK cid pid info model This command presents the model of the specified port. Example: //localhost>... -
Page 105: Info Cid Diag
Info Commands info diag This command extracts the internal log of diagnostic events of controller cid, 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 this output to a file, where it can be communicated to tech support. -
Page 106: Maint Commands
Chapter 3. Legacy CLI Syntax Reference Maint Commands The maint command lets you perform maintenance operations on the controller, its units, and drives. It is recommended that you use the info command first to verify the controller information before using the maint command to make any changes to it. -
Page 107: [Maint] Remove Cid Uid [Noscan]
Maint Commands Rescan imports JBOD units only when attached to either a 7000 or 8000 controller, unless you reboot. All other RAID types can be imported when attached to the 9000 series. Warning! Adding any drive requires use of an approved hot swap carrier. If you do not have such a carrier you must first power down your system. -
Page 108: [Maint] Remove Cid Pid [Noscan]
Chapter 3. Legacy CLI Syntax Reference cid pid [maint] remove [noscan] This command allows you to remove (or export) a port (or drive). Exporting a port instructs the firmware to remove the specified port from its poll of managed ports, but retains the Disk Configuration Block (DCB) metadata on the attached disk. -
Page 109: [Autoverify] [Ignoreecc]
Maint Commands cid rRAIDType pid_list [maint] createunit [kStripe] [noscan] [gDsk_Grp] [nocache] [autoverify] [ignoreECC] This command allows you to create a unit on the specified controller cid, of type rRAIDType, optional stripe size of kStripe, using one or many disks specified by pid_list. By default the host operating system is informed of the new block device and write cache is enabled. - Page 110 Chapter 3. Legacy CLI Syntax Reference gdsk_grp indicates the number of disks per group for a RAID 50 type. A RAID 50 is a multi-tier array. At the most bottom layer, N number of disks per group are used to form the RAID 5 layer. These RAID 5 arrays are then integrated into a RAID 0.
-
Page 111: [Maint] Rebuild Cid Uid Pid_List [Ignoreecc]
Maint Commands Examples: To create a 12-member RAID-0 array with 128K stripe size on controller 0: CLI> maint createunit c0 rraid0 k256 p0-11 To create a hot spare using a drive on port-2 controller-0 for automatic rebuilds: CLI> maint createunit c0 rspare p2 Alert! When creating a hot spare, be sure to select a drive with an equal or larger size than the smallest drive in your redundant array. -
Page 112: [Maint] Rebuild Cid Uid Resume
Chapter 3. Legacy CLI Syntax Reference cid uid [maint] rebuild resume This command allows you to resume the rebuild operation on the specified unit. See “[maint] rebuild cid uid pause” on page 103 for more details. [maint] flush ...] This command allows you to flush the write cache on the specified unit or all units associated with controller cid. -
Page 113: [Maint] Commit Cid
Maint Commands [maint] commit This command only applies to the Windows operating system. This command instructs the controller to commit its dirty DCBs to persistent storage (disks). While the controller is processing I/O requests against underlying disks, an in-transaction bit is set. If a failure (such as power failure) is experienced, subsequent reads from the disk inform the controller that an un-clean shutdown took place. -
Page 114: Sched Commands
Chapter 3. Legacy CLI Syntax Reference Sched Commands Sched commands are applicable for 9000-series controllers to schedule background tasks to occur at a later time or day, when peak performance is not required. When the schedule is disabled, by default, background task occur almost immediately. -
Page 115: Sched Rebuild Cid
Sched Commands sched rebuild This command displays the current rebuild background tasks as illustrated below. //localhost> tw_cli sched rebuild c1 Rebuild Schedule for controller /c1 ======================================================== Slot Hour Duration Status -------------------------------------------------------- 2:00pm 10 hr(s) disabled 7:00pm 18 hr(s) disabled 1:00am 4 hr(s) disabled 12:00am... -
Page 116: Sched Rebuild Cid Enable
Chapter 3. Legacy CLI Syntax Reference sched rebuild enable This command enables ALL rebuild background tasks on controller cid. sched rebuild disable This command disables ALL rebuild background tasks on controller cid. sched verify This command displays the current verify background task as illustrated below. -
Page 117: Sched Verify Cid Remove Slot_Id
Sched Commands slot_id sched verify remove This command removes (or unregisters) the verify background task in slot slot_id. For example: //localhost> tw_cli sched verify c1 remove 3 Removes the verify background task in slot 3. Warning: If all timeslots are removed, be sure to also disable the schedule so that background tasks occur as required. -
Page 118: Sched Selftest Cid Add Dday Hhour
Chapter 3. Legacy CLI Syntax Reference hour sched selftest add d This command adds a new background selftest task to be executed on day (range 0 .. 6, where Sunday is zeroth day of the week), at hour (range 0 .. 23). Notice that selftest runs to completion and as such no duration is provided. -
Page 119: Sched Selftest Cid Disable Selftest_Task_Id
Alarms Commands selftest_task_id sched selftest disable This command disables a particular selftest task (UDMA or SMART). For the selftest_task_id, s0 is interpreted as UDMA, s1 is interpreted as SMART. For example: //localhost> tw_cli sched selftest c1 disable s1 Disables SMART selftest on controller c1. Alarms Commands The alarms command provides a log of alarms, also called Asynchronous Event Notifications (AENs), that have occurred on the disk arrays. -
Page 120: Syntax
Chapter 3. Legacy CLI Syntax Reference Syntax alarms alarms c<c> [c<c> ...] Warning! 3ware does not recommend installing both 3DM and CLI. Conflicts may occur. If both are installed, alarms will be captured only by 3DM. Warning! 3DM and CLI handle alarms differently. When using CLI with the 7/8000 series, save the alarm data immediately after viewing it. -
Page 121: Set Commands
Set Commands Set Commands These commands allow you to set certain controller and unit specific parameters as described below. The set command can be used to set its rebuild rate, and enable or disable cache. For information about viewing information about the controller and units, see the “Info Commands”... -
Page 122: Set Cache Cid Uid On|Off
Chapter 3. Legacy CLI Syntax Reference cid uid set cache on|off This command allows you to turn on or off the write cache on a specified unit. This feature is supported on both 7000/8000 and 9000 models. The following table shows the supported RAID types for caching as a function of controller model and logical unit type. -
Page 123: Help Commands
Help Commands Help Commands This command set provides brief on-line help. help This command provides a table of contents, providing brief descriptions of the help sub-commands. Typical output looks like: Copyright (c) 2003 3ware, Inc. All rights reserved. List of Commands ------------------------------------------- info - displays information about the controller... -
Page 124: Help Quit
Chapter 3. Legacy CLI Syntax Reference help quit This command provides information about the CLI quit command. For example: //localhost> help quit This command quits the CLI quit Synonyms: q exit Return Code While informative messages are written to standard output, error messages are written to standard error.