3ware, the 3ware logo, Escalade, StorSwitch, TwinStor, R5 Fusion and
3DM are all registered trademarks of 3ware, Inc. All other trademarks
herein are property of their respective owners.
Disclaimer
3ware, Inc. assumes no responsibility for errors or omissions in this document, nor does 3ware, Inc. make any commitment to update the information contained herein.
The Command Line Interface (CLI) for Linux is provided to
manage 7000 and 8000 series 3ware Esca lade
trollers. Multipl e syst ems con taini ng Esca lade cont roll ers ma y be
managed using the CLI via a command line or script. CLI is useful in environmen ts where a graphical user interface (GUI) is not
available.
™
ATA RAID con-
1www.3ware.com
Features
Features
The 3ware CLI provides the basic functionality of the 3ware Disk
®
Management (3DM
You can view array status and version information, and perform
maintenance functions like adding or removing dri ves. CLI also
includes advanced featu res for reconfiguring RAID arrays online.
) utility through a Command Line Interface.
Note:
User’s Guide for complete information on 3DM and for
configuring or upgrading your computer.
The CLI command set is listed below and described in detail in the
Command Line Interface chapter of this guide:
• info - to view basic controller information
• alarms - to disp lay a list of AENs for all controllers
• set - to display and modify current settings
• maint - to perform drive and RAID arr ay maint enance operations for a single controller
• help - to display a li st of commands and options
Refer to the Escalade ATA RAID Controller
www.3ware.com2
Installation
Installation
You will need to be root or have root privileges to install the CLI
to /usr/sbin and to run the CLI.
Filename: tw_cli.tar
To install the CLI, type the following as root:
tar xf tw_cli.tar -C /usr/sbin
To install the CLI to a different location, change /
usr/sbin/
to the
desired location.
Note:
The installation location needs to be in the environment path for root to execu te the CLI without using
complete pa ths (i.e., if installed to /
usr/sbin/
, you can
type tw_cli on the command line, otherwise you will have
to type the com p le te path:
Warning!
/home/user/tw_cli
).
For all of the func ti ons of the CLI to work properly, you
must have the proper CLI, firmware, and driver versi ons
installed. Check www.3ware.com for the latest versions
and upgrade instructions. If the proper firmware and
driver versions are not installed CLI will not report the controller
when issuing the info command.
3www.3ware.com
Command Line Interface
Command Line Interface
Note:
In this chapter, text surrounded by [] brackets
indicates optional par amet er s.
Ways to Run the CLI
1) Interactive with command interface
tw_cli
Description:
Execute tw_cli to get into a console where you can interactively enter
commands to get, set or maintain your Escalade.
Example:
tw_cli
3ware CLI>
The main prompt is display ed when the program is awaiting a command.
3ware CLI>
2) Single command with output
tw_cli <command line arguments>
CLI run command
Description:
This command doesn’t invoke the main CLI prompt if used with command line arguments.
Syntax:
tw_cli <command line arguments>
www.3ware.com4
3ware Escalade ATA RAID Controller CLI User Guide
Example:
tw_cli info c 0 u0
3) Multiple commands through an input file
tw_cli -f <filename>
CLI run command
Description:
This method executes a specific filename, where the filename is the name
of a text file containing a list of CLI commands which the user types in
advance. Each command should be on a separate line.
Syntax:
tw_cli -f <filename>
Example:
tw_cli -f clicommand.txt
Note:
All examples given in the follo w ing sections will
reflect the interactive mode method.
Controller Information
Note:
identification.
The
info
command
The info command provides information about the 3ware Escalade
controller, the attached drives, and configured RAID arrays or
units. This command is for querying purposes only. To make modifications use the set command to change the settings and the maint
command to maintain the R A ID arrays.
5www.3ware.com
Commands will be displayed in italics for easy
Command Line Interface
Specific options for the info command:
•Controller in formation options
-model - provides the controller model number
-firmware - provides the controller firmware version
-bios - provides the controller bios version
-monitor - provides the controller monitor version
-driver - provides the controller driver version.
-serial - provides the controller serial number
-pcb - provides the controller revision number
-achip - provides the controller achip version
-pchip - provides the contro ller pchip version
-numunits - provides the number of units on the controller
-numports - provides the number of ports on the controller
-numdrives - provides the number of drives on the controller
-allunitstatus - provides simple numeric status for all units
-drivestatus - provides the status of drives on the controller
•Unit information options
-status - provides the status of a specific unit
-rebuildstatus - provides percent complete of rebuild
-verifystatus - provides percent complete of verify
-initializestatus - provide percent complete of initialization.
•Port (drive) information options
-status - provides the status of a drive on the controller
-model - provides the drive manufacturer model number
-serial - provides the drive serial number
-capacity - provides drive capacity
-smart - provides SMART data in hex format for troubleshooting a
drive
Syntax:
info [c<c>[u<u>|p<p>][item]]
www.3ware.com6
3ware Escalade ATA RAID Controller CLI User Guide
Note: •
• Ιf c is not specified, information for all controllers is dis-
played, including a brief description of each.
• Ιf only c is specified, information about the cth controller is
provided in detail.
•
Ιf c is specified and u is also specified, information about
the uth unit on the cth controller is provided in detail.
•
Ιf c is specified and u is also specified with status, text and
hex code of the status is displayed in the form OK (0xFF).
Also, an error code is returned, bi t masking bad drives if any
of the drives used by the array are bad. For example, if port 2
is bad, the return code would be 4 (in hex).
•
Ιf c is specified and u is also specified with rebuildstatus,
then the status of the array is displayed (e.g., 0=array is not
rebuilding, 1-99 = the percentage of the rebuild)
• Ιf c is specified and p is also specified, information about
To get a general status of the drives of a controller.
Example:
3ware CLI> info c0 drivestatus
Sample of output:
# of ports: 4
Port 0: Maxtor 98196H8 V8096CC C 81.96 GB (160 086528
blocks): OK (unit 0)
Port 1: DRIVE NOT PRESENT
Port 2: DRIVE NOT PRESENT
Port 3: Maxtor 98196H 8 V805W6SC 81 .96 GB (16008 6528
blocks): OK (unit 0)
rebuildstatus
Example:
3ware CLI> info c0 u2 rebuildstatus
Sample of output:
60
Controller not found
Example:
3ware CLI> info c2
Sample of output:
Invalid controller id specified, no controller with id 2 exists.
11www.3ware.com
Loading...
+ 30 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.