Modular Smart Array 1000/1500 cs
Command Line Interface
Second Edition (May 2004)
Part Number: 347282-002
This guide details the Command Line Interface (CLI), which is used to configure and
manage the storage on the Modular Smart Array 1000 (MSA1000) and the Modular Smart
Array 1500 Controller Shelf (MSA1500 cs).
Note:
■ Documentation titled
Array
both refer to HP StorageWorks MSA products.
■ Throughout this document, the term MSA is used when referring to both the MSA1000 and the
the implied warranties of merchantability and fitness for a particular purpose. Hewlett-Packard shall not be liable for
errors contained herein or for incidental or consequential damages in connection with the furnishing, performance,
or use of this material.
This document contains proprietary information, which is protected by copyright. No part of this document may be
photocopied, reproduced, or translated into another language without the prior written consent of Hewlett-Packard.
The information contained in this document is subject to change without notice.
Compaq Computer Corporation is a wholly-owned subsidiary of Hewlett-Packard Company.
Microsoft®, MS-DOS®, MS Windows®, Windows®, and Windows NT® are U.S. registered trademarks of
Microsoft Corporation.
Hewlett-Packard Company shall not be liable for technical or editorial errors or omissions contained herein. The
information is provided “as is” without warranty of any kind and is subject to change without notice. The warranties
for Hewlett-Packard Company products are set forth in the express limited warranty statements for such products.
Nothing herein should be construed as constituting an additional warranty.
Modular Smart Array 1000/1500 cs Command Line Interface User Guide
Second Edition (May 2004)
Part Number: 347282-002
4Modular Smart Array 1000/1500 cs Command Line Interface User Guide
About This
Guide
This user guide provides information to help you use the MSA Command Line
Interface (CLI).
“About This Guide” topics include:
■Overview, page 6
■Conventions, page 6
■Getting help, page 9
About this Guide
About this Guide
5Modular Smart Array 1000/1500 cs Command Line Interface User Guide
About this Guide
Overview
This section covers the following topics:
■Intended audience
■Related documentation
Intended audience
This book is intended for use by administrators with a moderate amount of
SAN-management experience.
Related documentation
In addition to this guide, refer to the HP StorageWorks MSA Installation Guide
that ships with this system.
Conventions
Conventions consist of the following:
■Document conventions
■Text symbols
■Equipment symbols
6Modular Smart Array 1000/1500 cs Command Line Interface User Guide
Document conventions
The document conventions included in Table 1 apply in most cases.
Table 1: Document Conventions
Cross-reference linksFigure 1
Key and field names, menu items,
buttons, and dialog box titles
File names, application names, and text
emphasis
User input, command and directory
names, and system responses (output
and messages)
Variables<monospace, italic font>
Web site addressesUnderlined sans serif font text:
About this Guide
ElementConvention
Bold
Italics
Monospace font
COMMAND NAMES are uppercase
monospace font unless they are case
sensitive
http://www.hp.com
Text symbols
The following symbols may be found in the text of this guide. They have the
following meanings:
WARNING: Text set off in this manner indicates that failure to follow
directions in the warning could result in bodily harm or death.
Caution: Text set off in this manner indicates that failure to follow directions
could result in damage to equipment or data.
Note: Text set off in this manner presents commentary, sidelights, or interesting points
of information.
Modular Smart Array 1000/1500 cs Command Line Interface User Guide
7
About this Guide
Equipment symbols
The following equipment symbols may be found on hardware for which this guide
pertains. They have the following meanings:
Any enclosed surface or area of the equipment marked with these
symbols indicates the presence of electrical shock hazards. Enclosed
area contains no operator serviceable parts.
WARNING: To reduce the risk of personal injury from electrical shock
hazards, do not open this enclosure.
Any RJ-45 receptacle marked with these symbols indicates a network
interface connection.
WARNING: To reduce the risk of electrical shock, fire, or damage to the
equipment, do not plug telephone or telecommunications connectors
into this receptacle.
Any surface or area of the equipment marked with these symbols
indicates the presence of a hot surface or hot component. Contact with
this surface could result in injury.
WARNING: To reduce the risk of personal injury from a hot component,
allow the surface to cool before touching.
Power supplies or systems marked with these symbols indicate the
presence of multiple sources of power.
WARNING: To reduce the risk of personal injury from electrical
shock, remove all power cords to completely disconnect power
from the power supplies and systems.
8Modular Smart Array 1000/1500 cs Command Line Interface User Guide
Getting help
If you still have a question after reading this guide, contact an HP authorized
service provider or access our web site:
HP storage web site
The HP storage web site has the latest information about this and other HP storage
products. Access the primary storage web site on the Internet at
Any product or assembly marked with these symbols indicates that the
component exceeds the recommended weight for one individual to
handle safely.
WARNING: To reduce the risk of personal injury or damage to the
equipment, observe local occupational health and safety requirements
and guidelines for manually handling material.
http://www.hp.com
. From this web site, select
.
HP authorized reseller
For the name of your nearest HP Authorized Reseller:
■In the United States, call 1-800-345-1518
■In Canada, call 1-800-263-5868
■Elsewhere, see the HP web site for locations and telephone numbers:
http://www.hp .com
Modular Smart Array 1000/1500 cs Command Line Interface User Guide
.
9
About this Guide
HP technical support
In North America, call technical support at 1-800-652-6672, available 24 hours a
day, 7 days a week.
Note: For continuous quality improvement, calls may be recorded or monitored.
Outside North America, call technical support at the nearest location. Telephone
numbers for worldwide technical support are listed on the HP web site under
support:
Be sure to have the following information available before calling:
■Technical support registration number (if applicable)
■Product serial numbers
■Product model names and numbers
■Applicable error messages
■Operating system type and revision level
■Detailed, specific questions
http://www.hp.com.
10Modular Smart Array 1000/1500 cs Command Line Interface User Guide
Overview and Setup
The Command Line Interface (CLI) is used to configure and manage the
MSA1000 Controller and its storage.
In addition, the CLI can be used to display system setup information and status. It
may also provide information on devices that are attached to the controller.
Note: The CLI is available for all supported operating systems.
The CLI is accessed through a host computer connected to the serial port of an
MSA1000 Controller.
Some CLI configuration and management tasks include configuring storage units
(LUNs), setting the addressing mode, limiting access to storage, and viewing
information on MSA components (controller, unit, and cache).
This chapter discusses:
■Overview, page 12
■Setup, page 15
1
11Modular Smart Array 1000/1500 cs Command Line Interface User Guide
Overview and Setup
Overview
After accessing the interface, enter a command string at the CLI prompt (CLI>).
Commands must use a specific, preset syntax. After a declarative command is
entered and executed, the results are displayed at the CLI prompt.
When using the CLI, the following keystrokes have special meaning:
Table 2: CLI Special Keys
Keyboard KeysArrow KeyMeaning
Ctrl_Bleft arrowmove the cursor back one
character
Ctrl_Fright arrowmove the cursor forward one
character
Ctrl_Pup arrowrecall the previous command in
the command buffer
Ctrl_Ndown arrowrecall the next command in the
command buffer
Note: The CLI uses a zero-based numbering system. For example, LUN number
assignments begin with 0.
CLI commands in redundant configurations
When a system has two controllers, the same firmware image is run on both
controllers. The two controllers communicate with each other through a PCI bus
called the inter-controller link (ICL). Each controller has a serial port and has a
CLI available to the users who connect the serial port to a serial terminal.
Some CLI commands are entered from one controller’s CLI prompt but are for the
other controller to execute. Command syntax instructs the controller to accept
user input, pass the command to the other controller, and then display the result.
The following keywords are used in the CLI to indicate a specific controller:
■this_controller-—is included in a command syntax to refer to the
controller that the CLI is connected to.
■other_controller—is included in a command syntax to refer to the other
controller in the MSA.
12Modular Smart Array 1000/1500 cs Command Line Interface User Guide
CLI command syntax
As previously mentioned, CLI commands are entered at the CLI prompt.
Commands are not case sensitive and must be typed out in full.
CLI command strings include the basic command plus specific command options,
some of which are mandatory and some of which are optional.
The CLI does not support line-continuation characters. If all characters of a
command do not fit on one line of the CLI, let them wrap around to the next line
on the screen. The maximum command length is 255 characters.
Example command
ADD UNIT 0 DATA=”DISK101-DISK103” RAID_LEVEL=0
This example command has three portions—the basic command, plus two
command options.
Basic command
add unit
The basic command includes a word or phrase used to instruct the controller.
Commands usually contain a verb with a noun. Every CLI command must begin
with a basic command.
Overview and Setup
Command options
0
data=”disk101-disk103”
raid_level=0
An option is defined as words or phrases listed after the basic command that
supply necessary information to support the command.
Some CLI commands require these parameters. If parameters are required but are
not entered, the CLI command string is considered invalid. The syntax of the
parameter value is uniquely defined for each CLI command, but must be less than
20 alphanumeric characters.
Some CLI commands support options that modify the command, but are not
required. If a modifying option is available but not used, a default value is used.
13Modular Smart Array 1000/1500 cs Command Line Interface User Guide
Overview and Setup
Overview of CLI storage configuration procedures
When using the CLI to initially configure the MSA1000 Controller and its
storage, use the following sequence:
1. Enter array controller settings, including global parameters.
See “Array controller configuration commands” on page 32 for command
descriptions.
Note: In addition to setting the global parameters for the controller, OpenVMS
environments must assign a unique ID number to each array controller.
See “Setting the controller ID” on page 33 for instructions.
2. Create the LUNs.
See “LUN management commands” on page 35 for command descriptions.
Note: In addition to creating the LUNs, OpenVMS environments must assign a unique
ID number to each LUN. See “Assigning a name or ID to a LUN” on page 43 for
instructions.
3. Enter connection information about the HBAs with access to the MSA.
See “Server connection commands” on page 50 for command descriptions.
Note: Each server accessing the storage must identify its operating system
(profile type.) See “Setting the connection profile” on page 52 for instructions.
4. (Optional) Limit access to the storage.
See “Access control list commands” on page 55 for command descriptions.
14Modular Smart Array 1000/1500 cs Command Line Interface User Guide
Setup
Overview and Setup
The CLI is accessed through a host computer connected to the serial port of an
MSA1000 Controller.
Use the following steps to establish a serial connection to the controller.
Note: Any terminal emulator program may be used, but the following instructions
demonstrate setting up the serial connection with HyperTerminal.
1. Make sure there is an MSA1000 Controller installed in Slot 1 of the unit.
(Slot 1 is located on the front right of the unit.)
2. Connect the controller to a host server using the custom serial cable included
in the shipping carton of the MSA.
An additional or replacement custom serial cable can be ordered using part
number 259992-001.
■MSA adapter: RJ-45Z
■Host server adapter: serial port on the host server
3. Set up a terminal emulator.
To set up HyperTerminal:
a. Access HyperTerminal.
If you need to load HyperTerminal on the server, navigate the Web and
download the latest version.
If HyperTerminal is already loaded on the server, but its location is
unknown, to locate this program on a Windows-based server, go to Start, Search, For Files and Folders. Enter
hypertrm.exe as search term.
After this program is installed or located, if desired, create a shortcut for it
to simplify subsequent accesses.
b. Open HyperTerminal.
When accessed for the first time, the New Connection dialog box is
displayed.
See Figure 1 for an example of the New Connection dialog box.
15Modular Smart Array 1000/1500 cs Command Line Interface User Guide
Overview and Setup
Figure 1: HyperTerminal New Connection dialog box
c. In the New Connection dialog box, type a name to associate with the
connection between the controller and the host server. Then click OK.
The Connect To dialog box is displayed.
See Figure 2 for an example of the Connect To dialog box.
Figure 2: HyperTerminal Connect To dialog box
16Modular Smart Array 1000/1500 cs Command Line Interface User Guide
Overview and Setup
d. In the Connect To dialog box, expand the Connect using drop-down
box, select the appropriate COM port, and click OK.
Figure 2 illustrates selecting COM1.
The COM Properties dialog box is displayed.
Figure 3 is an example of the COM1 Properties dialog box.
f.In the CLI session screen, press Enter several times to display the
command prompt (
CLI>).
Commands can now be entered at this CLI prompt.
17Modular Smart Array 1000/1500 cs Command Line Interface User Guide
Overview and Setup
18Modular Smart Array 1000/1500 cs Command Line Interface User Guide
Using the CLI
Managing and configuring the storage includes configuring LUNs, entering
connection information, limiting access to the storage, and viewing information
about the configuration.
This chapter contains the following information and is organized in the order in
which the commands are used when configuring a new MSA installation.
■Help commands, page 20
■Display commands, page 23
■Array controller configuration commands, page 32
■LUN management commands, page 35
■Server connection commands, page 50
■Access control list commands, page 55
2
19Modular Smart Array 1000/1500 cs Command Line Interface User Guide
Using the CLI
Help commands
Help commands can be used to display a list of all possible commands or to
display a detailed description of a specific command. Displayed information may
include required command syntax, a brief definition, the number of characters for
a command option value, or a list of allowed/disallowed characters.
■Displaying a list of all basic commands
■Displaying a list of all available commands
■Displaying help for a specific command
The basic command is
HELP, but can be modified with command options to more
narrowly define the request.
Displaying a list of all basic commands
If the HELP command is entered without a limiting command verb or noun, the
CLI will display the available basic commands.
Example command
CLI> HELP
CLI> ?
Note: ”HELP” and “?” are interchangeable.
Example command output
CLI> HELP
Possible command verbs:
helpadd
deletemigrateexpand
extendacceptrename
setlocateshow