Q-Logic FC HBA CLI User Manual

S i m p l i f y

SANsurfer FC HBA CLI

User’s Guide

Command Line Interface for QLogic Fibre Channel Host Bus Adapters


		SN0054614-00 F	Page i

SANsurfer FC HBA CLI User’s Guide

Command Line Interface for QLogic Fibre Channel 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.

Apple, Finder, Mac OS, Macintosh, and Power Mac registered trademarks, and Safari is a trademark of Apple, Inc., registered in the U.S. and other countries.

EMC is a registered trademark of EMC Corporation.

Intel and Pentium are trademarks of Intel Corporation in the U.S. and other countries. Linux is a registered trademark of Linus Torvalds.

Microsoft, Windows, Windows NT operating system, Windows 2000 operating system, Windows Server 2003 operating system, Windows XP Professional operating system, and Windows Vista operating system are registered trademarks of Microsoft Corporation in the United States and other countries.

Novell and NetWare are registered trademarks of Novell, Inc.

IBM and PowerPC are registered trademarks of International Business Machines Corporation in the United States, other countries, or both.

QLogic, the QLogic logo, QLA, and SANsurfer are registered trademarks of QLogic Corporation. Red Hat and all Red Hat-based are trademarks or registered trademarks of Red Hat, Inc.

Solaris is a registered trademark of Sun Microsystems, Inc., in the United States and other countries

SPARC is a registered trademark of SPARC International, Inc. Products bearing SPARC trademarks are based on an architecture developed by Sun Microsystems, Inc.

StuffIt is a registered trademark of Smith Micro Software, Inc. SuSE is a registered trademark of SuSE Linux AG.

VMware is a registered trademark of VMware, Inc. in the United States and/or other jurisdictions.

All other brand and product names are trademarks or registered trademarks of their respective owners.

Document Revision History

Revision A, August 20, 2004

Revision B, September 28, 2005

Revision C, June 7, 2006

Revision D, October 1, 2006

Revision E, February 1, 2007

Revision F, February 2008

Changes	Sections Affected


Revision F Changes:
Changed NVRAM to HBA Parameters.	All
Changed Option ROM to Flash.	All

First Published: March 2004

QLogic Corporation, 26650 Aliso Viejo Parkway, Aliso Viejo, CA 92656, (800) 662-4471 or (949) 389-6000

Page ii

SN0054614-00 F

SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters



Changed HBA No. to HBA Instance.	All
Changed SFF DMI to HBA transceiver details.	All
Updated supported QLogic HBA list.	Section 1.3
Updated supported operating system list.	Section 1.4
All non-interactive information moved from	Section 4, Section 5
Section 4 to Section 5.
Command line options put in alphabetical order.	Table 2-1, Section 4
Added Appendix B: XML Format 2.	Appendix B
Added port virtualization (NPIV) information.	Section 4.14, Section 5.3.33
Added support for Red Hat Linux REL 5.1.	Section 3.2.2
Removed installation/uninstallation instructions for	Section 3.2.3
Solaris SPARC 6 and 7.
Added NPIV information.	Section 4.14.1
Added OS LUN Name (Solaris and Linux).	Section 4.4
Added guide overview section, including a descrip-	Section 1.2
tion of what’s in the guide and documentation con-
ventions used.
Added interactive mode exit codes listing.	Appendix C
Moved tables other than help commands from	Section 4
Help Commands appendix to appropriate interac-
tive commands sections.
Expanded iiDMA settings information.	Section 4.5
Added Virtual Menu information.	Section 4.14
Expanded HBA parameter templates information.	Section 4.10.5
Expanded diagnostic testing information.	Section 4.12
Revision E Changes:
Expanded product description.	Section 1.1
Split supported HBAs and operating systems into	Section 1.3, Section 1.4
two sections. Updated list of supported operating
systems.
Added system requirements section.	Section 1.5

SN0054614-00 F

Page iii

SANsurfer FC HBA CLI User’s Guide

Command Line Interface for QLogic Fibre Channel Host Bus Adapters

Changed bullets describing interactive and non-interactive modes.

Clarified the note about starting SANsurfer FC HBA CLI on a Solaris console serial port.

Added Macintosh column to Table 2-1.

Added support for Linux IOCTL module driver and driver on the OS installation CD (inbox driver).

Split Windows command line installation into two sections (standard and silent). Changed installation instructions. Added new parameters to command line for silent installation.

Split Solaris installation and uninstallation into three sections:

Solaris SPARC 6 and 7

Solaris SPARC 8, 9, 10 Solaris x86 8, 9, 10

Added Mac OS X command line installation instructions.

In Windows uninstall (standard), added how to invoke the exe package and remove the installed features.

In Windows uninstall (command line), changed the uninstall directions.

Added Mac OS X instructions to manually uninstall the package.

Replaced node name, port name, WWPN, and WWNN with variables (xx) in screen shots for security purposes.

Added a note to Display LUN List and Selective LUNs sections defining the maximum number of LUNs supported by the Solaris QLA and QLC drivers.

Added text to the Target Persistent Binding section defining the number of targets and the range of target IDs for Solaris, which is based in the HBA type.

Changed Boot Device Selection to Boot Device

Settings.

Section 2.2, Section 2.3

Section 2.2

Section 2.3

Section 3, Section 4, Section 5

Section 3.2.1.2

(These Solaris versions no longer supported.) Section 3.2.3.1, Section 3.3.3.1

Section 3.2.3.2, Section 3.3.3.2

Section 3.2.4.2

Section 3.3.1.1

Section 3.3.1.2

Section 3.3.4

Section 4

Section 4.7

Section 4.6, Section 4.6.2

Section 4.8

Page iv

SN0054614-00 F

SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters



Expanded Save/Update Flash section to list which	Section 4.10
OSs and HBAs save/update flash, BIOS, or the
option ROM image.
Added description and preparation instructions for	Section 4.12.1.1, Section 4.12.2
loopback and read/write buffer tests. Added
description of these test results.

The following options and commands were added in Rev. E:

Host Topology (command line option -tp)		Section 4.1.2, Section 5.3.31
HBA Alias (command line option -ha)		Section 4.2.1.2, Section 5.3.14
HBA Port Alias (command line option -pa)		Section 4.2.1.3, Section 5.3.25
SFF DMI (command line option -dm)		Section 4.12, Section 5.3.5

The following options and commands were changed in Rev. E:
Host Information (command line option -g):		Section 4.2.1
Host Information (command line option -g):		Section 4.2.1
removed QLogic direct driver version from the list
of displayed information.
For Host Configuration (command line option -z),		Section 4.2
made the following changes to the list of displayed
information:
Added VPD information to display HBA information
(command line option -I).
Added view driver settings (command line option
-fg).
Removed run loopback test (command line option
-kl).
Removed run read/write test (command line option
-kr).
Removed display and change HBA statistics (com-
mand line option -gs).
Removed display and change link status (com-
mand line option -ls).
Also changed the list order to reflect the order in
which the commands are displayed.
Show HBA Information (command line option -i):		Section 4.2, Section 4.3.1
Added HBA Alias and Port Alias to list of shown
information.
Changed PCI bus number to PCI device number.
Show Device List (command line option -t): added		4.5, 4.4.1
Serial Number to the list of displayed information.

SN0054614-00 F

Page v

SANsurfer FC HBA CLI User’s Guide

Command Line Interface for QLogic Fibre Channel Host Bus Adapters



Configure HBA Settings (-n): added option to		4.7.1, Section 5.3.22
restore the BIOS (QLA/QLE/QEM24xx HBAs).
Selective LUNs (command line option -m): added		4.8.1.2, Section 5.3.21
ALL option to command line to view all selective
LUNs for all HBA ports.
Set Boot Device (-e): removed references to OSs		4.9.2.1.1
from the third paragraph; this command now
applies to all OSs.
Diagnostics (command line options -kl and -dr):		4.17.1.2.1, 5.3.17
DataPattern (DP) parameter: added CRPAT,
CSPAT, and CJTPAT.		4.17.1.2.2, Table 5-5
DataSize (DS) parameter: added 128-byte value
for read/write buffer test. Added 128, 256, 512,
1024, 2048, 4096, 8192, 16384, 32768, 65535
byte values for loopback test. Added default val-
ues.		4.17.1.2.3, Table 5-5
TestCount (TC) parameter: changed the number of
loopback tests that can be run from 0–10000 to
0–65535.
TestIncrement (TI) parameter: increased test incre-		4.17.1.2.4, Table 5-5
ment for the loopback test from 1–10000 to
1–65535.
Output in XML Format (command line option -x):		Section 5.3.34
Added XML format for HBA alias (command line		Section 5.3.14
option -ha).		Section 5.3.25
Added XML format for HBA port alias (command
line option -pa).		Section 5.3.5
Added XML format for SFF DMI (command line
option -dm).		Section 5.3.31
Added XML format for host topology (command
line option -tp).
Target Persistent Binding (command line option		Section 5.3.24
-p): added ALL parameter to show target persistent
binding information for all HBA ports.

Page vi

SN0054614-00 F

SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters



