Print | Rate this content

HP StorageWorks Interface Manager - Command Line Interface

In addition to the Command View ESL GUI, the Interface Manager card can be managed via a command line interface (CLI). The CLI provides commands to perform all necessary management functions.

This document explains how to initiate a CLI session, the structure of the CLI, and basic navigational techniques. For a comprehensive listing of CLI commands, see CLI Command Reference.

Accessing the CLI

The CLI can accessed through a direct RS-232 connection, or by using Telnet over the LAN.
  • Serial--uses a command line interface (CLI) and connects directly to the Interface Manager card through an RS232 serial interface rather than through the LAN. The serial UI takes precedence over the Command View ESL and Telnet UIs and will prevent any other open sessions from communicating with the Interface Manager card.
    NOTE: If you use Telnet to change the IP address of the Interface Manager card, you will have to logon to a new Telnet session with the new IP address.
  • Telnet--uses the same CLI as the serial interface, but requires the IP address of the Interface Manager card to initiate the session. The advantage of using Telnet over the serial interface is that users can Telnet from any client machine that is on the LAN; a separate serial connection is not needed. The Telnet UI has precedence over the Command View ESL GUI and will prevent any open Command View ESL sessions from communicating with the Interface Manager card.
    CAUTION: While it is possible for an administrator to terminate other sessions by opening a serial or Telnet session, this is not recommended. If, for example, someone is performing a firmware upgrade using a Command View ESL session and that session is terminated prematurely, the firmware upgrade would fail and render the device being upgraded unusable.

Starting a serial session

To start a serial session, do the following:
  1. Connect the management station or other PC or laptop to the Interface Manager card using the serial cable shipped with the Interface Manager card. Refer to HP StorageWorks Command View ESL - Command View ESL Overview and Command View ESL Installation Guide for instructions on how to connect the cable.

    Click here to read HP StorageWorks Command View ESL - Command View ESL Overview.

  2. Start a terminal emulation program on the PC that is connected to the Interface Manager card in Step 1. A variety of programs may be used, but HyperTerminal, included with Microsoft Windows operating systems, is the most common. To start HyperTerminal, click Start, Programs, Accesories, Communications, then HyperTerminal.

  3. Set the communications settings as follows:

    • Port Speed: 9600

    • Data Bits: 8

    • Parity: none

    • Stop bits: 1

    • Flow control: none

  4. At the login prompt, use the following default information:

Starting a Telnet session

You can start a Telnet session with the Interface Manager card in one of two ways:
  • Through the LAN--Use any PC on the LAN, including the management station, to Telnet into the Interface Manager card using the network IP address.
  • Through the Cascade port--Connect a PC to the Interface Manager card via the cascade port and Telnet into the Interface Manager card using the cascade IP address.

Telnet through the LAN

From any PC on the LAN, including the management station, do the following:
  1. Open a command prompt and enter the following command: telnet <name> (where <name> is either the IP address or hostname of the Interface Manager card)

  2. At the login prompt, use the following default information:

Telnet through the cascade port

The cascade port of the Interface Manager card has a dedicated IP address that is hardcoded into the Interface Manager card and is completely separate from the network IP address. The cascade port provides a "backdoor" method for accessing the Interface Manager card and making configuration changes, such as getting or setting the network IP address.

To Telnet through the cascade port, do the following:
  1. Connect a standard RJ-45 Ethernet cable from the network port of the PC or laptop to the cascade port of the Interface Manager card.

    Figure 1: Connecting to the cascade port

  2. Open a command prompt and enter the following command: telnet 192.168.2.1
    NOTE: The above IP address is hardcoded into the Interface Manager card and is completely separate from the network IP address.
  3. At the login prompt, use the following default information:

Command syntax structure

NOTE: Many command line examples are given throughout this document. To help differentiate between the command prompt and the actual commands that are entered, the prompt portion of the command line is shown in tex and the command will look like the following: command. For example, if the documentation says to enter the following command: <user>/set/mgmt > clock, then type only the word clock. Do not type the text shown italics.

The command prompt has the following format:

<user>/<command_level> >

<user> indicates the CLI user name and <command_level> indicates the current command level. For example, when you first log on to the CLI with your CLI username and password, you see the following root-level prompt:

