Reference Guide hp StorageWorks Modular Smart Array 1000 (MSA1000) Command Line Interface First Edition (September 2003) Part Number: 347282-001 This guide details the use of the Command Line Interface used to configure storage on the Modular Smart Array 1000. Note: Documentation titled HP StorageWorks Modular SAN Array 1000 or HP StorageWorks Modular Smart Array 1000 both refer to the HP StorageWorks MSA1000.
© Copyright 2002-2003 Hewlett-Packard Development Company, L.P. Hewlett-Packard Company makes no warranty of any kind with regard to this material, including, but not limited to, 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.
Contents Contents About this Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5 Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Viewing Controller Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Global Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Version Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Array Controller Configuration Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Global Variables .
About This Guide About this Guide This user guide provides information to help you use the MSA1000 Command Line Interface.
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 MSA1000 Installation Guide that ships with this system.
About this Guide Conventions Conventions consist of the following: ■ Document Conventions ■ Text Symbols ■ Equipment Symbols Document Conventions The document conventions included in Table 1 apply in most cases.
About this Guide 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. Equipment Symbols The following equipment symbols may be found on hardware for which this guide pertains.
About this Guide 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. Any product or assembly marked with these symbols indicates that the component exceeds the recommended weight for one individual to handle safely.
About this Guide Getting Help If you still have a question after reading this guide, contact an HP authorized service provider or access our website: http://www.hp.com. 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.
About this Guide 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 website for locations and telephone numbers: http://www.hp.com.
About this Guide 12 MSA1000 Command Line Interface Reference Guide
Command Line Interface (CLI) 1 The Command Line Interface (CLI) is used to configure and manage the MSA1000. 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 server connected to the serial port of the MSA1000.
Command Line Interface (CLI) CLI 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.
Command Line Interface (CLI) MSA1000 Controller Display Each array controller in an MSA1000 contains an integrated Liquid Crystal Display (LCD). This module is used for displaying informational and error messages, showing the status of the module, and for providing user input when required. Traditional Power-On Self-Test (POST) messages issued by PCI-based array controllers have been combined with runtime event notification messages to create a new set of controller display messages.
Command Line Interface (CLI) When the MSA1000 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 Line Interface (CLI) 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.
Command Line Interface (CLI) 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” for command descriptions. Note: OpenVMS environments must assign a unique ID number to each controller in the MSA1000. See “Setting Global Variables” for instructions. 2. Create the LUNs.
Command Line Interface (CLI) CLI Setup Before using the serial interface to connect to the MSA1000, a serial connection to the controller must be established. Note: Any terminal emulator program may be used, but the following instructions demonstrate setting up the serial connection with HyperTerminal. Setting up the Serial Connection To access the CLI on the MSA1000: 1. Make sure there is an MSA1000 Controller installed in Slot 1 of the MSA1000. (Slot 1 is located on the front right of the MSA1000.) 2.
Command Line Interface (CLI) Figure 2: HyperTerminal New Connection dialog box c. In the New Connection dialog box, type a name to associate with the connection between the MSA1000 and the host server. Then click OK. The Connect To dialog box is displayed. See Figure 3 for an example of the Connect To dialog box.
Command Line Interface (CLI) d. In the Connect To dialog box, expand the Connect using drop-down box, select the appropriate COM port, and click OK. Figure 3 illustrates selecting COM1. The COM Properties dialog box is displayed. Figure 4 is an example of the COM1 Properties dialog box. Figure 4: HyperTerminal COM1 Properties dialog box e. In the COM1 Properties dialog box, enter the following settings, also listed in Figure 4, and click OK.
Command Line Interface (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.
Command Line Interface (CLI) Displaying a List of All Available Commands To see a list of all commands: Example Command CLI> HELP DISPLAY_ALL Command Options DISPLAY_ALL—a list of all currently supported commands will be displayed.
Command Line Interface (CLI) Displaying Help for a Specific Command When the basic HELP command is followed by a specific command verb or command verb and noun, the CLI will display helpful information about that command. Example Command CLI> HELP ADD ACL Command Options ADD ACL—the specific command about which to display help.
Command Line Interface (CLI) Using the show tech_support Command The CLI provides a single command that will execute the following commands as a batch. ■ show version ■ show profile ■ show globals ■ show acl ■ show connections ■ show disks ■ show units ■ show this_controller ■ show other_controller Basic Command SHOW TECH_SUPPORT Example Command CLI> SHOW TECH_SUPPORT The commands will execute using the standard output. For more information on these commands, see the sections below.
Command Line Interface (CLI) Display Commands Several commands are available to view system information and setup, including: ■ Viewing Physical Disk Information ■ Viewing LUN Information ■ Viewing LUN Names ■ Viewing Controller Settings ■ Viewing Global Settings ■ Viewing Version Information Each of these procedures uses the SHOW command, which displays the configuration of the MSA1000. These procedures are discussed in the following paragraphs.
Command Line Interface (CLI) Example CLI Response CLI> SHOW DISKS Disk List: (box,bay) Disk101 (1,01) Disk102 (1,02) Disk103 (1,03) Disk104 (1,04) Disk105 (1,05) Disk106 (1,06) Disk107 (1,07) Disk108 (1,08) Disk109 (1,09) Disk110 (1,10) Disk111 (1,11) Disk112 (1,12) Disk113 (1,13) Disk114 (1,14) (bus,ID) (0,00) (0,01) (0,02) (0,03) (0,04) (0,05) (0,08) (1,00) (1,01) (1,02) (1,03) (1,04) (1,05) (1,08) Size 18.2GB 18.2GB 18.2GB 18.2GB 18.2GB 18.2GB 18.2GB 18.2GB 18.2GB 18.2GB 18.2GB 18.2GB 18.2GB 18.
Command Line Interface (CLI) Basic Command SHOW UNIT Example Command To display all defined LUNs: CLI> SHOW UNITS To display a specific LUN: CLI> SHOW UNIT 1 Example CLI Response Unit 1: In PDLA mode, Unit 1 IS LUN 2; In VSA mode, Unit 1 is LUN 1 Unit Identifier: Device Indentifier:600805F3-00006B20-AE277D4B-B0D100F7 Cache Status:Enabled Max Boot Partition:Disabled Volume Status: VOLUME OK Parity Init Status: 3% complete 5 Data Disk(s) used by lun 1: Disk107: Box 1, Bay 07, (SCSI bus 0, SCSI id 8) Disk
Command Line Interface (CLI) Viewing LUN Names To view the user-defined names that have been assigned to the LUNs: Basic Command SHOW UNIT_ID Example Command CLI> SHOW UNIT_ID 0 Command Options 0–the number of the LUN to display. Example CLI Response Unit 0: ABC ABC represents the assigned user-defined name.
Command Line Interface (CLI) To view information about the configuration of the controller: Basic Command: SHOW THIS_CONTROLLER SHOW OTHER_CONTROLLER Example Command CLI> SHOW THIS_CONTROLLER Example CLI Response Controller: MSA1000© Compaq xxxxxxxxxxxxx Software 2.
Command Line Interface (CLI) Viewing Global Settings The following information can be displayed for the global settings of the controller: ■ System name ■ Rebuild and expand priority settings ■ Read and write cache settings ■ Power supply and EMU temperatures To view information about the global settings of the controller: Basic Command: SHOW GLOBALS Example Command CLI> SHOW GLOBALS Example CLI Response CLI> SHOW GLOBALS Global Parameters: System Name: ABC Rebuild Priority: Expand Priority: hig
Command Line Interface (CLI) Viewing Version Information The following information can be displayed for the controllers: ■ Firmware version ■ Hardware revision ■ Internal EMU Firmware revision To view version information about the MSA1000: Basic Command: SHOW VERSION Example Command CLI> SHOW VERSION Example CLI Response CLI> SHOW VERSION Firmware version: 2.38 build 122 Hardware revision: 7 Internal EMU Rev: 1.
Command Line Interface (CLI) Array Controller Configuration Commands The CLI provides the ability to configure the MSA1000 array controller, including: ■ Setting Global Variables ■ Setting the Controller ID ■ Changing the CLI Prompt Each of these procedures uses the SET command, which changes the settings of the MSA1000 Controller. Setting Global Variables A single command with a variety of parameters is used to set the expand priority, the read/write ratio, and the system name.
Command Line Interface (CLI) SYSTEM_NAME=”XXX”—the system name, where XXX represents any user defined phrase, up to 20 alphanumeric characters. READ_CACHE=50—the read cache. This value must be between 0 and 100. WRITE_CACHE=50—the write cache. This value must be between 0 and 100. Note: Read_cache plus write_cache must equal 100.
Command Line Interface (CLI) Note: To verify the controller ID assignment, use the SHOW THIS_CONTROLLER or SHOW OTHER_CONTROLLER commands. Changing the CLI Prompt To temporarily change the CLI prompt from the default of “CLI>”: Basic Command SET PROMPT Example Command CLI> SET PROMPT ABC Command Options ABC—the user-defined name for the prompt. The name can be up to 24 alphanumeric characters. In this example, the prompt will be changed to ABC.
Command Line Interface (CLI) LUN Management Commands The following commands are used to physically locate the specific hard drives in a LUN as well as create, delete, and modify storage LUNs.
Command Line Interface (CLI) Basic Command LOCATE Command Options TIME=xxx—(optional) the length of time to flash the LEDs, where xxx represents the number of seconds. ALL—all drives connected to the MSA1000 storage sub-system will be flashed. BOX—the number of the storage enclosure whose disks you want to flash. 1=the MSA1000 drive shelf 2=the storage enclosure attached to SCSI port A 3=the storage enclosure attached to SCSI port B BUS—the number of the bus whose disks you want to flash.
Command Line Interface (CLI) Locating all Drives for a Specific SCSI Bus To flash the LEDs of all drives connected to a specific SCSI bus: Example Command CLI> LOCATE BUS 1 BUS 1—all drives connected to bus number 1 will be flashed. Locating all Drives in a Specific LUN To flash the LEDs and locate all drives associated with a specific LUN: Example Command CLI> LOCATE UNIT 1 UNIT 1—the drives in LUN 1 will be flashed. UNIT ALL—all drives incorporated into LUNs will be flashed.
Command Line Interface (CLI) Creating LUNs A LUN is a logical storage unit comprised of one or more hard drives. When a LUN is initially created, the LUN Unit ID is automatically set to the number assigned to the LUN. If desired, this LUN ID name can be changed. See “Assigning a Name or ID to a LUN” for procedural information. The basic command is ADD UNIT. A variety of options are available to modify the command.
Command Line Interface (CLI) STRIPE_SIZE=xxx—(optional) the stripe size to assign (in KB), where xxx represents 8, 16, 32, 64, 128, or 256 Kilobytes.
Command Line Interface (CLI) Example CLI Response First volume to be configured on these drives. Logical Unit size = 69460 MB RAID overhead = 0 MB Total space occupied by new unit = 69460 MB Free space left on this volume = 0 MB Unit 0 is created successfully. Creating Multiple LUNs on a Group of Drives To carve out multiple LUNs from a drive or group of drives, use the ADD UNIT command and include the SIZE= command option.
Command Line Interface (CLI) Example CLI Response The following display is a continuation of the previous example, creating three LUNs on the same group of physical drives. CLI> ADD UNIT 1 DATA=”DISK111-DISK114” RAID_LEVEL=5 STRIPE_SIZE=32 SIZE=1000MB First volume to be configured on these drives. The logical unit size has been adjusted by 4MB for optimal performance.
Command Line Interface (CLI) Creating a LUN with an Assigned Spare To create a LUN and assign a spare at the same time, use the ADD UNIT command and include the SPARE= command option. Note: More than one spare can be assigned to the same LUN and the same spare can be available to multiple LUNs. Example Command CLI> ADD UNIT 4 DATA=”DISK211-DISK212” RAID_LEVEL=1 SPARE=”DISK213” Note: Maintain a record of the units as they are created. These Unit ID numbers are used in other CLI commands.
Command Line Interface (CLI) Assigning a Name or ID to a LUN If desired (or required by your operating system), each LUN can be assigned a unique name or ID in addition to its number. These user-defined names make it easier to identify specific LUNs in other configuration procedures. Note: OpenVMS systems require each LUN to have a unique ID. No two devices in the entire SAN for this OpenVMS system may share ID numbers. LUNs in different storage systems must have different IDs.
Command Line Interface (CLI) Example CLI Response First volume to be configured on these drives. Logical Unit size = 69460 MB RAID overhead = 69460 MB Total space occupied by new unit = 138920 MB Unit 2 is created successfully. Deleting LUNs To delete the last created LUN: Note: If more than one LUN has been created, only the last LUN created can be deleted. It is important to maintain a record of the unit numbers and the order in which they are created.
Command Line Interface (CLI) Deleting Spares To remove a spare from use: Basic Command DELETE SPARE Example Command CLI> DELETE SPARE UNIT=2 DISK109 Command Options UNIT 2—the unit that will no longer have access to the spare. This is the same number that was given to the unit when it was created with the ADD UNIT command. In this example, LUN 2 will no longer have access to the spare. DISK109—the spare drive to remove from use. Disks are identified by box number and bay number.
Command Line Interface (CLI) Modifying Arrays and LUNs Occasionally, after an array or a LUN has been created, its characteristics need to be changed. The following changes can be made: ■ Adding Drives to an Array ■ Adding Space to a LUN ■ Changing the RAID Characteristics of a LUN ■ Changing Attributes of a LUN Each task is discussed in the following paragraphs.
Command Line Interface (CLI) Adding Space to a LUN To add unused, available space in an array to a specific LUN: Basic Command EXTEND UNIT Example Command CLI> EXTEND UNIT 2 ADD_SIZE=1000MB Command Options 2—the LUN to which the space will be added. In this example, LUN 2 is being extended. ADD_SIZE=1000MB—how much of the available space in the array to add to the LUN. In this example, 1000 MB of space will be added. The size limit must be specified as GB, MB, or KB.
Command Line Interface (CLI) Changing the RAID Characteristics of a LUN While obeying the constraints of included number of drives and applicable stripe sizes, you can migrate an array from one RAID level to another. If you attempt to move to an unsupported RAID configuration for an array, an error message is displayed. To change the RAID level or the stripe size of a LUN: Note: Before changing the RAID level or stripe size of a LUN, verify there is available, unused space on the array.
Command Line Interface (CLI) Changing Attributes of a LUN To enable or disable the array accelerator cache for a specific LUN: Basic Command SET UNIT Example Command CLI> SET UNIT 0 CACHE=DISABLE Command Options UNIT 0—the number of the LUN to modify. In this example, LUN 0 will be modified. CACHE=ENABLE or DISABLE—either enables or disables the use of the array accelerator cache for the specified LUN. Example CLI Response CLI> SET UNIT 0 CACHE=ENABLE Cache for unit 0 has been enabled.
Command Line Interface (CLI) Server Connection Commands For a server to access the storage of the MSA1000, you must first establish a connection that identifies the specific HBA to the MSA1000. After connections are entered, you may need to restrict access to LUNs to specific servers. Some programs, including the Array Configuration Utility (ACU), use the phrase Selective Storage Presentation (SSP) when discussing storage limitations.
Command Line Interface (CLI) Viewing Existing Connections and the HBA World Wide Name The following command displays the World Wide Names of each Host Bus Adapter (HBA) attached to the MSA1000. If connections between the HBAs and the MSA1000 have been given user-defined names, these names are also displayed. Basic Command SHOW CONNECTIONS Example Command CLI> SHOW CONNECTIONS Command Options CONNECTION NAME—the name of a specific connection to display. WWPN—the WWPN of a specific connection to display.
Command Line Interface (CLI) Naming a Connection to a server This command is used to create an association between the Fibre Channel Initiator (HBA in the server) and the MSA1000, while at the same time naming and identifying the host mode (operating system) of the server. The name given to a connection is user defined, and according to a naming convention that makes identification and setup of the ACL for this connection easier.
Command Line Interface (CLI) Managing Connection Profiles To change the operating-system profile associated with an existing connection: Note: The connection profile is sometimes referred to as the Host Mode. Basic Command SET CONNECTION X PROFILE=Y Example Command CLI> SET CONNECTION ABC PROFILE=WINDOWS Command Options ABC—the name of the connection to modify, in this example ABC. WWPN=12345678-12345678—the WWPN of the connection to modify, using the WWPN of the HBA.
Command Line Interface (CLI) Selective Storage Presentation/Access Control List Commands When multiple servers access the storage of the MSA1000, it becomes necessary to restrict access to LUNS to specific servers. Some programs, including the Array Configuration Utility (ACU), use the phrase “selective storage presentation” (SSP) when discussing storage limitations. The CLI uses an Access Control List (ACL) to enter the list of LUNs a server can access.
Command Line Interface (CLI) Viewing the Connection Names Use the SHOW command to display the connection name associated with each Host Bus Adapter (HBA) attached to the MSA1000. The connection names are used when entering ACL information. See “Viewing Existing Connections and the HBA World Wide Name” for details about this command. Viewing the ACL To display the current ACL: Basic Command SHOW ACL Command Options There are no available options for this command.
Command Line Interface (CLI) Two methods of entering LUN assignments are available: ■ Adding to the ACL using the connection name ■ Adding to the ACL using the WWPN Note: There is no command to activate the ACL. Immediately after the first entry is added to the ACL, access to the storage is limited to the servers and LUNs listed in the ACL.
Command Line Interface (CLI) Deleting Information from the ACL After the ACL has been set up, access permissions for certain LUNs may need to be removed. Basic Command DELETE ACL Command Options CONNECTION=xxx—the name of the connection for which to remove permissions. UNIT=xxx—which LUNs to remove from the ACL of the indicated server.
Command Line Interface (CLI) Deleting Information from the ACL using the WWPN Example Command CLI> DELETE ACL WWPN=12345678-12345678 UNIT=1 Command Options WWPN=12345678-12345678—entries will be deleted from the ACL of the connection with a WWPN of 12345678-12345678. UNIT=1—LUN 1 will be removed from the ACL of the named connection. Example CLI Response Disallowing 12345678-12345678 access to unit 1.
Command Line Interface (CLI) Changing the HBA of a Connection When a new HBA needs to be associated with an existing connection name: Basic Command SET CONNECTION Example Command CLI> SET CONNECTION ABC WWPN=12345678-Y999999Y Command Options ABC—the connection to make the changes to. WWPN=12345678-12345678—the World Wide Port Name (WWPN) of the new HBA to associate with the connection. WWNN=12345678-12345678—the World Wide Node Name (WWNN) of the new HBA to associate with the connection.
Command Line Interface (CLI) Disabling the ACL If the ACL has been set up, but the decision has been to not use it and not limit access to the storage, the entries in the ACL need to be deleted. Use the following command to delete all entries in the ACL. Basic Command SET ACL DISABLE Example CLI Response Disabling acl Note: When this command is used, all existing ACL entries are automatically deleted. All storage is immediately available to all connected servers.
Command Line Interface (CLI) 62 MSA1000 Command Line Interface Reference Guide
Index A Access Control Lists See ACL ACL adding to with the CLI 56 deleting from, with the CLI 58 disabling, with the CLI 61 viewing, with the CLI 56 array controller configuration, with the CLI 33 audience 6 Index cache, enabling/disabling per LUN with the CLI 50 CLI ACL commands 51, 55 ACL, adding to 56 ACL, deleting from 58 ACL, disabling 61 ACL, viewing 56 array controller configuration commands 33 array, expanding 47 command option, defined 17 command syntax 17 connections, changing the HBA 60 conne
Index controller settings, viewing, with the CLI 29, 31, 32 conventions document 7 equipment symbols 8 text symbols 7 D described 15 disks, viewing information about, with the CLI 26 document conventions 7 documentation, related 6 E equipment symbols 8 L LUN changing the RAID level with the CLI 49 creating with a spare, with the CLI 43 creating with the CLI 39 deleting with the CLI 45 extending with the CLI 48 names, assigning with the CLI 44 names, viewing, with the CLI 29 viewing information about, wi