Revision D Changes:
Operating systems supported:	All
Windows 2003 Server™ and Enterprise Server:
added x64; removed IEM64T and AMD64. Added
Windows® XP.
Red Hat™ Linux® AS: added x86_64; removed
IEM64T and AMD64.
SuSE® Linux Enterprise Server (SLES) 8 and 9:
added x86_64; removed IEM64T and AMD64.
Removed Power PC (PPC) SLES 8 and 9.
Solaris® SPARC®: removed v2.7; added version 7.
Solaris: removed 9 x86 and 10 x86; added x86,
v2.9, 10.
Removed the sentence “SANsurfer FC HBA CLI	Section 1
does not provide any features that require a GUI.”
Added QEM2462 and QLA/QLE2xx to list of sup-	Section 1
ported HBAs.
Changed standard (GUI) install instructions for	3.1.1.1
Windows operating systems.
Changed package name version to xx, which indi-	3.1.1.2, 3.1.3.1, 3.12.3.3
cates the current version of SANsurfer FC HBA
CLI.
Changed step 1 of the Mac OX installation proce-	3.1.4
dure. Removed the steps to create the root user,
log out of the current user account, and log into the
root user (previously steps 2, 3, 4).
Changed WWPN in example text to generic xx for	Section 4
consistency.
Changed name of Show System Information sub-	4.2.1, 4.2.2, 4.2.4, 4.2.5
menus.
Changed name of Boot Device to Boot Device	4.10
Selection in interactive mode.
HBA Parameters (Table 4-2, Table 6-12):	4.6.1.2, Table 5-9
Changed value of ResetDelay, ExecutionThrottle,
and LinkDownTimeOut parameters. Added
(QLA/QLE23xx HBAs) quantifier to EnableEx-
tended Logging and EnableLIPFullLogin parame-
ters.
Added a list of valid data patterns for the DataPat-	4.17.1.2.1, Table 5-6
tern diagnostic parameter (Table 4-4, Table 5-6).

SN0054614-00 F

Page vii

SANsurfer FC HBA CLI User’s Guide

Command Line Interface for QLogic Fibre Channel Host Bus Adapters

The following options and commands were changed in Rev. D:

Interactive mode commands: Changed instructions
and the example text to new port sorting and num-
bering scheme. No change to command function.
Non-interactive mode commands: Changed the
HBA Port No. parameter to HBA No. parameter
to support new port sorting and numbering
scheme. No change to command function.
Display HBA Settings (-c)		4.3, 5.3.3
DisplayHBA Information (-i)		4.4, 5.3.1
Display Device List (-t)		5 4.5, 5
Display LUN List (-l)		4.6, 5
Configure HBA Settings (-n)		4.7, 5
Target Persistent Binding (-p)		4.8, 5
Selective LUNs (-m)		4.9, 5
Boot Device Selection (-e)		4.10, 5
Driver Settings (-fs)		4.11, 5
View Driver Settings (-fg)		4.12, 5
Save/Update Flash (-b)		4.12, 5
Save/Update NVRAM (-r)		4.11, 5
Flash HBA Beacon (-a and -tb)		4.16, 5
Diagnostics (-kl and -kr)		4.17, 5
Statistics (-gs and -ls)		4.18, 5
Host Information (-g):		4.2.1, 4.2.4
Quantified that the direct driver version is only
displayed in Windows. No longer shows firm-
ware version. Shows new HBA number (HBA 0–n)
Display HBA Information (-I).		4.4, 5.4.8
The following new general information shows:
HBA instance, HBA ID, OptionROM BIOS version,
OptionROM FCode version, OptionROM EFI ver-
sion, OptionROM firmware version, total number of
devices.
The following general information has been
removed:	Device target count
The following VPD information has been removed:
Asset tag	End tag

Page viii

SN0054614-00 F

SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters



	Display LUN List (-l):	4.6
	In interactive mode, added target type to infor-
	mation displayed.
	Removed asset tag and end tag from list of
	VPD information.
	In example text, changed the first two option
	names of the Selective LUN(s) Display Configura-
	tion menu.
	In example text, changed the first two option
	names of the Selective LUN(s) Configuration -
	HBA/Device menu.
	Boot Device Selection (-eE): In interactive mode,	4.10, 5.3.6
	added new HBA Boot Device menu to example
	text.
	Target Persistent Binding (-p):	4.8, 5.9
	In interactive mode, changed first two option
	names of Target Persistent Binding menu in the
	example text.
	Driver Settings (-fs): Changed from bind By	4.11
	WWPN to bind by Port ID.
	Save/Update Flash (-b):	4.12, 5.3.2
	In interactive mode, removed secondary subti-
	tles of Option ROM Update menu in the example
	text.
	In non-interactive mode, added new all
	parameter following the boot parameter.
	Save/Update NVRAM (-r): In interactive mode,	4.11
	removed the secondary subtitles of the NVRAM
	Update Menu in the example text.

SN0054614-00 F

Page ix

SANsurfer FC HBA CLI User’s Guide

Command Line Interface for QLogic Fibre Channel Host Bus Adapters

Notes

Page x

SN0054614-00 F

Section 1	Introduction
1.1	Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		1-1
1.2	Guide Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		1-1
1.2.1		How this Guide is Organized. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	1-1
1.2.2		Documentation Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	1-2
1.3	Supported QLogic HBAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		1-4
1.4	Supported Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		1-4
1.5	System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		1-5
1.5.1		Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	1-5
1.5.2		Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	1-6
	1.5.2.1	Unsupported Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	1-6
1.6	Technical Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		1-7
1.6.1		Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	1-8
1.6.2		Training . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	1-8
1.7	Contact Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		1-8

Section 2	Getting Started
2.1	Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	2-1
2.2	Starting Interactive Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	2-1
2.3	Starting Non-interactive Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	2-3
2.4	Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	2-6

Section 3	Initial Installation
3.1	Downloading the Installation Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		3-1
3.2	Installing SANsurfer FC HBA CLI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		3-2
3.2.1		Windows Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-2
	3.2.1.1	Standard (GUI) Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-2
	3.2.1.2	Command Line Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-5
3.2.2		Linux Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-7
3.2.3		Solaris Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-8
	3.2.3.1	Solaris SPARC 8, 9, 10 Installation . . . . . . . . . . . . . . . . . . . . . .	3-8
	3.2.3.2	Solaris x86 9 and 10 Installation. . . . . . . . . . . . . . . . . . . . . . . . .	3-9
3.2.4		Macintosh Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-11
	3.2.4.1	Standard (GUI) Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-11
	3.2.4.2	Command Line Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-11

SN0054614-00 F

Page xi

SANsurfer FC HBA CLI User’s Guide

Command Line Interface for QLogic Fibre Channel Host Bus Adapters


3.3	. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Uninstalling SANsurfer FC HBA CLI		3-12
	3.3.1	Windows Uninstall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-13
	3.3.1.1	Standard (GUI) Uninstall. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-13
	3.3.1.2	Command Line Uninstall. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-13
	3.3.2	Linux Uninstall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-13
	3.3.3	Solaris Uninstall. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-13
	3.3.3.1	Solaris SPARC 8, 9, and 10 Uninstall. . . . . . . . . . . . . . . . . . . . .	3-14
	3.3.3.2	Solaris x86 8, 9, and 10 Uninstall . . . . . . . . . . . . . . . . . . . . . . . .	3-14
	3.3.4	Macintosh Uninstall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-15

Section 4	Interactive Commands
4.1	General Information Menu (Command Line Option -g) . . . . . . . . . . . . . . . .		4-2
4.1.1		Host Information (Command Line Option -g). . . . . . . . . . . . . . . . . . . .	4-2
4.1.2		Host Topology (Command Line Option -tp \| -topology) . . . . . . . . . . . .	4-3
	4.1.2.1	Display (Host Topology) (Command Line Option -tp \|
		-topology) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-4
	4.1.2.2	Save As Txt File (Command Line Option -b) . . . . . . . . . . . . . . .	4-8
	4.1.2.3	Save As XML File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-8
4.1.3		Generate Report (Command Line Option -z) . . . . . . . . . . . . . . . . . . .	4-9
	4.1.3.1	Generate Report (Per HBA Port) . . . . . . . . . . . . . . . . . . . . . . . .	4-9
	4.1.3.2	Generate Report (All HBAs) (Command Line Option -z) . . . . . .	4-17
4.1.4		Refresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-17
4.2	HBA Information Menu (Command Line Option -i) . . . . . . . . . . . . . . . . . . .		4-17
4.2.1		HBA General Information (per HBA Port) . . . . . . . . . . . . . . . . . . . . . .	4-18
	4.2.1.1	HBA Information (Command Line Option -i). . . . . . . . . . . . . . . .	4-18
	4.2.1.2	HBA Alias (Command Line Option -ha) . . . . . . . . . . . . . . . . . . .	4-18
	4.2.1.3	HBA Port Alias (Command Line Option -pa) . . . . . . . . . . . . . . .	4-19
	4.2.1.4	HBA VPD Information (Command Line Option -l and
		Reserved Word “vpd”) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-20
4.2.2		HBA Information (All HBAs). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-21
	4.2.2.1	Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-21