<user>/ >

The root command level offers all of the basic and operational commands. To change command levels, enter any command that is available from the current command level. For example, from the root command level, if you enter the set command to change to the set command level, the following prompt is displayed:

<user>/set >

NOTE: All of the set commands are directly available at this level.

Using command sequences

You can change to any command level by specifying a sequence of command levels. A command sequence contains each command level name separated by a space. For example, to get to the mode command level of the set command level, you could either enter set mode from the root command level or mode from the set command level:

<user>/ > set mgmt

<user>/set/mgmt >

or

<user>/ > set

<user>/set > mgmt

<user>/set/mgmt >

To execute a command that is available at a particular command level, either change to that command level and enter the command, or enter a command sequence followed by the command name. For example, if you were at the root command level and wanted to use the clock command available at the show mgmt command level, you could do either of the following (in this example, output of the clock command has been omitted):

<user>/ > show mgmt clock

<user>/ >

or

<user>/ > show mgmt

<user>/show/mgmt > clock

<user>/show/mgmt >
NOTE: Executing a command does not change the current command level.

Abbreviating commands

All commands may be abbreviated provided that the abbreviation is unique. For example, from the root command level, se mo is equivalent to set mode. However, se m is ambiguous because m at the root command level could mean either mgmt or mode.

Device numbering conventions

In some instances, the CLI numbers devices differently than they are numbered in the ESL library front panel. This discrepancy occurs because the ESL library uses a zero-based numbering scheme for drives and slots whereas the CLI uses a one-based numbering scheme. For example, if the library contains eight drives, the library front panel refers to those drives as drive 0 through 7. The CLI refers to the same drives as drive 1 through 8.

Table 4 shows the device numbering conventions used by the CLI and by the ESL library front panel (when applicable). The ESL library front panel does not reference the FC interface controllers or their associated FC port numbers and SCSI bus numbers. The CLI uses one-based numbering to refer to the FC interface controllers, but it uses zero-based numbering for the FC port numbers and SCSI bus numbers, corresponding with the numbers that are printed on the actual hardware.

Device
CLI
ESL front panel
Drives
One-based
Zero-based
Slots
One-based
Zero-based
FC interface controllers
  • FC port numbers

  • SCSI bus numbers

One-based
  • Zero-based

  • Zero-based

n/a
  • n/a

  • n/a

Navigating the CLI

The CLI is case-sensitive. All commands and keywords must be entered in lower case. User-defined strings such as names or descriptions may be in any case, including mixed case. Case information for user-defined strings is preserved in the configuration.

The CLI provides the following basic commands as listed in Basics Command table.

Basic commands
Command
Description
show
Display configuration, status, and log information
set
Set or change configurable values
add
Add an item to a list
delete
Delete an item from a list
save
Save the current configuration or logs
restore
Restore saved or factory default configurations
setup
Run the Configuration Wizard
download
Download firmware
reboot
Reboot devices

Operational commands table shows additional operating commands provided by the CLI.

Command
Description
home
Move to the root command level
up
Move up one command level
help
Display help text for a particular command
exit
Terminate the current management session

Click here for a complete listing of CLI commands.

Interface manager mode

The Interface Manager mode setting controls the behavior of the Interface Manager card and dictates how the FC interface controllers are configured. Manual mode is intended for experienced personnel only.

In Automatic mode, the Interface Manager card ensures that the library is configured correctly and consistently across all FC interface controllers. In the event of an FRU replacement, advanced logic is enabled to maintain consistent firmware revisions and to present a consistent device map to backup servers.

In Manual mode, each FC interface controller is configured independently. The Interface Manager card does not provide consistency checking or FRU replacement logic.
CAUTION: HP strongly recommends that you leave the Interface Manager mode set to the default setting of Automatic. Using Manual mode increases the risk of making serious configuration errors and causing hardware conflicts which can severely disrupt the normal operation of the library.

To change the Interface Manager mode, enter the following command:

<user>/ > set mode {auto|manual}

When switching between modes, the current command level is changed to the root command level for that mode. When changing from Manual mode to Automatic mode, many of the manual configuration changes made in Manual mode will be lost.

