Working with 3ware CLI
www.3ware.com
7
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.
Examples shown in the
CLI Reference
chapters reflect the interactive method.
There are two command syntaxes available for the 3ware CLI:
The primary command syntax.
The current CLI version of the 3ware CLI includes a new command
syntax to improve usability. This is now considered the primary syntax for
use in the 3ware CLI, and includes commands for features new in the
3ware RAID controller software after version 9.1.5, such as those that are
used with the Battery Backup Unit (BBU).
Details of the primary syntax are described under “Primary CLI Syntax
Reference” on page 19.
Legacy command syntax.
In the current CLI version, the command syntax used in previous versions
of the 3ware CLI is still supported, to make sure that scripts written with
the old syntax will still operate. New functions (such as BBU-related
commands, StorSave and queuing policies, and other recent additions) are
not available in the legacy syntax. The legacy command syntax will be
supported for a limited time.
Details of the legacy syntax are described under “Legacy CLI Syntax
Reference” on page 83.
Using the command interface interactively
You can use 3ware CLI interactively, entering commands at the main prompt
and observing the results on the screen.
To use the CLI interactively
1
Enter the following command:
# tw_cli
The main prompt is displayed, indicating that the program is awaiting a
command.
//localhost>
