SANsurfer iSCSI HBA Manager User’s Guide
Management Tool 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, July 27, 2004
Revision B, October 17, 2008
ChangesSections Affected
Revision B Changes:
Converted to new user’s guide template.All
Modified guide title and subtitle.Title page, page headers
Updated most screen shots.All
1. Introduction section updated and expanded to
include new material such as documentation conventions used in the guide, intended audience,
location of license agreements, and how to obtain
technical support.
3. SANsurfer iSCSI HBA Manager Overview sec-
tion updated and expanded to include new features and support for Windows Server 2008.
2. System Overview and 4. System Requirements
sections combined into one section.
5. Installing SANsurfer iSCSI HBA Manager sec-
tion updated and expanded to include installation
using a command line interface, and instructions
for updating SANsurfer iSCSI HBA Manager from
the Web or CD. Removed obsolete information
regarding SANsurfer Control iX, updated installation configurations table, and removed obsolete
Windows NT and NetWare agent information.
6. Getting Started section updated and expanded.
Added support for Windows Server 2008.
1 Introduction
2 SANsurfer iSCSI HBA Manager Overview
3 System Requirements and Installation Checklist
4 Installing SANsurfer iSCSI HBA Manager
5 Getting Started
Page iiIS0054602-00 B
S
SANsurfer iSCSI HBA Manager User’s Guide
Management Tool for QLogic iSCSI Host Bus Adapters
Removed the following sections that were included
in rev. A of the user’s guide. Information from these
sections is now in the SANsurfer iSCSI HBA Manager help system:
7. Setting Up Connections
8. Monitoring the Connections
9. Displaying Host, HBA Port, Device, and LUN
Information
11. Updating the HBA
10. Performing Diagnostics section expanded to
include procedures for viewing IPv6 logs and setting diagnostic test parameters for running loopback and read/write buffer tests.
12. Troubleshooting section expanded to include a
list of troubleshooting tools, procedures for verifying that the HBA driver and iqlremote are installed,
using debug to trace user interface and agent
activity, and retrieving records such as the HBA
core dump, Flash NVRAM, and HBA crash.
Added Windows 2008 support to FAQ table.A Frequently Asked Questions
Moved Appendix C Contacting QLogic information
to 1 Introduction.
—
6 Performing Diagnostics
7 Troubleshooting
“Technical Support” on page 1-4
Added index entries.Index
IS0054602-00 BPage iii
SANsurfer iSCSI HBA Manager User’s Guide
Management Tool for QLogic iSCSI Host Bus Adapters
The SANsurfer iSCSI HBA Manager User’s Guide describes SANsurfer® iSCSI
HBA Manager, a component of the QLogic
HBA Manager is a comprehensive tool for configuration and management of
QLogic SANsurfer iSCSI host bus adapters (HBAs) used in storage area networks
(SANs).
NOTE:
Throughout this guide, HBA and adapter are used interchangeably, as are
the terms target and device.
Intended Audience
The information in this guide is intended for OEMs, field service personnel, and
customers who are installing and using QLogic hardware and SANsurfer iSCSI
HBA Manager. Users should be familiar with the hardware installation and the
operating systems where HBAs are installed.
®
SANsurfer tool. SANsurfer iSCSI
What’s in This Guide
This guide contains the basic information you need to get started with the
SANsurfer iSCSI HBA Manager user interface (UI). For detailed information about
the features and functionality not covered in this guide, refer to the help system
(see “What’s in the Help System” on page 5-9).
This introductory section specifies the intended audience, explains the
typographic conventions used, lists related documents, refers you to the QLogic
license agreements, and provides technical support and contact information.
The remainder of the user's guide contains the following chapters and appendix:
2 SANsurfer iSCSI HBA Manager Overview provides a general product
overview and describes in detail its features.
3 System Requirements and Installation Checklist lists the hardware and
software requirements needed for optimum SANsurfer iSCSI HBA Manager
performance, and provides a checklist for installation.
IS0054602-00 B1-1
1 – Introduction
What’s in This Guide
4 Installing SANsurfer iSCSI HBA Manager describes how to install, update,
5 Getting Started describes how to customize SANsurfer iSCSI HBA
6 Performing Diagnostics provides procedures for pinging targets, viewing
7 Troubleshooting presents common troubleshooting questions and
Appendix AFrequently Asked Questions lists and provides the answers to
S
and uninstall SANsurfer iSCSI HBA Manager.
Manager. It includes starting and exiting the SANsurfer iSCSI HBA Manager
user interface, getting help, setting security, and setting the options that
activate each time you start SANsurfer iSCSI HBA Manager.
various logs, and setting up and running loopback and read/write buffer
tests.
answers. It also provides the procedures for tracing the SANsurfer iSCSI
HBA Manager user interface and agent activity (if directed to do so by your
authorized service provider), and for retrieving records such as the HBA
core dump, Flash NVRAM, and HBA crash.
frequently asked questions about SANsurfer iSCSI HBA Manager.
Glossary lists common hardware, software, and iSCSI terms that are used in
SANsurfer iSCSI HBA Manager.
In addition, at the end of this guide is an index to help you easily locate the
information you need.
Typographic Conventions
This guide uses the following documentation conventions:
NOTE:
Notes provide additional information.
CAUTION!
Cautions indicate that failure to follow instructions might result in damage to
data or equipment.
Tex t i n blue font indicates a hyperlink (jump) to a figure, table, or section in
this guide, and links to Web sites are shown in underlined blue
example:
Table 9-2 lists problems related to the SANsurfer iSCSI HBA Manager
user interface and remote agent.
. For
See “Pinging Targets” on page 6-2.
For more information, visit www.qlogic.com.
1-2IS0054602-00 B
A
1 – Introduction
License Agreements
Tex t i n bold font indicates SANsurfer iSCSI HBA Manager user interface
elements such as a menu items, buttons, check boxes, or column headings.
For example:
Click the Start button, point to Programs, point to Accessories, and
then click Command Prompt.
Under Notification Options, select the Warning Alarms check box.
Tex t i n sans serif font indicates a file name, directory path, keyboard key,
or command line text. For example:
To connect to a group of hosts listed in a host group file (.hst), type
SANsurfer -g path
Press CTRL+SHIFT+T.
Tex t i n italics indicates emphasis, terms, document titles, or help topic titles.
For example:
For a complete listing of license agreements, refer to the QLogic
Software End User License Agreement.
For details, see Displaying HBA Information in the help system.
Related Documents
Table 1-1 lists other documents you may find helpful when installing or using
SANsurfer iSCSI HBA Manager.
Part Number
or Name
IS0054501-00
Rev C
readme.txtSANsurfer notes included with SANsurfer iSCSI HBA Manager.
and then press ENTER.
Table 1-1. Related Documents
Title
Quick Start Guide: iSCSI HBA Installation (PDF).
Release notesSANsurfer iSCSI HBA Manager Release Notes provide details
SN0054621-00
Rev. E
License Agreements
For a complete listing of all license agreements affecting this product, refer to the
QLogic Software End User License Agreement.
IS0054602-00 B1-3
about modifications made since the previous version. Separate
release notes are provided for each operating system.
SANsurfer iSCSI HBA CLI User’s Guide provides interactive menu
and non-interactive mode options for the command line interface.
1 – Introduction
Technical Support
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.
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.
S
, you
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
Support contact information for other regions of the world is available at the
QLogic Web site: http://support.qlogic.com
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-4IS0054602-00 B
2SANsurfer iSCSI HBA
Manager Overview
This section provides a general overview of the SANsurfer iSCSI HBA Manager
product, and describes its features in detail.
General Overview
QLogic’s SANsurfer iSCSI HBA Manager is a user-based interface tool that
configures and manages both QLogic iSCSI host bus adapters and their attached
devices within a storage area network (SAN) environment. In addition:
SANsurfer iSCSI HBA Manager works with the Windows
Server 2003, Windows Server 2008, Windows Vista, Red Hat
®
Linux, and Solaris
multiple operating systems, it provides control of heterogeneous
environments.
SANsurfer iSCSI HBA Manager is a client/server tool. The networking
capability of the tool provides centralized management and configuration of
the entire SAN.
SPARC® operating systems. Because the tool supports
®
2000, Windows
®
Linux®, SLES
Features
SANsurfer iSCSI HBA Manager offers the features described in these sections:
“Asset Management” on page 2-2
“Configuration Management” on page 2-2
“Statistics” on page 2-3
“Diagnostics” on page 2-3
“HBA State and Target Session Connection State Monitoring” on page 2-3
“Additional Features” on page 2-3
IS0054602-00 B2-1
2 – SANsurfer iSCSI HBA Manager Overview
Features
Asset Management
SANsurfer iSCSI HBA Manager allows you to connect to and disconnect from
local and remote hosts. It provides information about connected hosts and their
attached QLogic iSCSI HBAs, including connected devices and LUNs. Additional
features include:
HBA-level alias support for simple, user-friendly name identification.
Automatic iSCSI agent discovery.
Configuration Management
SANsurfer iSCSI HBA Manager allows you to configure local and remote systems.
With SANsurfer iSCSI HBA Manager, you can:
Configure QLogic iSCSI HBAs, HBA ports, and attached iSCSI targets using
a configuration wizard.
Configure HBA port boot settings (BIOS and FCode) and boot targets,
including acquiring boot targets via DHCP.
S
Clone all or parts of a pre-saved HBA configuration for HBA replacement,
quick configuration duplication on multiple HBA ports across multiple hosts,
or to ensure consistent configurations.
Save port network, boot, and target configuration settings without card reset.
Display LUN properties.
Update HBA firmware, driver, ROM, BIOS, and FCode.
Update BIOS boot targets.
Restore factory defaults, fully or selectively.
Update multiple HBA ports to a specific configuration at the same time.
Display target redirection information.
Ability to display and log into multiple Internet Storage Names Service
(iSNS) target portals to the same target.
Ability to retrieve and display all discovered target portals from a Send
Target discovery.
Ability to easily duplicate target portal connections to a target for multiple
connections.
Ability to select which target portals to log into from a discovered targets list
acquired from Send Target discovery and iSNS discovery.
2-2IS0054602-00 B
A
Statistics
SANsurfer iSCSI HBA Manager provides statistics for each HBA. These statistics
can be collected automatically or on request, and can be reset at any time.
Diagnostics
SANsurfer iSCSI HBA Manager provides diagnostics that enable you to test the
HBAs and connected devices. Use the SANsurfer iSCSI HBA Manager
diagnostics to:
Ping a target, which verifies that there is connectivity between an HBA port
View the address resolution protocol (ARP) cache, which keeps a record of
View the connection error log, which lists the 100 latest connection errors for
Perform read/write buffer tests.
2 – SANsurfer iSCSI HBA Manager Overview
Features
and a target.
host port connections with other hardware (such as targets) on the network.
an HBA port.
Perform internal and external loopback tests.
View the IPv6 logs for information and assistance with IPv6 configurations:
Destination Cache
Neighbor Cache
Router List
Prefix List
Retrieve HBA diagnostics information.
HBA State and Target Session Connection State Monitoring
SANsurfer iSCSI HBA Manager monitors connected QLogic iSCSI HBAs and their
targets and informs you of their state. For HBAs, the state color indicates bad
(red), unknown (blue), warning (yellow), or good (green).
Additional Features
Additional SANsurfer iSCSI HBA Manager features allow you to:
Save host configuration to a text file.
Save and load detailed host configuration of the iSCSI HBAs and connected
targets to and from a binary file for later offline viewing.
Specify hexadecimal CHAP secrets.
View detailed host configuration differences of the iSCSI HBAs and
connected targets from a prior saved configuration.
View Vendor Private Data (VPD) on iSCSI HBAs for available data, if
provided by the OEM/manufacturer.
IS0054602-00 B2-3
2 – SANsurfer iSCSI HBA Manager Overview
Features
Configure, test, check status, and diagnose connections to IPv6 iSCSI
targets on IPv6 enabled HBA cards, for example the QLE406xC cards.
Automatically check for SANsurfer iSCSI HBA Manager updates.
Manually check for SANsurfer iSCSI HBA Manager updates.
Manage iSCSI and Fibre Channel HBAs and Fibre Channel switches. Each
tool appears on its own tab in the HBA tree.
NOTE:
IPv6 features, as well as some other features, are not available and appear
dimmed if one of the following applies:
You are using inbox/ioctl module drivers with Red Hat 4 and 5 and SLES
10. (To obtain the driver version string, use the modinfo qla4xxx
command at the UNIX prompt. If you are using the inbox/ioctl module
drivers, its version string contains a d.)
You do not have ACB (Alternate Control Block) support with the proper
hardware configuration, drivers, and firmware.
You can access these features if you have the correct hardware
configuration and download the latest drivers and firmware from the QLogic
Web site.
S
2-4IS0054602-00 B
3System Requirements and
Installation Checklist
SANsurfer iSCSI HBA Manager is a collection of device drivers and management
software for controlling, configuring, and managing devices in a SAN environment
that uses QLogic iSCSI HBAs. Use the following Installation Checklist to help you
install all hardware and software properly and in the correct order. To see a list of
the required hardware and software, refer to the “System Requirements” on
page 3-4.
Installation Checklist
This section describes the installation process step-by-step. Depending on the
features you require, your configuration may not require all steps.
Step 1: Collect the Hardware and Software
Step 2: Install the Hardware
Step 3: Install the Driver
Step 4: Install and Run SANsurfer iSCSI HBA Manager
Step 5: Configure the Disks in the Operating System
Step 1: Collect the Hardware and Software
Collect the required hardware and software as listed in these sections.
Required Hardware
Collect the required hardware (see also “Hardware Requirements” on page 3-4).
In all cases, some combination of the following is required:
QLogic iSCSI.
HBA target devices such as disks, tape devices, RAID subsystems, iSCSI
routers, and so on.
Connectivity hardware such as cables, hubs, switches, and so on.
IS0054602-00 B3-1
3 – System Requirements and Installation Checklist
Installation Checklist
Required Software
Collect the required software (see also “Software Requirements” on page 3-5):
To discover and connect to iSCSI devices, you will need one of the following:
SANsurfer iSCSI HBA Manager
QLogic Fast!UTIL
SANsurfer iSCSI HBA Manager is a management utility that enables you to view,
manage, and diagnose QLogic HBAs. SANsurfer iSCSI HBA Manager also
configures QLogic iSCSI HBAs and target devices on the HBAs.
S
Step 2: Install the Hardware
Refer to hardware installation guides to install HBAs in host systems (see
“Related Documents” on page 1-3). Cable target devices through the combination
of hubs and switches in your configuration.
Verification: Before installing the device driver, verify the presence of HBAs at
power up using the QLogic Fast!UTIL utility.
To a cc es s Fast!UTIL, type ALT+Q or CTRL+Q during power up.
Fast!UTIL allows you to perform basic HBA configuration. Fast!UTIL can verify
device connectivity.
Step 3: Install the Driver
Refer to the appropriate software installation guide (see “Related Documents” on
page 1-3) and readme.txt file to install a device driver on host systems.
NOTE:
Some operating systems come from the operating system manufacturer
with a QLogic miniport device driver. To ensure support for the latest
QLogic HBA and SANsurfer tool features, install the most current device
driver. The most current device driver versions can be found at the
QLogic Web site (www.qlogic.com
Connections to iSCSI targets must be configured with SANsurfer iSCSI
HBA Manager or QLogic Fast!UTIL in order for them to be visible to the
operating system.
).
3-2IS0054602-00 B
3 – System Requirements and Installation Checklist
A
Installation Checklist
Verification: Verify that the HBAs recognize target devices by using the
operating system device configuration utilities, or use SANsurfer iSCSI HBA
Manager to display target devices found on an HBA.
Windows: On supported Windows systems, use the computer management
utility to view which target devices are configured on which HBAs, and to
view and format devices and LUNs that are found.
Linux: On supported Linux systems, open /var/log/messages to view
which target devices are configured on which HBAs. Entries are also created
for each HBA recognized by the driver. Each entry contains information
about target devices and LUNs that are found.
Solaris: On supported Solaris systems, open /var/adm/messages to
view which target devices are configured on which HBAs.
Step 4: Install and Run SANsurfer iSCSI HBA Manager
For complete installation instructions, see section 4 Installing SANsurfer iSCSI
HBA Manager.
SANsurfer iSCSI HBA Manager runs as both a tool with standalone (non-agent
mode) access to local system QLogic iSCSI HBAs and as a client/server tool. The
client tool runs on a hardware platform that supports Java™ and agents running
on each system that has QLogic HBAs.
If you are using SANsurfer iSCSI HBA Manager on a host system where HBAs
are installed, install the SANsurfer iSCSI HBA Manager tool (the user interface) on
the local host. Installing the SANsurfer iSCSI HBA Manager agent on the local
host is optional.
When it is installed on the local system, the agent is used instead of the non-agent
mode.
In Windows, the RPC service (ONC/RPC Portmapper) required by
SANsurfer iSCSI HBA Manager is installed automatically.
In Linux, the appropriate RPC libraries must be installed by the Linux
distribution. For information about installing RPC services before installing
SANsurfer iSCSI HBA Manager, see the Linux distribution documentation.
In Solaris SPARC, the /usr/sbin/rpcbind process is required for RPC
communication of the remote agent.
IS0054602-00 B3-3
3 – System Requirements and Installation Checklist
System Requirements
Step 5: Configure the Disks in the Operating System
When all hardware and configuration is complete for iSCSI subsystems, use the
appropriate operating system utilities to enable devices, assign drive letters or
logical names, initialize file systems, and so on, for each device or LUN on the
system.
System Requirements
For optimum performance, SANsurfer iSCSI HBA Manager requires the hardware
and software listed in this section:
“Hardware Requirements” on page 3-4
“Software Requirements” on page 3-5
“Supported QLogic HBAs” on page 3-6
Hardware Requirements
The minimum hardware requirements are as follows:
S
QLogic QLA4xxx iSCSI to PCI-X host bus adapters, see “Supported QLogic
HBAs” on page 3-6.
Single-processor or multiprocessor server or workstation:
Pentium
Server 2003, Windows Server 2008, Windows Vista, Red Hat Linux,
SUSE Linux, or Solaris x86.
Sun™ Ultra™ 60 for Solaris SPARC.
iSCSI devices, such as disks. SANsurfer iSCSI HBA Manager supports
most iSCSI devices. For a complete list of devices, see the QLogic SAN
Interoperability Guide, which can be downloaded from the QLogic Web site
(you will be asked to provide your e-mail address):
64 MB of physical RAM are required to run SANsurfer iSCSI HBA Manager;
256 MB are recommended. Running with less memory can cause disk
swapping, which severely effects performance.
Video card capable of 256 colors (16K colors recommended) and a
minimum screen resolution of 1024 x 768 pixels are required.
Approximately 100 MB of disk space.
®
III with 450 MHz or greater for Windows 2000, Windows
About 150 MB of disk space.
3-4IS0054602-00 B
A
Software Requirements
The minimum software requirements and conditions are as follows:
One of the following operating systems:
Windows 2000 Server or Advanced Server SP4+ (IA32)
Windows 2000 Server or Advanced Server SP4+ (x64)
Windows XP Professional (IA32)
Windows XP Professional (x64)
Windows Server 2003 Standard Edition or Enterprise Edition SP1
(IA32)
Windows Server 2003 Standard Edition or Enterprise Edition SP1
(x64)
Windows Server 2003 Standard Edition or Enterprise Edition, Release
2 (IA32)
Windows Server 2003 Standard Edition or Enterprise Edition, Release
2 (x64)
Windows Server 2008 Standard Edition or Enterprise Edition
Windows Vista (IA32)
Windows Vista (x64)
RHEL 3.0, 4.0, 5.0 (IA32)
RHEL 3.0, 4.0, 5.0 (x64)
RHEL 4.0, 5.0 (PPC)
SLES 9.0, 10.0 (IA32)
SLES 9.0, 10.0 (x64)
SLES 9.0, 10.0 (PPC)
Solaris SPARC 9, 10
Solaris x86 9, 10 (IA32)
Solaris x86 9, 10 (x64)
3 – System Requirements and Installation Checklist
System Requirements
QLogic QLA4xxx drivers (such as QLA4010C drivers), as appropriate for
your HBA.
Common desktop environment (CDE) to run SANsurfer iSCSI HBA Manager
user interface on Solaris systems.
TCP/IP protocol for remote management on all systems. It is not required for
local management.
Administrative privileges to install and to perform management functions.
Adobe
To view the help system, Internet Explorer
Communicator
IS0054602-00 B3-5
®
Reader® (version 2.1 or later) to view documentation.
®
(version 6.0 or later), Netscape
®
(version 8.1 or later), or Firefox® (version 2.0 or later).
3 – System Requirements and Installation Checklist
System Requirements
NOTE:
Use the Java runtime environment that is packaged with SANsurfer iSCSI
HBA Manager.
Supported QLogic HBAs
The QLogic iSCSI HBAs are collectively referred to as the QLA4xxx HBA, unless
otherwise noted. For a detailed list of supported QLogic HBAs, see the SANsurfer
HBA Support Matrix (Fibre Channel & iSCSI) on the SANsurfer CD-ROM.
S
3-6IS0054602-00 B
4Installing SANsurfer iSCSI
HBA Manager
Installing SANsurfer iSCSI HBA Manager consists of installing the SANsurfer
iSCSI HBA Manager user interface, a platform-specific agent, and help
components, as appropriate.
NOTE:
Before installing SANsurfer iSCSI HBA Manager, read and follow the
instructions in the documents listed in “Related Documents” on page 1-3, as
applicable.
This section provides the following information:
“Initial Installation” on page 4-1
“Web- and CD-based Installation Updates” on page 4-17
“Uninstalling SANsurfer” on page 4-24
Initial Installation
You can install the SANsurfer tool (which includes SANsurfer iSCSI HBA
Manager) using the files from the QLogic Web site or from the SANsurfer
CD-ROM.
The following information applies:
Install the same version of SANsurfer on all systems in the network.
Before installing SANsurfer, uninstall any previous versions of the SANsurfer
tool (for example, QMS 1.0 or QMS 2.0 (QMSJ)).
Installing and running SANsurfer Control iX and the SANsurfer iSCSI HBA
Manager user interface (interface only, not the agent) on the same system is
supported. When using only the SANsurfer iSCSI HBA Manager user
interface, this system monitors QLA4xxx HBAs on remote systems on the
same network.
This section on initial installation includes the following information:
“Installation Configurations” on page 4-2
“Installation Instructions” on page 4-3
“Installation Instructions Using CLI” on page 4-15
Installation Configurations
SANsurfer iSCSI HBA Manager supports both standalone and networked
configurations, as shown in Tab le 4 -1 . Install the software appropriate for your
configuration.