Common CLI functions

Using the Setup Wizard

The Setup Wizard takes you through a series of prompts that allow you to perform all of the configuration steps necessary to get the system running.

For more information, see setup.

Configuring a library

Use the following commands to configure library properties:
Use the following commands to configure TCP/IP settings:

Configuring the FC interface controllers

Use the following commands to configure the port settings:

Monitoring device status

The CLI provides several commands to monitor device status. The status shown is a snapshot of device status at the moment the command was executed. After the status is displayed by the CLI, it does not refresh. To refresh the status information, execute the command again.

Use the following commands to show the status of the corresponding device:
NOTE: In the show mgmt status command, "mgmt" refers to the Interface Manager card.

Generating interface manager and FC interface controller logs

The following two commands generate a log file for the Interface Manager card or the FC interface controller respectively. The log file is saved in the memory of the Interface Manager card and is accessible through anonymous ftp.
NOTE: When a log file is generated, it is given a set filename depending on the type of log (see Log file types and filenames table). Each time a log file is generated, it overwrites the previous log file having the same filename.
The logs are available via anonymous ftp. To access the log file via ftp, do the following:
  1. On any PC connected to the LAN, open a command shell.

  2. Navigate to the directory that you want to transfer the log file to.

  3. Enter the following command:

    ftp <ipaddress>

    where <ipaddress> is the IP address of the Interface Manager card.

  4. Login with the following credentials:
    • User name: ftp

    • Password: Use your e-mail address

      After logging in, a command shell opens displaying the anonymous ftp directory.

  5. If necessary, use the ls command to list the contents of the ftp directory.

  6. Enter the following command to turn on binary transfer mode:

    bin

  7. Enter the following command to copy the log file to the directory that you navigated to in Step 2: get <filename>

    The filename is determined by the type of log file you are retrieving, as shown in Log file types and filenames table.

    Log file types and filenames
    Type of log
    Filename
    FC interface controller event log
    IF_EVENTLOG.XML
    FC interface controller stats log
    IF_STATS.TXT
    FC interface controller trace log
    IF_TRACE.TXT
    Interface Manager card event log
    EventLog.xml
    Interface Manager card trace log
    TraceLog.xml
    Interface Manager card history log
    ArchiveLog.xml
  8. Use the quit command to logoff the ftp session.

Updating firmware

You can use the CLI to update the firmware of the Interface Manager card and other library hardware. This procedure involves three steps:
  1. Use HP StorageWorks Library and Tape Tools (L&TT) to acquire the latest firmware file. Click here to acquire L&TT.

    Refer to the documentation included with L&TT for instructions on how to acquire the latest firmware for your hardware.

  2. Use ftp to transfer the firmware file to a temporary storage area in the Interface Manager card's memory.

    1. On any PC connected to the LAN, open a command shell.

    2. Navigate to the directory that the firmware you downloaded in Step 1 is located. (Refer to the L&TT documentation for the default location of downloaded firmware files.)

    3. Enter the following command: ftp <ipaddress> where <ipaddress> is the IP address of the Interface Manager card.

    4. Login with the following credentials:
      • User name: ftp

      • Password: Use your e-mail address

    5. After logging in, a command shell opens, displaying the anonymous ftp directory.

    6. If necessary, use the ls command to list the contents of the ftp directory.

    7. Enter the following command to turn on binary transfer mode: bin

    8. Enter the following command to copy the firmware file to the temporary location in the Interface Manager card's memory: put <filename> where <filename> is the filename of the firmware file.

    9. Use the quit command to logoff the ftp session

  3. Execute one of the following commands to download the firmware file from the Interface Manager card’s memory to the appropriate device:
NOTE: In the download mgmt command, "mgmt" refers to the Interface Manager card.
NOTE: Firmware files have a special header that prevents them from being downloaded to the wrong type of device.

Generating support tickets

The Interface Manager card can generate a support ticket for various library components. This feature is only available through the CLI.