4.3	HBA Parameters Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		4-21
4.3.1		HBA Parameters (Per HBA Port). . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-22
	4.3.1.1	Display HBA Parameters (Command Line Option -c#). . . . . . . .	4-22
	4.3.1.2	Configure HBA Parameters (Command Line Option -n). . . . . . .	4-23
	4.3.1.3	Restore Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-29
4.3.2		HBA Parameters (All HBAs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-29

Page xii

SN0054614-00 F

SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters


4.4	. . . . . . . . . . . . . .Target/LUN List Menu (Command Line Options -t and -l)		4-30
	4.4.1	Target/LUN List (Per HBA Port). . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-31
	4.4.1.1	Per Target/LUN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-31
	4.4.1.2	Per Target/All LUNs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-32
	4.4.1.3	All Targets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-33
	4.4.2	Target/LUN List (All HBAs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-33
	4.4.2.1	Individual Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-33
	4.4.2.2	Individual LUN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-34
	4.4.2.3	All Targets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-35
	4.4.2.4	All Target(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-36
	4.4.2.5	All LUN(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-37

4.5Target Link Speed or iiDMA Settings Menu (Command Line Option -q) . . . 4-38

4.5.1	Configuring the iiDMA Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-39
4.5.2	HBA Port Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-40
4.5.3	HBA Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-41
4.5.3.1	Advanced Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-42
4.5.4	Target Link Speed – All HBAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-43
4.5.4.1	Target Link Speed – All HBAs – Basic Configuration . . . . . . . . .	4-43

4.5.4.2Target Link Speed – All HBAs – Advanced Configuration . . . . . 4-43

	4.5.4.3	iiDMA Settings – Disk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-45
4.5.5		iiDMA – All HBAs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-45
4.6	Target Persistent Bindings Menu (Command Line Option -p) . . . . . . . . . . .		4-45

4.6.1Target Persistent Bindings (Per HBA Port) (Command Line

Option -p). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-46

4.6.1.1Display Target Persistent Binding (Command Line

Option -p) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-46

4.6.1.2Target Persistent Bindings – Bind Target(s) (Command Line

Option -p) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-47

4.6.1.3Target Persistent Binding – Unbind Targets (Command Line

		Option -p) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-48
	4.6.2	Target Persistent Binding (All HBAs). . . . . . . . . . . . . . . . . . . . . . . . . .	4-48
	4.6.2.1	Display Target Persistent Binding. . . . . . . . . . . . . . . . . . . . . . . .	4-49
	4.6.2.2	Target Persistent Binding – Bind Targets . . . . . . . . . . . . . . . . . .	4-49
	4.6.2.3	Target Persistent Binding – Unbind Targets . . . . . . . . . . . . . . . .	4-49
4.7	Selective LUNs Menu (Command Line Option -m) . . . . . . . . . . . . . . . . . . .		4-49
	4.7.1	Selective LUNs (Per HBA Port) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-49
	4.7.2	Selective LUNs (All HBAs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-50
	4.7.2.1	Display LUN Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-50
	4.7.2.2	Manual Configure LUNs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-51
	4.7.2.3	Auto Configure LUNs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-51

SN0054614-00 F

Page xiii

SANsurfer FC HBA CLI User’s Guide

Command Line Interface for QLogic Fibre Channel Host Bus Adapters


4.8	. . . . . . . . . . . . . . . . . . . . . .Boot Device Menu (Command Line Option -e)		4-51
4.8.1		HBA Port Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-52
	4.8.1.1	Boot Device(s) (Per HBA Port) . . . . . . . . . . . . . . . . . . . . . . . . . .	4-52
	4.8.1.2	Configure Boot Device(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-53
4.8.2		Boot Device(s) (All HBAs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-54
4.9	Driver Settings Menu (Command Line Option -fg) . . . . . . . . . . . . . . . . . . . .		4-54
4.10	Utilities Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		4-56

4.10.1Flash Update (Per HBA Port or All HBAs) (Command Line

Option -b). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-56

4.10.2Flash Save (Per HBA Port) (Command Line Option -b and

Reserved Word “save”) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-56

4.10.3HBA Parameters Update (Per HBA Port or All HBAs) (Command

Line Option -r) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-57

4.10.4HBA Parameters Save (Per HBA Port) (Command Line Option

-r and Reserved Word “save”) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-57

4.10.5HBA Parameters Template (Per HBA or All HBAs) (Command

		Line Option -n and OEM Name) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-57
	4.10.5.1	Using HBA Parameter Templates. . . . . . . . . . . . . . . . . . . . . . . .	4-58
	4.10.6	Driver Update (Command Line Option -d). . . . . . . . . . . . . . . . . . . . . .	4-60
	4.10.7	Driver Rescan (Command Line Option -rs) . . . . . . . . . . . . . . . . . . . . .	4-60
4.11	Beacon Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		4-61
	4.11.1	Locate HBA – HBA Beacon (Command Line Option -a) . . . . . . . . . . .	4-61
	4.11.2	Locate Target(s) – Target Beacon (Command Line Option -tb). . . . . .	4-61
	4.11.2.1	Beacon Selected Target(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-62
4.12	Diagnostics Menu (Command Line Options -kl, -kr, and -dm) . . . . . . . . . . .		4-62
	4.12.1	Diagnostics Loopback Test (Command Line Option -kl) . . . . . . . . . . .	4-63
	4.12.1.1	Configure Loopback Test Parameters . . . . . . . . . . . . . . . . . . . .	4-64
	4.12.1.2	Run Loopback Test. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-66
	4.12.2	Diagnostics Read/Write Buffer Test. . . . . . . . . . . . . . . . . . . . . . . . . . .	4-66
	4.12.2.1	Configure Read/Write Test Parameters . . . . . . . . . . . . . . . . . . .	4-67
	4.12.2.2	Run Read/Write Buffer Test . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-71

4.12.3Diagnostics Transceiver Details – DMI (Command Line

		Option -dm) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-72
	4.12.3.1	Transceiver Details – General . . . . . . . . . . . . . . . . . . . . . . . . . .	4-72
	4.12.3.2	Transceiver Details – Details . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-73
4.13	Statistics Menu (Command Line Options -gs and -ls) . . . . . . . . . . . . . . . . .		4-76
	4.13.1	HBA Statistics – Monitoring (Command Line Option -gs) . . . . . . . . . .	4-76
	4.13.1.1	Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-76
	4.13.1.2	Show HBA Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-79

Page xiv

SN0054614-00 F

SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters


	4.13.2	. . . . . .Link Status (Command Line Option -ls)	. . . . . . . . . . . . . . . . . . 4-80
	4.13.2.1	Configuration . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . . . . . . 4-80
	4.13.2.2	Show Link Status . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . . . . . . 4-82
4.14	Virtual Menu (Command Line Option -vp) . . . . . . . .		. . . . . . . . . . . . . . . . . . 4-83
	4.14.1	Virtual Menu for HBA Instance . . . . . . . . . . . .	. . . . . . . . . . . . . . . . . . 4-85
	4.14.1.1	List Virtual Port(s) . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . . . . . . 4-85
	4.14.1.2	Delete Virtual Port(s) . . . . . . . . . . . . . . .	. . . . . . . . . . . . . . . . . . 4-86
	4.14.1.3	Create Virtual Port(s) . . . . . . . . . . . . . . .	. . . . . . . . . . . . . . . . . . 4-86
4.15	Help Menu (Command Line Option -h) . . . . . . . . . .		. . . . . . . . . . . . . . . . . . 4-87
	4.15.1	Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . . . . . . 4-88
	4.15.2	Exit Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . . . . . . 4-88
	4.15.3	About . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . . . . . . 4-88

Section 5	Non-interactive Commands
5.1	Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-1
5.2	Display System Information (Command Line Options -g, -z, and -tp) . . . . .	5-1
5.2.1	Host Information (Command Line Option -g). . . . . . . . . . . . . . . . . . . .	5-1
5.2.2	Host Configuration (Command Line Option -z) . . . . . . . . . . . . . . . . . .	5-2
5.2.3	Host Topology (Command Line Option -tp) . . . . . . . . . . . . . . . . . . . . .	5-3
5.2.4	Host Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-4
5.3	Command Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-5
5.3.1	-a (View or Toggle Beacon Status) . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-6
5.3.2	-b (Save or Update the Flash BIOS or Fcode) . . . . . . . . . . . . . . . . . .	5-7
5.3.3	-c (Show Parameter Settings) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-8
5.3.4	-d (Update Device Driver) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-8
5.3.5	-dm (Display Diagnostics Monitoring Info). . . . . . . . . . . . . . . . . . . . . .	5-9
5.3.6	-e (Boot Device View \| Select \| Disable) . . . . . . . . . . . . . . . . . . . . . . .	5-9
5.3.7	-ei (List SANsurfer FC HBA CLI Error Codes). . . . . . . . . . . . . . . . . . .	5-12
5.3.8	-f (Input Parameter Options from a Text File) . . . . . . . . . . . . . . . . . . .	5-12
5.3.9	-fg (Show Driver Settings) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-13
5.3.10	-fs (Configure Driver Settings). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-13
5.3.11	-g (Display System Information) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-14
5.3.12	-gs (Show HBA Statistics) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-14
5.3.13	-h (Help). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-15
5.3.14	-ha (Set \| Delete HBA Alias) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-16

5.3.15-i (Display HBA General Information or VPD Information for

One or All HBAs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-17

SN0054614-00 F

Page xv

SANsurfer FC HBA CLI User’s Guide

Command Line Interface for QLogic Fibre Channel Host Bus Adapters


	5.3.16	. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .-kl (Loopback Test)	5-17
	5.3.16.1	DataPattern (DP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-18
	5.3.16.2	DataSize (DS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-19
	5.3.16.3	TestCount (TC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-20
	5.3.16.4	Test Increment (TI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-20
	5.3.16.5	OnError (OE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-20
	5.3.16.6	Run a Loopback Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-21
	5.3.17	-kl (Run HBA Diagnostics Loopback Test). . . . . . . . . . . . . . . . . . . . . .	5-23
	5.3.18	-kr (Run Read/Write Buffer Test) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-23
	5.3.18.1	Run a Read/Write Buffer Test . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-24
	5.3.18.2	Run HBA Diagnostics Read-write Buffer Test. . . . . . . . . . . . . . .	5-26
	5.3.19	-l (Display LUN Info) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-28
	5.3.20	-ls (Display Link Status) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-28
	5.3.21	-m (View, Enable, or Disable LUNs) . . . . . . . . . . . . . . . . . . . . . . . . . .	5-29
	5.3.22	-n (Set Selected HBA Parameter) . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-31
	5.3.23	-o (Output to a File) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-33
	5.3.24	-p (Display Persistent Target Binding Info) . . . . . . . . . . . . . . . . . . . . .	5-34
	5.3.25	-pa (Define Port Alias) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-36
	5.3.26	-q (View or Set Target Link Speed) . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-36
	5.3.27	-r (Update HBA Parameters) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-38
	5.3.28	-s (Silent Mode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-38
	5.3.29	-t (Display Target Information) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-39
	5.3.30	-tb (Target Beacon On/Off) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-39
	5.3.31	-tp (Display Host Topology) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-40
	5.3.32	-v (Display Version) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-40
	5.3.33	-vp (Virtual Port) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-40
	5.3.34	-x (Output in XML Format 1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-41
	5.3.35	-x2 (Output in XML Format 2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-42
	5.3.36	-z (Display All HBA information for One or All HBAs) . . . . . . . . . . . . .	5-42
Appendix A XML Format 1
A.1	Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		A-1
	A.1.1	Main Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	A-1
	A.1.2	Utility Header. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	A-1
	A.1.3	Status Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	A-2
	A.1.4	Reboot Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	A-2
	A.1.5	Error Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	A-2
A.2	XML Format 1 Tags for Each Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		A-2
	A.2.1	Display System Information (Command Line Option -g) . . . . . . . . . . .	A-3
	A.2.2	Display Adapter Settings (Command Line Option -c) . . . . . . . . . . . . .	A-3

Page xvi

SN0054614-00 F

SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters


A.2.3	. . . . . . . . . . . . . .Display HBA Information (Command Line Option -i)	A-4
A.2.4	Display Device List (Command Line Option -t) . . . . . . . . . . . . . . . . . .	A-6
A.2.5	Display LUN List (Command Line Option -l) . . . . . . . . . . . . . . . . . . . .	A-7
A.2.6	Target Persistent Binding (Command Line Option -p) . . . . . . . . . . . . .	A-7
A.2.7	Selective LUNs (Command Line Option -m) . . . . . . . . . . . . . . . . . . . .	A-8
A.2.8	Boot Device (Command Line Option -e) . . . . . . . . . . . . . . . . . . . . . . .	A-8
A.2.9	Diagnostics Results –Loopback Test (Command Line Option -kl) . . .	A-9
A.2.10	Diagnostics Results – Read/Write Buffer Test (Command Line
	Option -kr) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	A-9
A.2.11	View Driver Settings (Command Line Option -fg) . . . . . . . . . . . . . . . .	A-10
A.2.12	Display All Information for One or All HBAs (Command Line
	Option -z). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	A-10
A.2.13	Link Statistics (Command Line Option -ls). . . . . . . . . . . . . . . . . . . . . .	A-13
A.2.14	HBA Statistics (Command Line Option -gs). . . . . . . . . . . . . . . . . . . . .	A-13
A.2.15	HBA Alias (Command Line Option -ha). . . . . . . . . . . . . . . . . . . . . . . .	A-14
A.2.16	HBA Port Alias (Command Line Option -pa) . . . . . . . . . . . . . . . . . . . .	A-14
A.2.17	SFF DMI (Command Line Option -dm) . . . . . . . . . . . . . . . . . . . . . . . .	A-15
A.2.18	Host Topology (Command Line Option -tp) . . . . . . . . . . . . . . . . . . . . .	A-20

Appendix B XML Format 2

B.1	Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	B-1
B.2	Main Tag. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	B-1
B.3	Utility Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	B-1
B.4	Status Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	B-2
B.5	Error Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	B-2
B.6	Reboot Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	B-2
B.7	XML2 Tags for Each Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	B-2
B.7.1	Display Adapter Settings (Command Line Option -c) . . . . . . . . . . . . .	B-2
B.7.2	SFF DMI (Command Line Option -dm) . . . . . . . . . . . . . . . . . . . . . . . .	B-3
B.7.3	Boot Device (Command Line Option -e) . . . . . . . . . . . . . . . . . . . . . . .	B-8
B.7.4	View Driver Settings (Command Line Option -fg) . . . . . . . . . . . . . . . .	B-10
B.8	Display System Information (Command Line Option -g) . . . . . . . . . . . . . . .	B-10
B.8.1	Display HBA Information (Command Line Option -I). . . . . . . . . . . . . .	B-11
B.8.2	Diagnostics Results – Loopback Test (Command Line
	Option -kl) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	B-13
B.8.3	Diagnostics Results – Read/Write Buffer Test (Command Line
	Option -kr) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	B-13
B.8.4	Display LUN List (Command Line Option -l) . . . . . . . . . . . . . . . . . . . .	B-14
B.8.5	Selective LUNs (Command Line Option -m) . . . . . . . . . . . . . . . . . . . .	B-15
B.8.6	Target Persistent Binding (Command Line Option -p) . . . . . . . . . . . . .	B-15

SN0054614-00 F

Page xvii

SANsurfer FC HBA CLI User’s Guide

Command Line Interface for QLogic Fibre Channel Host Bus Adapters


B.8.7	. . . . . . . . . . . . . . . . . .Display Device List (Command Line Option -t)	B-16
B.8.8	Display All Information for One or All HBAs (Command Line
	Option -z). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	B-17
B.8.9	Link Statistics (Command Line Option -ls). . . . . . . . . . . . . . . . . . . . . .	B-20
B.8.10	HBA Statistics (Command Line Option -gs). . . . . . . . . . . . . . . . . . . . .	B-21
B.8.11	View HBA Alias (Command Line Option -ha) . . . . . . . . . . . . . . . . . . .	B-21
B.8.12	HBA Port Alias (Command Line Option -pa) . . . . . . . . . . . . . . . . . . . .	B-22
B.8.13	Host Topology (Command Line Option -tp) . . . . . . . . . . . . . . . . . . . . .	B-24

Appendix C Interactive Exit Codes

Appendix D Non-interactive Error Codes

Appendix E Help Commands

Glossary

Index

Page xviii

SN0054614-00 F

SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters

List of Figures

Figure		Page
3-1	Preparing to Install Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-2
3-2	Welcome Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-3
3-3	Choose Destination Location Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-3
3-4	Ready to Install the Program Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-4
3-5	Setup Status Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-4
3-6	InstallShield Wizard Complete DIalog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-5

List of Tables

Table		Page
2-1	Non-interactive Mode Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	2-4
3-2	Windows Command Line Installation Parameters . . . . . . . . . . . . . . . . . . . . . . . . . .	3-6
4-1	HBA Parameters Settings (NVRAM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-24
4-2	Target/LUN Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-30
4-3	Target Link Speed Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-39
4-4	Driver Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-55
4-5	Template Supported Parameter Settings for QLA246x/QLE246x and
	QLE256x HBAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-59
4-6	Template Supported Parameter Settings for QLA23xx HBAs (ISP2312). . . . . . . . .	4-59
4-7	Template Supported Parameter Settings for QLA23xx HBAs (ISP2300/2310) . . . .	4-60
4-8	Template Supported Parameter Settings for QLA23xx HBAs (ISP2322). . . . . . . . .	4-60
4-9	HBA Diagnostics Configuration Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-62
4-10	HBA Port Statistics Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-78
4-11	Statistics/Link Status Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-81
5-1	Options Shown by -z . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-4
5-2	Command Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-6
5-3	Driver Settings Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-13
5-4	HBA Statistics Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-15
5-5	Data Pattern Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-19
5-6	OnError Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-21
5-7	Driver Versions Not Requiring a Loopback Connector. . . . . . . . . . . . . . . . . . . . . . .	5-21
5-8	Diagnostics Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-26
5-9	Data Pattern (DP) Test Patterns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-27
5-10	Link Status Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-29
5-11	HBA Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-32
A-1	Options Displayed by -z . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	A-10
B-1	Options Displayed by -z . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	B-17
C-1	Exit Code Descriptions – Interactive Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	C-1
D-1	Error Code Descriptions – Non-interactive Mode. . . . . . . . . . . . . . . . . . . . . . . . . . .	D-1
E-1	Help Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	E-1

SN0054614-00 F

Page xix

SANsurfer FC HBA CLI User’s Guide

Command Line Interface for QLogic Fibre Channel Host Bus Adapters

Notes

Page xx

SN0054614-00 F

Section 1

Introduction

1.1

Product Overview

The SANsurfer® FC HBA CLI tool provides a command line interface (CLI) that lets you easily install, configure, and deploy QLogic® Fibre Channel (FC) host bus adapters (HBAs). It also provides robust diagnostic and troubleshooting capabilities and useful statistical information to optimize SAN performance. This tool only configures HBAs on the local machine (where SANsurfer FC HBA CLI is installed.)

SANsurfer FC HBA CLI is a simplified, condensed version of the SANsurfer FC HBA Manager graphical user interface (GUI).

SANsurfer FC HBA CLI can be operated in two modes:

Interactive mode (menu-driven interface). This mode requires user intervention.

Non-interactive mode (command line interface). Use this mode for scripting or when you want to do a single operation.

NOTE:

This guide uses interchangeably the terms HBA and adapter.

1.2

Guide Overview

This guide is intended for end users responsible for administration of QLogic FC HBAs.

1.2.1

How this Guide is Organized

The SANsurfer FC HBA CLI User’s Guide is organized into the following sections and appendices:

Section 1 Introduction: This section provides a general overview of the product, lists the supported QLogic HBAs and operating systems, lists the system hardware and software requirements, and provides contact information for technical support.

SN0054614-00 F

PRELIMINARY

1-1

1 – Introduction

Guide Overview

Section 2 Getting Started: This section describes the two modes used in SANsurfer FC HBA CLI: interactive and non-interactive. It also explains some special terms used in this guide.

Section 3 Initial Installation: This section provides step-by-step instructions for installing and uninstalling SANsurfer FC HBA CLI on Windows, Linux, Solaris, and Macintosh.

Section 4 Interactive Commands: This section provides detailed explanations and examples of the command line options used in interactive mode.

Section 5 Non-interactive Commands: This section provides detailed explanations and examples of the command line options used in non-interactive mode.

Appendix A XML Format 1: of XML files created with the

Appendix B XML Format 2: of XML files created with the

This appendix provides explanations and examples -x1 command line option.

This appendix provides explanations and examples -x2 command line option.

Appendix C Interactive Exit Codes: This appendix lists the exit codes that can occur while running SANsurfer FC HBA CLI in interactive mode. For each exit code number, it provides the name and description.

Appendix D Non-interactive Error Codes: This appendix lists the error codes that can occur while running SANsurfer FC HBA CLI in interactive mode. For each error code number, it provides the name and description.

Appendix E Help Commands: This appendix provides an alphabetical list of the command line actions, arguments, and functions of the help commands.

Following the appendices are a glossary of terms used and an index that will help you quickly find the information you need.

1.2.2

Documentation Conventions

This guide uses the following documentation conventions:

Text in bold font indicates a menu item, dialog box, tab, button, or check box in the user interface. For example:

From the General Information Menu, type the number for Host

Topology.

Text in a sans serif font (Courier New) indicates CLI window text output. For example:

The HBA already has the device selected as boot device.

Text in a bold sans serif font (Courier New) indicates user input (what you type). For example:

1-2

PRELIMINARY

SN0054614-00 F

1 – Introduction

Guide Overview

#scli -z

Text in ALL CAPITALS usually 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:

Attached Port means a QLogic HBA....

For a complete list, see the QLogic SAN Interoperability Guide.

Italicized text within angle brackets indicates user-defined variables. For example:

#scli -k (<HBA Instance> | <HBA WWPN>)

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 for the latest firmware and product updates.

For information on Vital Product Data (VPD), see section 4.2.1.4.

In Section 4 Interactive Commands, a “breadcrumbs” line follows most command headings to show you how to access that option; that is, it shows the hierarchical path from the top level to the command under discussion. For example, to reach the Save to Text File options from the main SANsurfer FC HBA CLI menu, you would select option 1 to open the

General Information menu, 2 to open the Host Topology menu, and 2 again to see the Save to Text File options. The following shows a breadcrumbs example:

1: General Information

2: Host Topology

2: Save to Text File

SN0054614-00 F

PRELIMINARY

1-3

1 – Introduction

Supported QLogic HBAs

1.3

Supported QLogic HBAs

SANsurfer FC HBA CLI is supported for the following QLogic HBAs:

QLA234x

QLA2xx

QLE2xx

QLE246x

QLA246x

QLE256x

1.4

Supported Operating Systems

SANsurfer FC HBA CLI is supported on the following operating systems:

Microsoft® Windows®

Windows 2000/SP4 Server and Advanced Server

Windows 2003 SP2 IA-32/IA-64/x64 Server and Enterprise Server (SP2)

Windows XP IA-32/x64 (SP1, 2)

Windows Vista® IA-32/x64

Windows 2008 Server IA-32/IA-64/x64

Linux®

Red Hat® Enterprise Linux (RHEL) 3.0 IA-32, IA-64, and x86_64 Update 8, 9

RHEL 4.0 IA-32, IA-64, and x86_64 Update 5, 6

RHEL 5.0 IA-32, IA-64, and x86_64 Update 0, 1

SuSE® Linux Enterprise Server (SLES) 8 IA-32, IA64, and x86_64 versions SP 3, 4

SLES 9 IA-32, IA64, and x86_64 versions SP 3, 4

SLES 10 IA-32, IA64, and x86_64 versions SP 0, 1

NOTE:

RHEL 3.0 and SLES 8 do not support 8Gb.

Solaris®

Solaris SPARC 2.8/9/10 (with latest patches)

1-4

PRELIMINARY

SN0054614-00 F

1 – Introduction

System Requirements

Solaris x86 9/10 (with latest patches)

Apple® Macintosh®

Mac OS® X 10.3.x (PowerPC® (PPC)), 10.4.x (PPC/Intel), and 1.5.x (PPC/Intel)

VMware®

VMware ESX Server 3.5

NOTE:

VMware does not support 8Gb.

NOTE:

Throughout this guide, the terms Windows, Linux, Solaris, and Macintosh refer to all the respective supported operating systems unless otherwise noted.

1.5

System Requirements

The hardware and software requirements for SANsurfer FC HBA CLI are described in the following sections.

1.5.1

Hardware Requirements

The minimum hardware requirements are as follows:

QLogic HBAs (see section 1.3).

Singleor multiprocessor server or workstation:

Pentium® III with 450 MHz or greater for Windows 2000, Windows Server 2003, Windows XP Professional, Linux, and Solaris.

Windows Vista and Windows Server 2008—Use the minimum requirements from Microsoft.

Power Mac® G5 1.8 MHz or greater with 512 MB of memory.

FC devices, such as disks and RAID subsystems.

QLogic FC HBAs.

SANsurfer FC HBA CLI supports most FC devices. For a complete list of devices that support failover, see the QLogic SAN Interoperability Guide, which you can download from the QLogic Web site, www.qlogic.com/interopguide/info.asp#inter.

SN0054614-00 F

PRELIMINARY

1-5

1 – Introduction

System Requirements

NOTE:

Tape devices are shown as part of the configuration, but are not fully supported by SANsurfer FC HBA CLI. Only persistent binding and LUN masking are available.

256 MB physical RAM are required to run SANsurfer FC HBA CLI; running with less memory can cause disk swapping (“paging” or “paging out”), which severely affects performance.

Video card capable of 256 colors and a screen resolution of 800x600 pixels.

About 7 MB of disk space.

1.5.2

Software Requirements

The minimum software requirements are as follows:

QLogic drivers for your OS platform.

Administrative privileges to do management functions.

One of the operating systems listed in section 1.4.

1.5.2.1

Unsupported Features

Depending on your system, not all SANsurfer FC HBA features are available.

1.5.2.1.1

Features Not Available When Running Windows Driver with NPIV Enabled

When running the driver with NPIV enabled on Windows, the following features are not available with virtual port:

HBA parameters settings

HBA parameters restore default

Flash update from file

Flash save to file

HBA parameters update from file

HBA parameters save to file

HBA parameters update from templates

Target link speed

Boot device settings

Driver settings

HBA beacon

Target/LUN list

1-6

PRELIMINARY

SN0054614-00 F

1 – Introduction

Technical Support

1.5.2.1.2

Features Not Available When Running ioctl Module Driver

When running the input/output control (ioctl) module driver on a Linux OS, the following features are not available:

Persistent binding

Selective LUN

HBA port statistics

Driver settings

Host topology

1.5.2.1.3

Features Not Available When Running Sysfs Inbox Driver

When running the Sysfs Inbox driver on a Linux OS, the following features are not available:

Persistent binding

Selective LUN

HBA port statistics

Driver settings

Host topology

Link status

Loopback test

1.5.2.1.4

Features Not Available When Running VMware Driver

When running the VMware driver on a Linux OS, the following features are not available with virtual ports:

HBA parameters settings

HBA parameters restore default

Flash update from file

Flash save to file

HBA parameters update from file

HBA parameters save to file

HBA parameters update from templates

1.6

Technical Support

Customers should contact their authorized maintenance provider for technical support of their QLogic HBA products. QLogic-direct customers may contact QLogic Technical Support; others will be redirected to their authorized maintenance provider.

SN0054614-00 F

PRELIMINARY

1-7

1 – Introduction

Contact Information

Visit the QLogic support Web site at: support.qlogic.com for the latest firmware and product updates.

1.6.1

Availability

QLogic Technical Support for products under warranty is available during local standard working hours excluding QLogic Observed Holidays.

1.6.2

Training

QLogic offers certification training for the technical professional for both the QLogic FC HBAs and switches. From the training link at www.qlogic.com, you 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.

1.7

Contact Information

Support Headquarters	QLogic Corporation
	4601 Dean Lakes Blvd.
	Shakopee, MN 55379
	USA
QLogic Web Site	www.qlogic.com
Technical Support Web Site	support.qlogic.com
Technical Support E-mail	support@qlogic.com
Technical Training E-mail	tech.training@qlogic.com
North American Region
E-mail	support@qlogic.com
Phone	+1 952-932-4040
Fax	+1 952-974-4910

1-8

PRELIMINARY

SN0054614-00 F

1 – Introduction

Contact Information



Europe, Middle East, and Africa Region
E-mail	emeasupport@qlogic.com
Phone Numbers by Language	+353 1 6924960		– English
	+353 1 6924961		– Français
	+353 1 6924962		– Deutsch
	+353 1 6924963		– Español
	+353 1 6924964		– Português
	+353 1 6924965		– Italiano
Asia Pacific Region
E-mail	apacsupport@qlogic.com
Phone Numbers by Language	+63-2-885-6712	– English
	+63-2-885-6713	– (Mandarin)
	+63-2-885-6714	– (Japanese)
	+63-2-885-6715	– (Korean)
Latin and South America Region
E-mail	calasupport@qlogic.com
Phone Numbers by Language	+52 55 5278 7016 – English
	+52 55 5278 7017 – Español
	+52 55 5278 7015 – Português

SN0054614-00 F

PRELIMINARY

1-9

1 – Introduction

Contact Information

Notes

1-10

PRELIMINARY

SN0054614-00 F

Section 2

Getting Started

2.1

Introduction

SANsurfer FC HBA CLI operates in two modes:

Interactive (menu-driven). The CLI starts, and then waits for and executes input commands until terminated by the user. Use this mode to do multiple operations. Section 4 Interactive Commands covers this interface.

Non-interactive (command line). The CLI starts, does the functions defined by the list of parameters provided, and then terminates. Use this mode to run SANsurfer FC HBA CLI from a script file or when you want to do a single operation. Section 5 Non-interactive Commands covers this interface.

SANsurfer FC HBA CLIis not case sensitive in either mode. However, file names in some operating systems are case sensitive; in this case, SANsurfer FC HBA CLI is case sensitive for that specific file.

2.2

Starting Interactive Mode

To start SANsurfer FC HBA CLI in interactive mode, use one of these methods:

For Windows, click the SANsurfer FC CLI icon on the desktop.

For Linux or Solaris, open a command window and type:

scli INT

– Or –

scli

NOTE:

When starting SANsurfer FC HBA CLI from a Solaris console serial port connection, the CLI may take a long time to come up. To resolve this issue, specify the INT flag, as shown in the preceding bullet.

For Mac OS X, follow these steps:

1.Double-click the SANsurfer FC HBA CLI (SCLI) icon.

2.A terminal window opens. SCLI (interactive mode) scans the host for QLogic HBAs and SAN storage.

SN0054614-00 F

PRELIMINARY

2-1

2 – Getting Started

Starting Interactive Mode

3.Run SCLI commands as required.

4.When finished, return to the main menu, and type the indicated number to quit SANsurfer FC HBA CLI.

5.Close the terminal window.

The Main Menu appears as shown in the following:

SANsurfer FC HBA CLI v1.x.x Build xx

Main Menu

1:General Information

2:HBA Information

3:HBA Parameters

4:Target/LUN List

5: Target Link Speed

or 5: iiDMA Settings

6:Target Persistent Bindings

7:Selective LUNs

8:Boot Device

9:Driver Settings

10:Utilities

11:Beacon

12:Diagnostics

13:Statistics

14: Help	or	14: Virtual (if available)
15: Exit	or	15: Help
	or	16: Exit

NOTE:

The Virtual menu is available only on Windows systems running with a driver that supports NPIV (N_Port ID Virtualization).

Depending on which menu you select, may prompt you for more input. For example, if you select HBA Parameters, SANsurfer FC HBA CLI prompts you for the port number that corresponds to the HBA model you want to view.

NOTES:

The Driver Update option under Utilities (option 10) is only available on Windows.

In Solaris SPARC, the option to Save/Update BIOS is Save/Update FCode.

2-2

PRELIMINARY

SN0054614-00 F

2 – Getting Started

Starting Non-interactive Mode

2.3

Starting Non-interactive Mode

To start SANsurfer FC HBA CLI in non-interactive mode, type the following in a command window:

scli <Parameters>

SANsurfer FC HBA CLI executes the command options, then terminates.

To list all of the available command line parameters and the SANsurfer FC HBA CLI version, type the following:

scli -h

– Or –

scli -?

In Solaris SPARC, include double quotes around the view option (?) if the system is running with a csh or tsch shell. For example:

# scli -e 0 "?"

For world wide node name (WWNN), world wide port name (WWPN), and port ID parameter inputs, SANsurfer FC HBA CLI accepts the notation with and without the dash (–). Hexadecimal values can be uppercase or lowercase.

The following input formats are valid for the WWNN and WWPN:

20-00-00-E0-8B-01-83-C4 200000E08B0183C4

The following inputs are valid for the port ID:

68-5C-AB 685CAB

All command line options must be preceded by the dash (–) or forward slash (/) notation. Most options have a corresponding menu selection in interactive mode. The valid command line options are listed in Table 2-1.

SN0054614-00 F

PRELIMINARY

2-3

2 – Getting Started

Starting Non-interactive Mode

				.
				.
		Table 2-1. Non-interactive Mode Options

	Interactive	Interactive Menu		Interactive
CLI	Interactive	(Red Hat/SuSE		Interactive
CLI	Menu	(Red Hat/SuSE		Menu	Description	Section
Option	Menu	Linux, Solaris		Menu	Description	Section
Option	(Windows)	Linux, Solaris		(Macintosh)
	(Windows)		SPARC)	(Macintosh)
			SPARC)

-a	11	11		11	Flash HBA beacon	5.3.1
-b	10	10		—	Save/update BIOS/FCodea	5.3.2
					b
-c	2	2		2	Show HBA settings	5.3.3
-d	10	—		10	Update driver	5.3.4
-dM	12	12		12	Transceiver details	5.3.5
-e	8	8		8	Boot device settings	5.3.6
-f	—	—		—	Input from a file	5.3.8
-fg	9	9		9	View Driver Settings	5.3.9
-fs	9	9		9	Driver Settings	5.3.10
—	10	10		10	HBA Utilities	—
-g	1	1		1	Show system information	5.3.11
-gs	13	13		13	HBA Statistics	5.3.12
-h	14	14		14	Show usage	5.3.13
-?	14	14		14	Show usage
-ha	2	2		2	HBA alias	5.3.14
-i	2	2		2	Show HBA information	5.3.15
-kl	12	12		12	Loopback test	5.3.16
-kr	12	12		12	Read/write buffer test	5.3.18
-l	4	4		4	Show LUN list	5.3.19
-ls	13	13		13	Show Link Status	5.3.20
-m	7	7		7	Selective LUNs	5.3.21
-n	3	3		3	Configure HBA settings	5.3.22
-o	1	1		1	Output to a file	5.3.26
-P	6	6		6	Target persistent binding	5.3.241
-pa	2	2		2	HBA port alias	5.3.25

2-4

PRELIMINARY

SN0054614-00 F

2 – Getting Started

Starting Non-interactive Mode

Table 2-1. Non-interactive Mode Options (Continued)

	Interactive	Interactive Menu	Interactive
CLI	Interactive	(Red Hat/SuSE	Interactive
CLI	Menu	(Red Hat/SuSE	Menu	Description	Section
Option	Menu	Linux, Solaris	Menu	Description	Section
Option	(Windows)	Linux, Solaris	(Macintosh)
	(Windows)	SPARC)	(Macintosh)
		SPARC)

-q	5	5	5	Target link speed	5.3.26
-r	—	—	—	Save/update NVRAM	—
—	1	1	1	Refresh	—
—	15 (16)	15 (16)	15 (16)	Quit	—
-s	—	—	—	Silent mode	5.3.28
-t	4	4	4	Show device list	5.3.29
-tb	11	11	11	Flash target beacon	5.3.30
-tp	1	1	1	Show host topology	5.3.31
-v	—	—	—	Show version	5.3.32
-x	1	1	1	Output in XML format	5.3.34
-z	2	2	2	Show all information for one	5.3.36
				or all HBAs

aWindows, Linux, Solaris x86

bSolaris SPARC

Options that have a corresponding menu selection cannot be combined. That is, only one option is allowed in a single command. If multiple options are specified in a command, only the first one is processed. These options, however, can be combined with one or more options that do not have a corresponding menu selection, with the exception of -F.

For all command line options, SANsurfer FC HBA CLI shows the following when there are errors in the command line input:

Error <error message> SANsurfer FC HBA CLI v1.x.x Build xx

Command Line QLogic FC Host Bus Adapters

description of command entered Usage: <current command use usage>

SN0054614-00 F

PRELIMINARY

2-5

2 – Getting Started

Terminology

2.4

Terminology

Some of the terms used in this guide are similar and some have changed slightly as technology changes. The following definitions apply:

HBA Port

HBA Port refers to the actual physical port on an HBA. For example, a QLA2462 has two ports called HBA port 1 and HBA port 2.

HBA Instance, HBA Instance number, or HBA Port Instance

When you install HBA in a system with other HBAs, each HBA port gets assigned a number by the driver or API so it knows which HBA to communicate with. This assigned number might be called HBA Instance, HBA instance number, or HBA Port Instance.

HBA Alias

When an alias is assigned to a physical HBA, no matter how many ports that HBA has, the HBA Alias refers to the HBA, not one of its ports.

Port Alias

You can also assign an alias to an individual port on an HBA. This Port Alias refers to only that port and none other.

Thus, an HBA can only have one HBA Alias, but each port on that HBA must, have a unique Port Alias.

2-6

PRELIMINARY

SN0054614-00 F

Section 3

Initial Installation

Before you run SANsurfer FC HBA CLI, ensure that the following requirements are met:

The HBAs must be installed.

The HBA drivers must be installed.

NOTES:

Some SANsurfer FC HBA CLI features are not available when:

You have a Solaris system that is running with the driver distributed with the OS installation CDs (QLC driver).

You have a Linux system that is running with the ioctl or sysfs (inbox) driver.

You have a Linux system that is running with a VMware driver.

3.1

Downloading the Installation Package

To download the SANsurfer FC HBA CLI installation package from the QLogic Web site, follow these steps:

1.From the QLogic home page (www.qlogic.com), click Downloads (on the left).

2.On the Drivers Downloads / Manuals page, click your HBA model. The Resources page for the selected model appears.

3.Under Drivers, Management Tools and API Libraries, click the appropriate operating system.

4.In the Management Tools table, go to the SANsurfer CLI … row and in the

Download column, click (Download).

5.The system shows the End User License Agreement box. Scroll to the bottom and click Agree.

6.Click Save. Select a directory on your system and download the file.

SN0054614-00 F

3-1

3 – Initial Installation

Installing SANsurfer FC HBA CLI

3.2

Installing SANsurfer FC HBA CLI

Follow the installation instructions in the section that corresponds to your operating system (OS):

Windows—See section 3.2.1.

Linux—See section 3.2.2.

Solaris—See section 3.2.3.

Macintosh—See section 3.2.4.

3.2.1

Windows Installation

To install SANsurfer FC HBA CL on Windows, follow either the GUI or command line installation steps:

Standard (GUI) installation—See section 3.2.1.1.

Command line installation—See section 3.2.1.2.

3.2.1.1

Standard (GUI) Installation

To install SANsurfer FC HBA CLI on a Windows operating system, follow these steps:

1.Locate and double-click the installer package. The Preparing to Install dialog box appears, as shown in Figure 3-1. The status bar indicates that the installation package is loading.

Figure 3-1 Preparing to Install Dialog Box

After the install package is loaded, the Welcome dialog box appears as shown in Figure 3-2.

3-2	SN0054614-00 F

3 – Initial Installation

Installing SANsurfer FC HBA CLI

Figure 3-2 Welcome Dialog Box

2.Read the information, and then click Next.

The Choose Destination Location dialog box appears as shown in Figure 3-3.

Figure 3-3 Choose Destination Location Dialog Box

3.In the Choose Destination Location dialog box, do one of the following:

To select the destination location in the dialog box, click Next (recommended). The default location for a Windows system is:

Program Files\QLogic Corporation\SANsurferCLI

SN0054614-00 F

3-3

3 – Initial Installation

Installing SANsurfer FC HBA CLI

To select a different location:

a.Click Browse.

b.Select an installation location.

c.The Choose Destination Location dialog box reappears. Click

Next.

The Ready to Install the Program dialog box appears as shown in Figure 3-4.

Figure 3-4 Ready to Install the Program Dialog Box

4.Read the information, and then click Install.

The Setup Status dialog box appears as shown in Figure 3-5.

Figure 3-5 Setup Status Dialog Box

3-4	SN0054614-00 F

3 – Initial Installation

Installing SANsurfer FC HBA CLI

If you want to stop the installation, click Cancel.

The InstallShield Wizard Complete dialog box appears as shown in

Figure 3-6.

Figure 3-6 InstallShield Wizard Complete DIalog Box

5.(Optional.) Select one of the following:

If you want to see more information about SANsurfer FC HBA CLI, select the I would like to view the README file check box.

If you want to start SANsurfer FC HBA CLI, select the I would like to launch SANsurfer FC CLI check box.

6.Click Finish.

3.2.1.2

Command Line Installation

To install SANsurfer FC HBA CLI using the command line installation, follow the steps for either standard or silent installation:

Standard installation—See section 3.2.1.2.1

Silent installation—See section 3.2.1.2.2

3.2.1.2.1

Standard Command Line Installation

Type the following text for a standard installation of SANsurfer FC HBA CLI on a Windows operating system, where xx indicates the version of SANsurfer FC HBA CLI:

scli-1.x.x.xx.windows.exe

SN0054614-00 F

3-5

3 – Initial Installation

Installing SANsurfer FC HBA CLI

By default, SANsurfer FC HBA CLI is installed in the following directory:

Program files\QLogic Corporation\SANsurferCLI

If you want to change the default location, enter the directory in the command line; for example:

scli-1.x.x-xx.windows.exe installdir="c:\sansurfercli"

3.2.1.2.2

Silent Command Line Installation

The command for a silent installation is the same as for a standard installation (see section 3.2.1.2.1), with the addition of the command parameters listed in Table 3-2. Examples using these parameters follow the table.

Table 3-2. Windows Command Line Installation Parameters

Parameter	Meaning	Description

/r	Record modea	To run the SANsurfer FC HBA CLI installation package in
		silent mode, first run scli-1.x.x-xx.windows.exe with
		the /r parameter to generate a response file, which stores
		information about the data entered and options selected at
		run time. By default, the response file is created inside the
		system's Windows folder. To specify an alternative response
		file name and location, use the /f1 parameter.
/s	Silent mode	For an InstallScript MSI or InstallScript project, the command
		scli-1.x.x-xx.windows.exe /s runs the installation in
		silent mode, based on the responses contained in the
		Setup.iss file, located in the same directory. (Response files
		are created by running Setup.exe with the /r option). To
		specify an alternative file name or location of the response
		file, use the /f1 parameter.
/f1	Specify alternative	This parameter allows you to specify the name and location
	response file namea	of the response file.
		The /f1 parameter is available when creating a response
		file (with the /r option) and when using a response file (with
		the /s option).
/f2	Specify alternative log	When running an InstallScript MSI or InstallScript installation
	file namea	in silent mode (using the /s parameter), the log file
		Setup.log is created in the same directory and with the same
		name (except for the extension) as the response file. The
		/f2 parameter allows you to specify an alternative log file
		location and file name.

a InstallScript and InstallScript MSI projects only.

3-6	SN0054614-00 F

3 – Initial Installation

Installing SANsurfer FC HBA CLI

To create a response file for a silent installation of SANsurfer FC HBA CLI, enter the following:

scli-1.x.x-xx.windows.exe /r /f1"C:\Temp\install_1.iss"

To run the installation in silent mode with a log file, enter the following:

scli-1.x.x-xx.windows.exe /s /f1"C:\Temp\install_2.iss"

To run the installation in silent mode with an alternate file in a temporary directory, enter the following:

scli-1.x.x-xx.windows.exe /s /f1"C:\Temp\install_1.iss" /f2"C:\Temp\install_3.log"

NOTE:

After installing SANsurfer FC HBA CLI, you can create an uninstallation script for future use by creating a response file with a different name. For example:

scli-1.x.x-xx.windows.exe /r /f1"C:\Temp\uninstall.iss"

3.2.2

Linux Installation

To install SANsurfer FC HBA CLI on a Red Hat/SuSE Linux operating system, follow these steps:

1.Download the scli-x.xx.xx-xx.i386.rpm.gz file (from the QLogic Web site or the FC HBA Manager CD-ROM) to your local machine. In the file name, x.xx.xx stands for the current version of SANsurfer FC HBA CLI.

2.Uncompress the file with the following command:

gunzip <file name>

3. Enter the following command to install the package:

rpm -iv scli-x.xx.xx-xx.i386.rpm

NOTE:

For SuSE SLES IA64, the command line is:

rpm --iv scli-x.xx.xx-xx.ia64.rpm --nodeps

The new package is installed in the following directory:

/opt/QLogic_Corporation/SANsurferCLI

SN0054614-00 F

3-7

3 – Initial Installation

Installing SANsurfer FC HBA CLI

To query for the installed SANsurfer FC HBA CLI package name, enter the following text from the command line:

rpm -q scli

3.2.3

Solaris Installation

To install SANsurfer FC HBA CLI on Solaris, follow the steps in one of these sections:

Solaris SPARC 8, 9, 10—See section 3.2.3.1.

Solaris x86 9 and 10—See section 3.2.3.2.

3.2.3.1

Solaris SPARC 8, 9, 10 Installation

Follow these steps to install SANsurfer FC HBA CLI on a Solaris SPARC 8, 9, or 10 operating system:

1.Download the scli-x.xx.xx-xx.sparc.Solaris.pkg file (from the QLogic Web site or the FC HBA Manager CD-ROM) to a temporary directory on your machine. For example:

/tmp

NOTE:

In the file name, x.xx.xx-xx stands for the current version of SANsurfer FC HBA CLI. The -xx stands for the build version.

2.To see the available package file, type the following:

#ls

The available packages appear. For example:

#scli-x.xx.xx-xx.sparc.Solaris.pkg

3.To install SANsurfer FC HBA CLI, type the following:

#pkgadd -d scli-x.xx.xx-xx.sparc.Solaris.pkg

4.You are prompted to select a package. For example:

The following packages are available:

1QLScli QLogic SANsurfer FC HBA CLI (HBA Configuration Utility) (sparc) x.xx.xx Build xx

Select package(s) you wish to process (or 'all' to process all packages). (default: all) [?,??,q]:

Enter 1 to proceed with the installation.

3-8	SN0054614-00 F

3 – Initial Installation

Installing SANsurfer FC HBA CLI

5.The pkgadd program does a series of checks, and then posts a script warning and asks whether to continue the installation. For example:

Processing package instance <QLScli> from

</space/chuynh/scli/qlogic/Solaris/pkgs/x>

QLogic SANsurfer FC CLI (HBA Configuration Utility) (sparc) x.xx.xx Build xx

QLogic Corporation

## Executing checkinstall script.

Using </> as the package base directory.

##Processing package information.

##Processing system information.

39 package pathnames are already properly installed.

##Verifying disk space requirements.

##Checking for conflicts with packages already installed.

##Checking for setuid/setgid programs.

This package contains scripts which will be executed with super-user permission during the process of installing this package.

Do you want to continue with the installation of <QLScli> [y,n,?]

To continue, type y, then press ENTER.

6.Messages appear showing what files have been installed. The system shows a final message when installation is complete. For example:

Installing QLogic SANsurfer FC CLI (HBA Configuration Utility)

as <QLScli>

## Installing part 1 of 1. /opt/QLogic_Corporation/SANsurferCLI/adapters.properties /opt/QLogic_Corporation/SANsurferCLI/libs/libqlsdm.so /opt/QLogic_Corporation/SANsurferCLI/menu.properties /opt/QLogic_Corporation/SANsurferCLI/nvramdefs/default/nvram2 2.dat /opt/QLogic_Corporation/SANsurferCLI/nvramdefs/default/nvram2 3.dat

. . .

Installation of <QLScli> was successful.

3.2.3.2

Solaris x86 9 and 10 Installation

To install SANsurfer FC HBA CLI on a Solaris x86 9 or 10 operating system, follow these steps:

1.Download the scli-x.xx.xx-xx.x86.Solaris.pkg file (from the QLogic Web site or the FC HBA Manager CD-ROM) to a temporary directory on your machine. For example:

/tmp

SN0054614-00 F

3-9

3 – Initial Installation

Installing SANsurfer FC HBA CLI

NOTE:

In the file name, x.xx.xx-xx stands for the current version of SANsurfer FC HBA CLI. The -xx stands for the build version.

2.To uncompress the file, type the following:

#uncompress scli-x.xx.xx-xx.x86.Solaris.pkg

3.To see the available package file, type the following:

#ls

The available packages appear. For example:

#scli.x.xx.xx-xx.SPARC-X86.Solaris.pkg

4.To install SANsurfer FC HBA CLI, type the following:

#pkgadd -d scli-x.xx.xx-xx.SPARC-X86.Solaris.pkg

5.You are prompted to select a package. For example:

The following packages are available:

1QLSclix QLogic SANsurfer FC HBA CLI (HBA Configuration Utility) (i386) x.xx.xx Build xx

Select package(s) you wish to process (or 'all' to process all packages). (default: all) [?,??,q]: q

Enter 1 to proceed the installation.

6.Type the number that corresponds to your operating system, and then press ENTER.

The pkgadd program does a series of checks, posts a script warning, and asks whether to continue the installation. For example:

Processing package instance <QLSclix> from </space/chuynh/scli/qlogic/Solaris/pkgs/x>

SANsurfer FC HBA CLI (HBA Configuration Utility) (sparc) 1.xx.xx (Build xx Solaris 8-10)

QLogic Corporation

##Executing checkinstall script.

##Processing package information.

##Processing system information. 3 package pathnames are already properly installed.

##Verifying disk space requirements.

##Checking for conflicts with packages already installed.

##Checking for setuid/setgid programs.

3-10	SN0054614-00 F

3 – Initial Installation

Installing SANsurfer FC HBA CLI

[ verifying class <none>]

## Executing postinatall script. Installation of <QLSclix> was successful.

3.2.4

Macintosh Installation

To install SANsurfer FC HBA CLI, follow either the standard GUI or command line installation method:

Standard (GUI) installation—See section 3.2.4.1.

Command line installation—See section 3.2.4.2.

3.2.4.1

Standard (GUI) Installation

Follow these steps to install SANsurfer FC HBA CLI on a Macintosh:

1.You must have Admin privileges to install SANsurfer FC HBA CLI. To verify/enable Admin privileges, go to System Preferences, select Account, and then Security Tab. Make sure the Allow user to administer this computer check box is selected.

2.Download the SCLI zip file with Safari™ or other browser.

3.When the download has finished, StuffIt® expands the zip file to a tar file onto the desktop.

4.Double-click the SCLI tar file icon to create the SCLI pkg file.

5.Double-click the SCLI pkg file icon.

6.Follow the Installer menu.

The installation directory is:

$HOME/Applications/QLogic_Corporation/SANsurferCLI

where $HOME is Root.

7.After the installation process has finished, you can delete the SCLI pkg and tar files.

3.2.4.2

Command Line Installation

To install SANsurfer FC HBA CLI on a Macintosh, follow these steps:

1.Download the SCLI install package for Mac OS x (compressed tar file) to a local directory.

2.Uncompress the file by typing the following command:

SN0054614-00 F

3-11

3 – Initial Installation

Uninstalling SANsurfer FC HBA CLI

tar -zxvf <file>.tgz

For example:

qlogic:~ root#tar -zxvf scli-x.x.x-x.macos.pkg.tgz

./scli-x.x.x-x.pkg/

./scli-x.x.x-x.pkg/Contents/

./scli-x.x.x-x.pkg/Contents/Archive.bom

./scli-x.x.x-x.pkg/Contents/Archive.pax.gz

...

This command extracts the compressed file to a directory named scli-x.x.x-x.pkg.

3. Install the package to the default directory. For example:

installer -pkg scli-x.x.x-x.pkg -target /

This command installs the product in the default Applications directory:

/var/root/Applications/QLogic_Corporation/SANsurferCLI

If this is the first time you are installing SANsurfer FC HBA CLI, the system shows the following messages:

qlogic:~ root# installer -pkg scli-x.x.x-x.pkg -target / installer: Package name is SANsurfer FC HBA CLI x.x.x Build x installer: Installing onto volume mounted at /.

installer: The install was successful.

If there is a previous version of SANsurfer FC HBA CLI on the system, the installer automatically runs an update operation. For example:

qlogic:~ root# installer -pkg scli-x.x.x-x.pkg -target / installer: Package name is SANsurfer FC HBA CLI x.x.x Build x installer: Upgrading volume mounted at /.

installer: The upgrade was successful.

3.3

Uninstalling SANsurfer FC HBA CLI

Refer to the following sections for the appropriate procedure to uninstall SANsurfer FC HBA CLI from your system:

3.3.1 Windows Uninstall

3.3.2 Linux Uninstall

3.3.3 Solaris Uninstall

3.3.4 Macintosh Uninstall

3-12	SN0054614-00 F

3 – Initial Installation

Uninstalling SANsurfer FC HBA CLI

3.3.1

Windows Uninstall

To uninstall SANsurfer FC HBA CLI, use either the standard GUI or command line method:

Standard (GUI) uninstall—See section 3.3.1.1

Command line uninstall—See section 3.3.1.2

3.3.1.1

Standard (GUI) Uninstall

To uninstall SANsurfer FC HBA CLI using the GUI, do the following steps:

1.From the Control Panel, click Add or Remove Programs.

2.Highlight SANsurfer FC HBA CLI.

3.Click Remove. No re-boot is required.

Alternately, invoke scli-1.x.x-xx.windows.exe and select the option to Remove all installed features.

3.3.1.2

Command Line Uninstall

To uninstall SANsurfer FC HBA CLI using the command line, type the following:

scli-1.x.x-x.windows.exe /uninst /s

If you created an uninstall script in section 3.2.1.2.2, you can uninstall SANsurfer FC HBA CLI in silent mode by type the following:

scli-1.x.x-x.windows.exe /s /f1”C:\Temp\uninstall.iss"

3.3.2

Linux Uninstall

To uninstall SANsurfer FC HBA CLI, go to the command line and type one of the following commands, where x.xx.xx is the current version of CLI:

rpm -e scli-x.xx.xx-xx rpm -e scli

To query for the installed SANsurfer FC HBA CLI package name, type the following text from the command line:

rpm -q scli

3.3.3

Solaris Uninstall

To uninstall SANsurfer FC HBA CLI, follow one of these procedures:

SN0054614-00 F

3-13

3 – Initial Installation

Uninstalling SANsurfer FC HBA CLI

Solaris SPARC 8, 9, 10—See section 3.3.3.1.

Solaris x86 8, 9, 10—See section 3.3.3.2.

3.3.3.1

Solaris SPARC 8, 9, and 10 Uninstall

Follow these steps to uninstall SANsurfer FC HBA CLI:

1.Type the following to remove SANsurfer FC HBA CLI:

#pkgrm QLScli

2.The program shows the package name and a script warning asking whether to continue the uninstall process. For example:


The following		package	is currently installed:
QLScli	QLogic SANsurfer FC CLI (HBA Configuration Utility)
(sparc) 1.x.x		Build xx	this package?
Do you	want to remove

3.Type y and press ENTER. The program shows a script warning asking whether to continue the uninstall process. For example:

## Removing installed package instance <QLScli>

This package contains scripts which will be executed with super-user permission during the process of removing this package

Do you want to continue with the removal of this package [y,n,?,q]

4.Type y and press ENTER. The pkgrm program notifies you when the uninstall process is complete. For example:

##Verifying package dependencies.

##Processing package information. ...

/opt/QLogic_Corporation/SANsurferCLI/adapters.properties /opt/QLogic_Corporation/SANsurferCLI

##Executing postremove script. scli removed.

Menu property file removed. Adapter property file removed. SCLI property file removed.

##Updating system information. Removal of <QLScli> was successful.

3.3.3.2

Solaris x86 8, 9, and 10 Uninstall

Follow these steps to uninstall SANsurfer FC HBA CLI:

1.Type the following to remove SANsurfer FC HBA CLI:

#pkgrm QLSclix

3-14	SN0054614-00 F

+ 230 hidden pages

Q-Logic FC HBA CLI User Manual

Table of Contents

Product Overview

Guide Overview

How this Guide is Organized

Section 1 Introduction: This section provides a general overview of the product, lists the supported QLogic HBAs and operating systems, lists the system hardware and software requirements, and provides contact information for technical support.

Documentation Conventions

Supported QLogic HBAs

Supported Operating Systems

System Requirements

Hardware Requirements

Software Requirements

Unsupported Features

Technical Support

Contact Information

Availability

Training

Introduction

Starting Interactive Mode

Starting Non-interactive Mode

Terminology

Downloading the Installation Package

Installing SANsurfer FC HBA CLI

Windows Installation

Standard (GUI) Installation

Command Line Installation

Linux Installation

Solaris Installation

Solaris SPARC 8, 9, 10 Installation

Solaris x86 9 and 10 Installation

Macintosh Installation

Standard (GUI) Installation

Command Line Installation

Uninstalling SANsurfer FC HBA CLI

Windows Uninstall

Standard (GUI) Uninstall

Command Line Uninstall

Linux Uninstall

Solaris Uninstall

Solaris SPARC 8, 9, and 10 Uninstall

Solaris x86 8, 9, and 10 Uninstall