SANsurfer iSCSI HBA CLI User’s Guide
Command Line Interface for QLogic iSCSI Host Bus Adapters
Information furnished in this manual is believed to be accurate and reliable. However, QLogic Corporation assumes no
responsibility for its use, nor for any infringements of patents or other rights of third parties which may result from its
use. QLogic Corporation reserves the right to change product specifications at any time without notice. Applications
described in this document for any of these products are for illustrative purposes only. QLogic Corporation makes no
representation nor warranty that such applications are suitable for the specified use without further testing or
modification. QLogic Corporation assumes no responsibility for any errors that may appear in this document.
S
Document Revision History
Revision A, September 30, 2005
Revision B, November 10, 2005
Revision C, July 14, 2006
Revision D, May 7, 2007
Revision E, October 17, 2008
ChangesSections Affected
Revision E Changes:
Applied new user’s guide template.All
Updated guide title and subtitle.Title page, page headers
Enhanced and edited all content, including index.All
Removed all references to obsolete features
related to DNS and SLP.
Expanded Introduction chapter to include new
information.
Added supported operating systems Windows
Server 2008 and Windows PE.
Removed obsolete Linux attended installation section.
Removed Table 2-1.“Starting Non-interactive Mode” on page 3-2
Updated map of interactive menus and options.Table 4-1 on page 4-2
Added new firmware update option to Host Level Info & Operations menu.
All
Intended Audience, How This Guide is Organized
(Typographic Conventions, Related Documents),
License Agreements
“Supported Operating Systems” on page 1-4
“Installing on Red Hat/SUSE Linux/PPC” on
page 2-10
The command line interface (CLI) application is a simplified, condensed version of
the SANsurfer iSCSI HBA Manager graphical user interface (GUI). SANsurfer
iSCSI HBA CLI does not provide any features that require a GUI.
This introductory chapter covers the following:
“Intended Audience” on page 1-1
“How This Guide is Organized” on page 1-1
“Supported QLogic HBAs” on page 1-4
“Supported Operating Systems” on page 1-4
“License Agreements” on page 1-5
“Technical Support” on page 1-5
Intended Audience
This guide is intended for end users responsible for administration of QLogic
iSCSI HBAs.
How This Guide is Organized
The SANsurfer iSCSI HBA CLI User’s Guide is organized into the following
chapters and appendices:
1 Introduction provides a general overview of the product, lists the supported
QLogic HBAs and operating systems, and provides contact information for
technical support.
2 Installation and Removal provides step-by-step instructions for installing
and uninstalling SANsurfer iSCSI HBA CLI on Windows, Linux, and Solaris.
3 Getting Started describes the two modes used in SANsurfer iSCSI HBA
CLI: interactive and non-interactive.
4 Interactive Mode Commands provides detailed explanations and
examples of the command line options used in the menu-driven interactive
mode.
5 Non-Interactive Mode Commands provides detailed explanations and
examples of the command line options used in non-interactive mode.
SN0054621-00 E1-1
1 – Introduction
How This Guide is Organized
Appendix A Port- and HBA-level Parameters provides an alphabetic list of
the HBA port firmware parameters and their values.
Appendix B HBA Statistics provides an alphabetic list of the HBA statistics
shown when you select either the interactive mode Display HBA Statistics
option or the non-interactive mode -stat command.
Appendix C Target Parameters provides an alphabetic list of target
parameters, both fixed and configurable.
Appendix D Error Codes provides an alphabetic list of the error codes that
can occur while running SANsurfer iSCSI HBA CLI in both interactive mode
and non-interactive mode.
Appendix E Downloadable File Names lists, by file type and HBA, the typical
file names of downloadable files for QLogic iSCSI HBAs.
Appendix F Using Trace provides information for using trace to identify
application, HBA, and networking issues.
Following the appendices are a glossary of terms used and an index that will help
you quickly find the information you need.
S
Typographic Conventions
This guide uses the following typographic conventions:
Te x t i n bold font indicates a menu or menu item. For example:
From the HBA Import Menu, type the number for the Import option,
and then press ENTER.
Text in a sans serif font (Courier New) indicates CLI window text output.
For example:
Enter an IP Address:
Text in a bold sans serif font (Courier New) indicates user input (what you
type). For example:
Type y for the Stop on error[Y]? option.
Te x t i n ALL CAPITALS and sans serif font indicates the name of a key that
you press on the keyboard. For example:
Type the number for Host Information and then press ENTER.
Italicized text indicates either a document reference, glossary term, or
emphasis. For example:
The HBA port alias is a symbolic name you assign.
For a complete list, see the QLogic SAN Interoperability Guide.
1-2SN0054621-00 E
A
1 – Introduction
How This Guide is Organized
Italicized text within angle brackets indicates user-defined variables. For
example:
-arp <hba_port_inst>
Text within square brackets indicates optional parameters. For example
iscli [optional parameters] [Command Variable]
Text shown in blue indicates a cross-reference hyperlink to a Web site or to
another section of this guide. Click the hyperlink to jump to that site or
section. For example:
Visit the QLogic support Web site at support.qlogic.com
firmware and product updates.
For a list of target parameters, see Table C-1.
Related Documents
Table 1-1 lists other documents you may find helpful when installing or using
SANsurfer iSCSI HBA CLI.
Part Number
or Name
IS0054501-00
Rev C
readme.txtSANsurfer notes included with SANsurfer iSCSI HBA CLI.
Release notesSANsurfer iSCSI HBA CLI Release Notes provide details about
IS0054602-00
Rev. B
for the latest
Table 1-1. Related Documents
Title
Quick Start Guide: iSCSI HBA Installation (PDF).
modifications made since the previous version. Separate release
notes are provided for each operating system.
SANsurfer iSCSI HBA Manager User’s Guide provides details for
using the graphical user interface tool to manage QLogic iSCSI
HBAs.
SN0054621-00 E1-3
1 – Introduction
Supported QLogic HBAs
Supported QLogic HBAs
SANsurfer iSCSI HBA CLI is supported on the following QLogic HBAs:
Table 1-2. Supported HBAs
HBAPortsMedia
QLA40101Optical
QLA4010C1Copper
QLA40501Optical
QLA4050C1Copper
QLA4052C2Copper
QLE4060C1Copper
QLE4062C2Copper
S
QMC4052 (IBM)2Copper
QMH4062 (HP)2Copper
Supported Operating Systems
SANsurfer iSCSI HBA CLI is supported on the following operating systems:
®
Windows
Windows Server
Windows Server 2003, Standard or Enterprise Edition, SP2 (IA32, x64)
Windows Server 2008, Standard or Enterprise Edition (IA32, x64)
Windows XP Professional, SP2 (IA32, x64)
Windows Vista (IA32, x64) (Business and Enterprise editions)
Windows Preinstallation Environment (PE) 2.0, 2.1, PE 2004, PE 2005
Red Hat
Red Hat
Novell
PPC)
Solaris
Solaris x86 9, 10 (IA32, x64)
NOTE:
Throughout this guide, HBA may be shortened to adapter. The term device
often refers to targets.
2000 Server SP4+ (IA32, x64)
™
2003, Standard or Enterprise Edition SP1 (IA32, x64)
SUSE® Linux Enterprise Server (SLES) 8.0, 9.0, 10.0 (IA32, x64,
®
SPARC 9, 10
1-4SN0054621-00 E
A
License Agreements
Refer to the QLogic Software End User License Agreement for a complete listing
of all license agreements affecting this product.
Technical Support
Customers should contact their authorized maintenance provider for technical
support of their QLogic switch products. QLogic-direct customers may contact
QLogic Technical Support; others will be redirected to their authorized
maintenance provider.
For the latest firmware and software updates, visit the QLogic support Web site
listed in Contact Information.
Availability
QLogic Technical Support for products under warranty is available during local
standard working hours, excluding QLogic Observed Holidays.
1 – Introduction
License Agreements
Training
QLogic offers certification training for the technical professional for both the
QLogic iSCSI HBAs and switches. From the training link at www.qlogic.com
may choose Electronic-based Training or schedule an intensive “hands-on”
Certification course.
Technical Certification courses include installation, maintenance, and
troubleshooting QLogic SAN products. Upon demonstrating knowledge using live
equipment, QLogic awards a certificate identifying the student as a Certified
Professional. The training professionals at QLogic may be reached by e-mail at
tech.training@qlogic.com
Contact Information
Please feel free to contact your QLogic approved reseller or QLogic Technical
Support at any phase of integration for assistance. QLogic Technical Support can
be reached by the following methods:
Webhttp://support.qlogic.com
North America Contact Information
E-mailsupport@qlogic.com
Phone(952) 932-4040
, you
.
Support contact information for other regions of the world is available at the
QLogic Web site: http://support.qlogic.com
SN0054621-00 E1-5
1 – Introduction
Technical Support
S
The QLogic knowledge database contains troubleshooting information for the
QLogic HBAs. Access the database from the QLogic Web site, www.qlogic.com
Click the Support tab, and then use the search engine at the top of the page to
look for specific troubleshooting information.
.
1-6SN0054621-00 E
2Installation and Removal
This section provides procedures for the following:
“Installing SANsurfer iSCSI HBA CLI” on page 2-1
“Removing SANsurfer iSCSI HBA CLI” on page 2-12
Before you can run SANsurfer iSCSI HBA CLI, ensure that your system meets the
following requirements:
HBAs are installed.
HBA drivers are installed.
To install SANsurfer iSCSI HBA CLI, the PC hard disk must have about 1
MB free space.
NOTE:
SANsurfer iSCSI HBA CLI is designed to configure QLogic HBAs on the
local machine (where it is installed). It cannot configure HBAs on remote
machines.
Installing SANsurfer iSCSI HBA CLI
This section on SANsurfer iSCSI HBA CLI installation includes the following
information:
“Downloading the Installation Package” on page 2-1
“Installing on Microsoft Windows” on page 2-4
“Installing on Red Hat/SUSE Linux/PPC” on page 2-10
“Installing on Solaris SPARC/Solaris x86” on page 2-10
Downloading the Installation Package
Follow the procedure in this section to download the SANsurfer iSCSI HBA CLI
installation package from the QLogic Web site.
To download the installation package:
1.From the QLogic home page (www.qlogic.com
2.Select your HBA.
SN0054621-00 E2-1
), click Downloads.
2 – Installation and Removal
Installing SANsurfer iSCSI HBA CLI
3.Under Drivers, Management Tools, and API Libraries: click the
appropriate operating system.
4.In the SANsurfer iSCSI row of the Management Tools table, in the Download column, click Download.
SANsurfer iSCSI HBA CLI shows the End User License Agreement box.
5.Scroll to the bottom, and then click Agree.
SANsurfer iSCSI HBA CLI shows the File Download dialog box.
6.Click Save. Select a directory on your system and download the file.
The installation package has the following naming convention:
2 – Installation and Removal
Installing SANsurfer iSCSI HBA CLI
When finished, the installer shows the InstallShield Wizard Completed
window, as shown in Figure 2-6.
S
Figure 2-6 Install Wizard: Complete
7.Click Finish.
8.Restart your computer.
2-8SN0054621-00 E
A
Windows Command Line Installation
You can install SANsurfer iSCSI HBA CLI from the command prompt using the
Microsoft Windows Installer (MSI). Use one of the following methods:
“Standard Windows Interactive (CLI) Installation” on page 2-9
“Quiet or Unattended Windows Installation” on page 2-9
“Passive Windows Installation” on page 2-9
“Overwrite Previous Windows Installations” on page 2-10
NOTE:
You can also configure the installation using MSI commands. To see a
summary of MSI commands, at the command prompt, type: msiexec.
To obtain more information about MSI, visit the Microsoft Web site.
Standard Windows Interactive (CLI) Installation
To begin a standard installation of SANsurfer iSCSI HBA CLI on a Microsoft
Windows operating system, at a command line, type one of the following:
2 – Installation and Removal
Installing SANsurfer iSCSI HBA CLI
SANsurferCLI.msi
msiexec /i SANsurferCLI.msi
The default directory for SANsurfer iSCSI HBA CLI application is:
Program files\QLogic Corporation\SANsurferCLI
If you want a different directory, type it in the command line. For example:
SANsurferCLI.msi INSTALLDIR="directory"
The preceding command installs SANsurfer iSCSI HBA CLI in the directory
named directory. Use full path names.
Quiet or Unattended Windows Installation
Type the following for a quiet (silent) installation using default values. For
example, the following command installs silently using defaults and does not show
any errors:
SANsurferCLI.msi /q
Passive Windows Installation
Type the following for a passive installation using default values. For example:
SANsurferCLI.msi /passive
Installs with minimum interaction, showing only the progress bar and any errors.
SN0054621-00 E2-9
2 – Installation and Removal
Installing SANsurfer iSCSI HBA CLI
Overwrite Previous Windows Installations
Type the following for an installation that overwrites any previous installations
without asking for confirmation. Type:
SANsurferX-AgentOnly.msi /i FORCEINSTALL=TRUE
Installing on Red Hat/SUSE Linux/PPC
SANsurfer iSCSI HBA CLI installation on a Linux system requires that you use the
“quiet” installation method. This method ensures that, if needed, the Linux driver
interface module (ioctl module) is also installed.
To install quietly on Linux:
1.Unzip and untar the iSCSI CLI gzipped tar bundle as follows:
tar -xvzf
2.To start the installation, type:
./iscli.dkms.install.sh install
S
Installing on Solaris SPARC/Solaris x86
You can install SANsurfer iSCSI HBA CLI on a Solaris SPARC or x86 system with
one of the following methods:
“Solaris Attended Installation” on page 2-10
“Solaris Silent Installation” on page 2-11
Solaris Attended Installation
Follow this procedure from the command prompt to install SANsurfer iSCSI HBA
CLI on a Solaris SPARC/Solaris x86 operating system.
To install attended on Solaris:
1.To uncompress the package you downloaded in “Downloading the
Installation Package” on page 2-1, type the following:
uncompress iscli-AA.BB.CC-DD_solaris_sparc_x86.Z
2.To install iSANsurfer iSCSI HBA CLI on a Solaris SPARC/Solaris x86
operating system, type the following:
pkgadd -d iscli-AA.BB.CC-DD_solaris_sparc_x86
Solaris puts the files in the following directory:
/opt/QLogic_Corporation/SANsurferiCLI
It also adds this directory to the execution path.
2-10SN0054621-00 E
A
Solaris Silent Installation
This section contains a pkgadd (SOLARIS) example for silent installation.
To install silently on Solaris:
1.Create the following two files:
response.txt
noask_pkgadd.txt
2.Run the pkgadd command.
3.Create the response.txt file with contents of first question of arch, for
example:
<BOF> 1 <EOF>
4.Create the noask_pkgadd.txt file with contents:
<BOF> action=nocheck <EOF>
5.Type the command to Install with the two additional (required) files:
2 – Installation and Removal
Installing SANsurfer iSCSI HBA CLI
pkgadd -d ./<Install Package Filename> -n -a
./noask_pkgadd.txt < ./response.txt
For example:
pkgadd -d ./iscli-1.1.00-11_solaris_sparc_x86 -n -a
./noask_pkgadd.txt < ./response.txt