You can generate a support ticket for drives, FC interface controllers, the library itself, and the Interface Manager card. The command used specifies the type of support ticket to be generated. When a support ticket is generated, the Interface Manager card saves the file sticket.ltt to a temporary location in the Interface Manager card's memory. Use anonymous ftp to retrieve the support ticket, and then use L&TT to view it.
NOTE: Each time a support ticket is generated, it uses the same filename (sticket.ltt) and overwrites the previous support ticket.
To generate a support ticket from the CLI, do the following:
  1. Execute one of the following commands, depending on the type of support ticket to be created:
    NOTE: In the save mgmt lttsupportticket command, "mgmt" refers to the Interface Manager card.
  2. The Interface Manager card generates the file sticket.ltt and stores it in a temporary location in the Interface Manager card's memory.

    Use ftp to retrieve the sticket.ltt file and copy it to a location on your PC or network.

    1. On any PC connected to the LAN, open a command shell.

    2. Navigate to the directory that you want to store the support ticket in. This is typically (but not necessarily) the logs directory found under the installation directory of L&TT.

    3. Enter the following command: ftp <ipaddress> where <ipaddress> is the IP address of the Interface Manager card.

    4. Login with the following credentials:
      • User name: ftp

      • Password: Use your e-mail address

    5. After logging in, a command shell opens displaying the anonymous ftp directory.

    6. If necessary, use the ls command to list the contents of the ftp directory.

    7. Enter the following command to turn on binary transfer mode: bin

    8. Enter the following command to copy the firmware file to the temporary location in the Interface Manager card's memory: get sticket.ltt

      The file is copied to the directory you navigated to in Step b.

    9. Enter quit to logoff the ftp session.

  3. Use L&TT to view the support ticket. Click here to acquire L&TT.

    Refer to the documentation included with L&TT for instructions on how to view a support ticket.

Using secure manager functions

Secure Manager for ESL gives the ESL library administrator control over which drives in the library may be accessed by the various backup hosts on the SAN. There are two levels of Secure Manager for ESL implemented with the Interface Manager card:
  • Basic Secure Manager does not require a license key and is activated automatically. With Basic Secure Manager, you can configure whether or not a particular host Host Bus Adapter (HBA) can access the library. However, Basic Secure Manager does not allow you to control whether a particular host HBA can see individual components within the library. Basic Secure Manager provides an "all or nothing" level of control. Basic Secure Manager is accessible through the CLI.

  • Advanced Secure Manager requires Command View ESL to use and is not available through the CLI. See Secure Manager for ESL for more information.

Accessing basic secure manager through the CLI

You can use the CLI to map a Host Bus Adapter (HBA) of a backup host to the library. When you map a host, you give it full access to the entire library. When you unmap a host, you deny it access to the entire library.

To map a host, do the following:
  1. Use the following command to show a list of all hosts that are known by the system:

    show host info

    Click here for more information on the show host info command

    This command lists all known hosts and assigns each one a host number. You will need the host number to map the host.

    The Interface Manager card keeps track of all hosts that attempt to access the library. It is possible that some hosts in the SAN are not recognized by the Interface Manager card. If a host that you need to map is not recognized by the system, use the following command to add the host: create host <nodewwn> <hostname>

    Click here for more information on the create host command

    The arguments for the create host command are as follows:
    • nodewwn Specify the node world wide name. World wide names are specified as 16 hex digits. For example, "1234567890ABCDEF" is a well-formed world wide name. This operand is required.

    • hostname Specify the name of the host. The host name may contain letters, numbers, and '_' characters. The maximum length for a host name is 19 characters. This operand is required.

    After creating a new host, use the show host info command to determine the host number of the new host.

  2. Use the following commands to map or unmap a host, respectively:
    • map host <host number>

    • unmap host <host number>

    where <host number> is the number of the host you want to map or unmap that you determined in step 1.

Legal Disclaimer: Products sold prior to the November 1, 2015 separation of Hewlett-Packard Company into Hewlett Packard Enterprise Company and HP Inc. may have older product names and model numbers that differ from current models.

Provide feedback

Please rate the information on this page to help us improve our content. Thank you!
Document title: HP StorageWorks Interface Manager - Command Line Interface
Document ID: emr_na-c00043782-1
How helpful was this document?
How can we improve this document?
Note: Only English language comments can be accepted at this time.
Please wait while we process your request.