SANsurfer FC/CNA HBA CLI
User’s Guide
Command Line Interface for
QLogic FC and FCoE Adapters
SN0054614-00 K
SANsurfer FC/CNA HBA CLI User’s Guide
Command Line Interface for QLogic FC and FCoE 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 that 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.
\
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 29, 2008
Revision G, June 30, 2008
Revision H, July 16, 2008
Revision J, March 11, 2009
Revision K, June 15, 2009
Changes Sections Affected
Revision K Changes:
Changed product name from “SANsurfer FC HBA
CLI” to “SANsurfer FC/CNA HBA CLI.”
Added
QLE81xx and QMI81xx to the list of sup-
ported adapters.
Added Red Hat and Novell PowerPC64 to supported Linux OSs.
Added list of unsupported features for QLE81xx
and QMI81xx adapters on Linux OS.
Added note recommending uninstalling older version rather than upgrading.
Added new FCoE menu option to Getting Started
chapter.
All
“Supported QLogic Adapters” on page 1-2
“Supported Operating Systems” on page 1-3
“Unsupported Features” on page 1-5
“Installing SANsurfer FC/CNA HBA CLI” on
page 1-7
“Starting Interactive Mode” on page 2-1
Added -cna command line option to Non-interac-
Table 2-1 on page 2-4
tive Mode Options table.
ii SN0054614-00 K
SANsurfer FC/CNA HBA CLI User’s Guide
Command Line Interface for QLogic FC and FCoE Adapters
Added new FCoE menu option to Interactive Com-
mands chapter.
Added Flash Image Version to list of actual VPD
information.
Added new ENode MAC Address information for
QLE81xx adapters.
Added cautions about deleting the LUN persistent
name for a LUN with active I/O.
Updated the Utilities menu (renamed some
options per modifications to the CLI, added new
MPI config table options, and removed the FCoE
Utility option).
Updated Update Flash option. “Update Flash (Per Adapter Port or All HBAs)
Added new message passing interface (MPI)
options for the Utilities menu.
Updated loopback and read/write buffer test
descriptions and examples.
3 Interactive Commands
“Generate Report (Per Adapter Port)” on
page 3-11
“HBA Information (Command Line Option -i)” on
page 3-21
“Persistent Names Menu (Command Line Option
-pl)” on page 3-39
“-pl (Show, Add, and Delete Persistent Names)” on
page 4-41
“Utilities Menu” on page 3-64
“Update MPI Config Table” on page 3-71
“Save MPI Config Table” on page 3-71
(Command Line Option -b)” on page 3-65
“Update MPI Config Table” on page 3-71
“Save MPI Config Table” on page 3-71
“Diagnostics Loopback Test (Command Line
Option -kl)” on page 3-77
“Diagnostics Read/Write Buffer Test” on page 3-83
Updated the transceiver details output examples. “Diagnostics Transceiver Details: DMI (Command
Line Option -dm)” on page 3-85
Updated FCoE menu section to reflect support for
both QLE80xx (FCoE adapters) and QLx81xx
(converged network adapters).
Added new section for converged network adapters (QLE81xx and QMI81xx).
Added new command line options for converged
network adapters (QLE81xx and QMI81xx).
Renamed Interactive Exit Codes appendix and
updated and added new error return codes.
Removed redundant Non-Interactive Error Codes
appendix (codes are the same as in Appendix C
Error/Exit Return Codes).
Added new glossary terms.
“FCoE Menu (Command Line Option -cna)” on
page 3-108
“FCoE Utilities Menu for QLx81xx Adapters (Command Line Option -cna)” on page 3-111
“-cna (FCoE Utilities Menu for QLx81xx Adapters)”
on page 4-8
Appendix C Error/Exit Return Codes
—
Glossary
SN0054614-00 K iii
SANsurfer FC/CNA HBA CLI User’s Guide
Command Line Interface for QLogic FC and FCoE Adapters
Notes
iv SN0054614-00 K
Table of Contents
Preface
Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
What’s in This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
Documentation Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvi
Related Materials. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
License Agreements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
Technical Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
Training . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
Contact Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
1 Installation and Removal
Supported QLogic Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Supported Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Software Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Unsupported Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Downloading the Installation Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Installing SANsurfer FC/CNA HBA CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
Windows Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Standard (GUI) Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Command Line Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12
Linux Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14
Solaris Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15
Solaris SPARC 8, 9, 10 Installation . . . . . . . . . . . . . . . . . . . . . . 1-15
Solaris x86 9 and 10 Installation. . . . . . . . . . . . . . . . . . . . . . . . . 1-17
Macintosh Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18
Standard (GUI) Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-18
Command Line Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-19
VMware Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-20
SN0054614-00 K v
SANsurfer FC/CNA HBA CLI User’s Guide
Command Line Interface for QLogic FC and FCoE Adapters
Uninstalling SANsurfer FC/CNA HBA CLI . . . . . . . . . . . . . . . . . . . . . . . . . . 1-21
Windows Uninstall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-21
Standard (GUI) Uninstall. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-21
Command Line Uninstall. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-21
Linux Uninstall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-22
Solaris Uninstall. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-22
Solaris SPARC 8, 9, and 10 Uninstall. . . . . . . . . . . . . . . . . . . . . 1-22
Solaris x86 8, 9, and 10 Uninstall . . . . . . . . . . . . . . . . . . . . . . . . 1-23
Macintosh Uninstall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-24
VMware Uninstall. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-24
2 Getting Started
Starting Interactive Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Starting Non-Interactive Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
Advanced Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
3 Interactive Commands
General Information Menu (Command Line Option -g) . . . . . . . . . . . . . . . . 3-4
Host Information (Command Line Option -g). . . . . . . . . . . . . . . . . . . . 3-4
Host Topology (Command Line Option -tp | -topology) . . . . . . . . . . . . 3-5
Display (Host Topology) (Command Line Option -tp |
-topology) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6
Save As Txt File (Command Line Option -b) . . . . . . . . . . . . . . . 3-10
Save As XML File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10
Generate Report (Command Line Option -z) . . . . . . . . . . . . . . . . . . . 3-10
Generate Report (Per Adapter Port). . . . . . . . . . . . . . . . . . . . . . 3-11
Generate Report (All Adapters) (Command Line Option -z). . . . 3-19
Refresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19
HBA Information Menu (Command Line Option -i) . . . . . . . . . . . . . . . . . . . 3-19
HBA General Information (per Adapter Port). . . . . . . . . . . . . . . . . . . . 3-20
HBA Information (Command Line Option -i). . . . . . . . . . . . . . . . 3-21
HBA Alias (Command Line Option -ha) . . . . . . . . . . . . . . . . . . . 3-21
HBA Port Alias (Command Line Option -pa) . . . . . . . . . . . . . . . 3-22
HBA VPD Information (Command Line Option -l and
Reserved Word “vpd”) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-23
HBA Information (All HBAs). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-24
Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-24
vi SN0054614-00 K
SANsurfer FC/CNA HBA CLI User’s Guide
Command Line Interface for QLogic FC and FCoE Adapters
HBA Parameters Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-24
HBA Parameters (Per Adapter Port) . . . . . . . . . . . . . . . . . . . . . . . . . . 3-25
Display HBA Parameters (Command Line Option -c#). . . . . . . . 3-26
Configure HBA Parameters (Command Line Option -n). . . . . . . 3-26
Restore Defaults. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-32
HBA Parameters (Per FCoE Engine) . . . . . . . . . . . . . . . . . . . . . . . . . 3-33
Display FCoE Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-33
Configure FCoE Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-33
HBA Parameters (All HBAs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-36
Target/LUN List Menu (Command Line Options -t and -l) . . . . . . . . . . . . . . 3-36
Target/LUN List (Per Adapter Port) . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-37
Per Target/LUN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-38
Per Target/All LUNs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-38
All Targets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-41
Target/LUN List (All Adapters) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-42
Individual Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-42
Individual LUN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-43
All Targets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-43
All Target(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-44
All LUN(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-45
Target Link Speed or iiDMA Settings Menu (Command Line
Option -q) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-47
Configuring the iiDMA Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-48
HBA Port Instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-49
HBA Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-50
Advanced Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-51
Target Link Speed: All HBAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-51
Target Link Speed: All HBAs, Basic Configuration . . . . . . . . . . . 3-52
Target Link Speed: All HBAs, Advanced Configuration . . . . . . . 3-52
iiDMA Settings: Disk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-54
iiDMA: All HBAs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-54
Target Persistent Bindings Menu (Command Line Option -p) . . . . . . . . . . . 3-54
Target Persistent Bindings (Per Adapter Port) (Command Line
Option -p) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-55
Display Target Persistent Binding (Command Line
Option -p) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-55
Target Persistent Bindings: Bind Target(s) (Command Line
Option -p) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-55
Target Persistent Binding: Unbind Targets (Command Line
Option -p) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-57
SN0054614-00 K vii
SANsurfer FC/CNA HBA CLI User’s Guide
Command Line Interface for QLogic FC and FCoE Adapters
Target Persistent Binding (All HBAs) . . . . . . . . . . . . . . . . . . . . . . . . . . 3-57
Display Target Persistent Binding . . . . . . . . . . . . . . . . . . . . . . . . 3-57
Target Persistent Binding: Bind Targets . . . . . . . . . . . . . . . . . . . 3-57
Target Persistent Binding: Unbind Targets . . . . . . . . . . . . . . . . . 3-57
Selective LUNs Menu (Command Line Option -m) . . . . . . . . . . . . . . . . . . . 3-58
Selective LUNs (Per Adapter Port) . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-58
Selective LUNs (All HBAs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-58
Display LUN Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-58
Manual Configure LUNs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-59
Auto Configure LUNs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-59
Boot Device Menu (Command Line Option -e) . . . . . . . . . . . . . . . . . . . . . . 3-60
HBA Port Instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-60
Boot Device(s) (Per Adapter Port) . . . . . . . . . . . . . . . . . . . . . . . 3-60
Configure Boot Device(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-61
Boot Device(s) (All HBAs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-62
Driver Settings Menu (Command Line Option -fg) . . . . . . . . . . . . . . . . . . . . 3-62
Utilities Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-64
Update Flash (Per Adapter Port or All HBAs) (Command Line
Option -b) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-65
Save Flash (Per Adapter Port) (Command Line Option -b and
Reserved Word “save”) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-65
Update HBA Parameters (Per Adapter Port or All HBAs)
(Command Line Option -r) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-65
Save HBA Parameters (Per Adapter Port) (Command Line
Option -r and Reserved Word “save”). . . . . . . . . . . . . . . . . . . . . . . . 3-66
HBA Parameters Template (Per Adapter or All HBAs)
(Command Line Option -n and OEM Name). . . . . . . . . . . . . . . . . . . 3-66
Update Driver (Command Line Option -d). . . . . . . . . . . . . . . . . . . . . . 3-69
Update Firmware Preload Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-69
Save Firmware Preload Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-70
Update MPI Config Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-71
Save MPI Config Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-71
Driver Rescan (Command Line Option -rs) . . . . . . . . . . . . . . . . . . . . . 3-72
Firmware Area Update (Command Line Option -u). . . . . . . . . . . . . . . 3-72
Firmware Area Save (Command Line Option -u) . . . . . . . . . . . . . . . . 3-74
Beacon Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-75
Locate HBA: HBA Beacon (Command Line Option -a) . . . . . . . . . . . . 3-75
Locate Target(s): Target Beacon (Command Line Option -tb). . . . . . . 3-75
Beacon Selected Target(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-76
viii SN0054614-00 K
SANsurfer FC/CNA HBA CLI User’s Guide
Command Line Interface for QLogic FC and FCoE Adapters
Diagnostics Menu (Command Line Options -kl, -kr, and -dm) . . . . . . . . . . . 3-76
Diagnostics Loopback Test (Command Line Option -kl) . . . . . . . . . . . 3-77
Display Test Parameters (Loopback) . . . . . . . . . . . . . . . . . . . . . 3-79
Reset Test Parameters (Loopback) . . . . . . . . . . . . . . . . . . . . . . 3-80
Configure Test Parameters (Loopback) . . . . . . . . . . . . . . . . . . . 3-80
Start Diagnostic Test (Loopback) . . . . . . . . . . . . . . . . . . . . . . . . 3-82
Diagnostics Read/Write Buffer Test. . . . . . . . . . . . . . . . . . . . . . . . . . . 3-83
Configure Test Parameters (Read/Write) . . . . . . . . . . . . . . . . . . 3-83
Start Diagnostic Test (Read/Write Buffer) . . . . . . . . . . . . . . . . . . 3-84
Diagnostics Transceiver Details: DMI (Command Line
Option -dm) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-85
Transceiver Details: General . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-86
Transceiver Details: Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-86
Statistics Menu (Command Line Options -gs and -ls) . . . . . . . . . . . . . . . . . 3-89
HBA Statistics: Monitoring (Command Line Option -gs) . . . . . . . . . . . 3-90
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-90
Show HBA Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-93
Link Status (Command Line Option -ls). . . . . . . . . . . . . . . . . . . . . . . . 3-93
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-94
Show Link Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-96
Virtual Menu (Command Line Option -vp) . . . . . . . . . . . . . . . . . . . . . . . . . . 3-97
Virtual Menu for Adapter Instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-98
List Virtual Port(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-99
Delete Virtual Port(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-99
Create Virtual Port(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-100
QoS Menu (Command Line Option -qos). . . . . . . . . . . . . . . . . . . . . . . . . . . 3-101
QoS Priority Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-103
QoS Bandwidth Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-104
QoS Bandwidth Speed Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-105
QoS Bandwidth Percentage Menu . . . . . . . . . . . . . . . . . . . . . . . 3-107
FCoE Menu (Command Line Option -cna). . . . . . . . . . . . . . . . . . . . . . . . . . 3-108
FCoE Utilities Menu for QLE80xx Adapters . . . . . . . . . . . . . . . . . . . . 3-108
Update Firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-109
Stats Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-109
Logs Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-110
SN0054614-00 K ix
SANsurfer FC/CNA HBA CLI User’s Guide
Command Line Interface for QLogic FC and FCoE Adapters
FCoE Utilities Menu for QLx81xx Adapters (Command Line
Option -cna) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-111
Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-112
Data Center Bridging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-112
DCE Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-114
TLV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-118
Help Menu (Command Line Option -h) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-120
Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-121
Exit Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-121
About . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-121
4 Non-Interactive Commands
Display System Information (Command Line Options -g, -z, and -tp) . . . . . 4-1
Host Information (Command Line Option -g). . . . . . . . . . . . . . . . . . . . 4-1
Host Configuration (Command Line Option -z) . . . . . . . . . . . . . . . . . . 4-2
Host Topology (Command Line Option -tp) . . . . . . . . . . . . . . . . . . . . . 4-3
Host Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Command Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
-a (View or Toggle Beacon Status) . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
-b (Save or Update the Flash BIOS or FCode) . . . . . . . . . . . . . . . . . . 4-7
-c (Show Parameter Settings) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
-cna (FCoE Utilities Menu for QLx81xx Adapters). . . . . . . . . . . . . . . . 4-8
-d (Update Device Driver) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
-dm (Display Diagnostics Monitoring Info). . . . . . . . . . . . . . . . . . . . . . 4-10
-e (Boot Device View | Select | Disable) . . . . . . . . . . . . . . . . . . . . . . . 4-11
-ei (List SANsurfer FC/CNA HBA CLI Error Codes) . . . . . . . . . . . . . . 4-13
-f (Input Parameter Options from a Text File) . . . . . . . . . . . . . . . . . . . 4-13
-fcoe (Display and Configure FCoE Engine Parameters) . . . . . . . . . . 4-14
-fg (Show Driver Settings) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16
-fs (Configure Driver Settings). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16
-g (Display System Information) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18
-gs (Show HBA Statistics) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18
-h (Help). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19
-ha (Set | Delete HBA Alias) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19
-i (Display HBA General Information or VPD Information for
One or All HBAs). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20
-kl (Loopback Test) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20
DataPattern (DP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-21
DataSize (DS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23
TestCount (TC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23
x SN0054614-00 K
SANsurfer FC/CNA HBA CLI User’s Guide
Command Line Interface for QLogic FC and FCoE Adapters
TestIncrement (TI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23
OnError (OE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24
LoopbackType (LT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24
Run a Loopback Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24
-kl (Run HBA Diagnostics Loopback Test). . . . . . . . . . . . . . . . . . . . . . 4-27
-kr (Run Read/Write Buffer Test) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27
Run a Read/Write Buffer Test . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28
Run Adapter Diagnostics Read-write Buffer Test . . . . . . . . . . . . 4-30
-l (Display LUN Info) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-32
-ls (Display Link Status) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-32
-m (View, Enable, or Disable LUNs) . . . . . . . . . . . . . . . . . . . . . . . . . . 4-33
-n (Set Selected HBA Parameter) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-35
-o (Output to a File) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-37
-p (Display Persistent Target Binding Info) . . . . . . . . . . . . . . . . . . . . . 4-38
-pa (Define Port Alias) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-40
-pl (Show, Add, and Delete Persistent Names) . . . . . . . . . . . . . . . . . . 4-41
-q (View or Set Target Link Speed) . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-42
-qos (QoS Menu). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-43
-r (Update HBA Parameters) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-44
-s (Silent Mode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-45
-t (Display Target Information) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-45
-tb (Target Beacon On/Off) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-46
-tp (Display Host Topology) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-46
-u (Firmware Area Update/Save). . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-46
-v (Display Version) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-47
-vp (Virtual Port) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-47
-x (Output in XML Format 1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-48
-x2 (Output in XML Format 2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-48
-z (Display All HBA information for One or All HBAs) . . . . . . . . . . . . . 4-49
AXML Format 1
Output Parts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Main Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Utility Header. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Status Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
Reboot Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
Error Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
XML Format 1 Tags for Each Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
Display System Information (Command Line Option -g) . . . . . . . . . . . A-3
Display Adapter Settings (Command Line Option -c) . . . . . . . . . . . . . A-4
SN0054614-00 K xi
SANsurfer FC/CNA HBA CLI User’s Guide
Command Line Interface for QLogic FC and FCoE Adapters
Display HBA Information (Command Line Option -i) . . . . . . . . . . . . . . A-5
Display Device List (Command Line Option -t) . . . . . . . . . . . . . . . . . . A-7
Display LUN List (Command Line Option -l) . . . . . . . . . . . . . . . . . . . . A-7
Target Persistent Binding (Command Line Option -p) . . . . . . . . . . . . . A-8
Selective LUNs (Command Line Option -m) . . . . . . . . . . . . . . . . . . . . A-8
Boot Device (Command Line Option -e) . . . . . . . . . . . . . . . . . . . . . . . A-9
Diagnostics Results—Loopback Test (Command Line
Option -kl) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-9
Diagnostics Results—Read/Write Buffer Test (Command Line
Option -kr) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-10
View Driver Settings (Command Line Option -fg) . . . . . . . . . . . . . . . . A-10
Display All Information for One or All Adapters (Command Line
Option -z) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-11
Link Statistics (Command Line Option -ls). . . . . . . . . . . . . . . . . . . . . . A-14
HBA Statistics (Command Line Option -gs). . . . . . . . . . . . . . . . . . . . . A-14
HBA Alias (Command Line Option -ha). . . . . . . . . . . . . . . . . . . . . . . . A-15
HBA Port Alias (Command Line Option -pa) . . . . . . . . . . . . . . . . . . . . A-15
HBA Transceiver Details (Command Line Option -dm) . . . . . . . . . . . . A-16
Host Topology (Command Line Option -tp) . . . . . . . . . . . . . . . . . . . . . A-20
Display FCoE Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-22
Display FCoE Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-23
Display FCoE Link Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-23
Display FCoE DCBX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-25
Display FCoE Network Interface Statistics . . . . . . . . . . . . . . . . . . . . . A-26
BXML Format 2
Output Parts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1
Main Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1
Utility Header. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-2
Status Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-2
Reboot Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-2
Error Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-2
XML Format 2 Tags for Each Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-3
Display System Information (Command Line Option -g) . . . . . . . . . . . B-4
Display Adapter Settings (Command Line Option -c) . . . . . . . . . . . . . B-4
Display HBA Information (Command Line Option -I). . . . . . . . . . . . . . B-5
Display Device List (Command Line Option -t) . . . . . . . . . . . . . . . . . . B-7
Display LUN List (Command Line Option -l) . . . . . . . . . . . . . . . . . . . . B-8
Target Persistent Binding (Command Line Option -p) . . . . . . . . . . . . . B-9
Selective LUNs (Command Line Option -m) . . . . . . . . . . . . . . . . . . . . B-9
xii SN0054614-00 K
SANsurfer FC/CNA HBA CLI User’s Guide
Command Line Interface for QLogic FC and FCoE Adapters
Boot Device (Command Line Option -e) . . . . . . . . . . . . . . . . . . . . . . . B-10
Diagnostics Results—Loopback Test (Command Line
Option -kl) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-11
Diagnostics Results—Read/Write Buffer Test (Command Line
Option -kr) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-12
View Driver Settings (Command Line Option -fg) . . . . . . . . . . . . . . . . B-12
Display All Information for One or All Adapters (Command Line
Option -z) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-13
Link Statistics (Command Line Option -ls). . . . . . . . . . . . . . . . . . . . . . B-16
HBA Statistics (Command Line Option -gs). . . . . . . . . . . . . . . . . . . . . B-17
HBA Alias (Command Line Option -ha). . . . . . . . . . . . . . . . . . . . . . . . B-18
HBA Port Alias (Command Line Option -pa) . . . . . . . . . . . . . . . . . . . . B-18
HBA Transceiver Details (Command Line Option -dm) . . . . . . . . . . . . B-20
Host Topology (Command Line Option -tp) . . . . . . . . . . . . . . . . . . . . . B-25
Display FCoE Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-27
Display FCoE Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-27
Display FCoE Link Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-27
Display FCoE DCBX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-29
Display FCoE Network Interface Statistics . . . . . . . . . . . . . . . . . . . . . B-30
C Error/Exit Return Codes
D Help Commands
Glossary
Index
List of Figures
Figure Page
1-1 Selecting Adapter Model (Example). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
1-2 Preparing to Install Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
1-3 Welcome Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-9
1-4 Choose Destination Location Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
1-5 Ready to Install the Program Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
1-6 Setup Status Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11
1-7 InstallShield Wizard Complete DIalog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12
SN0054614-00 K xiii
SANsurfer FC/CNA HBA CLI User’s Guide
Command Line Interface for QLogic FC and FCoE Adapters
List of Tables
1-1 Windows Command Line Installation Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13
2-1 Non-interactive Mode Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
3-1 Adapter Parameters Settings (NVRAM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-27
3-2 Target/LUN Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-37
3-3 Target Link Speed Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-47
3-4 Driver Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-63
3-5 Template Supported Parameter Settings for QLA24xx/QLE24xx and
QLE256x Adapters (ISP2422). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-67
3-6 Template Supported Parameter Settings for QLA24xx/QLE24xx and
QLE256x Adapters (ISP2432). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-67
3-7 Template Supported Parameter Settings for QLA23xx Adapters
(ISP2300/2310). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-68
3-8 Template Supported Parameter Settings for QLA23xx Adapters (ISP2312) . . . . . . 3-68
3-9 Template Supported Parameter Settings for QLA23xx Adapters (ISP2322) . . . . . . 3-68
3-10 Adapter Diagnostics Configuration Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-81
3-11 Adapter Port Statistics Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-91
3-12 Statistics/Link Status Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-94
3-13 DCBX and ETS Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-113
4-1 Options Shown by -z . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
4-2 Command Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
4-3 DCE™ Statistics Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
4-4 FCoE Engine Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15
4-5 Driver Settings Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17
4-6 Adapter Statistics Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18
4-7 Data Pattern Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22
4-8 OnError Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24
4-9 LoopbackType Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24
4-10 Driver Versions Not Requiring a Loopback Connector. . . . . . . . . . . . . . . . . . . . . . . 4-25
4-11 Diagnostics Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-30
4-12 Data Pattern (DP) Test Patterns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-31
4-13 Link Status Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-33
4-14 Adapter Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-36
A-1 Options Shown by -z . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-11
B-1 Options Shown by -z . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-13
C-1 Error/Exit Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1
D-1 Variables Used in Arguments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1
D-2 Help Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-2
xiv SN0054614-00 K
Preface
The SANsurfer® FC/CNA HBA CLI tool provides a command line interface (CLI)
that lets you easily install, configure, and deploy QLogic
adapters, as well as QLogic Fibre Channel over Ethernet (FCoE) converged
network adapters (CNAs). It also provides robust diagnostic and troubleshooting
capabilities and useful statistical information to optimize SAN performance. This
tool only configures adapters on the local machine (where SANsurfer FC/CNA
HBA CLI is installed.)
SANsurfer FC/CNA HBA CLI is a simplified, condensed version of the SANsurfer
FC HBA Manager graphical user interface (GUI), which manages both local and
remote hosts.
SANsurfer FC/CNA 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, CNA, and adapter.
®
Fibre Channel (FC)
Intended Audience
This guide is intended for end users responsible for administration of QLogic FC
adapters.
What’s in This Guide
This preface provides a general overview of the product and covers the intended
audience, related materials, document conventions, and contact information for
technical support.
SN0054614-00 K xv
Preface
What’s in This Guide
The remainder of this guide is organized into the following chapters and
appendices:
1 Installation and Removal lists the supported QLogic adapters and
2 Getting Started describes the two modes used in SANsurfer FC/CNA HBA
3 Interactive Commands provides detailed explanations and examples of
4 Non-Interactive Commands provides detailed explanations and examples
Appendix A XML Format 1 provides explanations and examples of XML files
operating systems, lists the system hardware and software requirements,
and provides step-by-step instructions for installing and uninstalling
SANsurfer FC/CNA HBA CLI on Windows, Linux, Solaris, and Macintosh.
CLI: interactive and non-interactive. It also explains some special terms
used in this guide.
the command line options used in interactive mode.
of the command line options used in non-interactive mode.
created with the -x1 command line option.
Appendix B XML Format 2 provides explanations and examples of XML files
created with the -x2 command line option.
Appendix C Error/Exit Return Codes lists the error return codes that can
occur while running SANsurfer FC/CNA HBA CLI in interactive and
non-interactive modes. For each return code number, it provides the name
and description.
Appendix D Help Commands 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.
Documentation Conventions
This guide uses the following typographic conventions:
Te x t i n bold font indicates a menu or menu item. For example:
From the General Information Menu, type the number for Host
Topology.
Text in a monospace 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:
# scli -z
xvi SN0054614-00 K
Preface
License Agreements
Te x t i n
keyboard. For example:
Italicized text indicates either a document reference, glossary term, or
emphasis. For example:
Italicized text within angle brackets indicates user-defined variables. For
example:
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:
In 3 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/CNA 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.
ALL CAPITALS
Type the number for Host Information and then press
Attached Port means a QLogic adapter....
For a complete list, see the QLogic SAN Interoperability Guide.
# scli -k (<hba instance> | <hba wwpn>)
Visit the QLogic support Web site at support.qlogic.com
firmware and product updates.
For information on the Virtual Menu, see “Virtual Menu for Adapter
Instance” on page 3-98.
indicates the name of a key that you press on the
ENTER
.
for the latest
The following shows a breadcrumbs example:
1: General Information 2: Host Topology 2: Save to Text File
Related Materials
For additional information, refer to the SANsurfer FC/CNA HBA CLI ReadMe file
and release notes.
License Agreements
Refer to the QLogic Software End User License Agreement for a complete listing
of all license agreements affecting this product.
SN0054614-00 K xvii
Preface
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.
Visit the QLogic support Web site listed in Contact Information for the latest
firmware and software updates.
Availability
QLogic Technical Support for products under warranty is available during local
standard working hours excluding QLogic Observed Holidays.
Training
QLogic offers training for technical professionals for all iSCSI, InfiniBand, and
Fibre Channel products. From the main QLogic Web page, www.qlogic.com
the Education and Resources tab at the top, and then click the Education &
Training tab at the left. The QLogic Global Training Portal offers online courses,
certification exams, and scheduling of in-person training.
, click
Technical certification courses include installation, maintenance, and
troubleshooting QLogic 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
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:
Web http://support.qlogic.com
E-mail support@qlogic.com
The QLogic knowledge database contains troubleshooting information for the
QLogic adapters. Access the database from the QLogic Support Web page,
http://support.qlogic.com
specific troubleshooting information.
.
. Use the Support Center search engine to look for
xviii SN0054614-00 K
1 Installation and Removal
This chapter lists the supported QLogic adapters and system requirements,
provides procedures for downloading and installing SANsurfer FC/CNA HBA CLI,
and instructions for removing the product. Refer to the following sections:
“Supported QLogic Adapters” on page 1-2
“Supported Operating Systems” on page 1-3
“System Requirements” on page 1-4
“Downloading the Installation Package” on page 1-6
“Installing SANsurfer FC/CNA HBA CLI” on page 1-7
“Uninstalling SANsurfer FC/CNA HBA CLI” on page 1-21
Prerequisites
Before you run SANsurfer FC/CNA HBA CLI, ensure that the following
requirements are met:
The adapters must be installed.
The adapter drivers must be installed.
For QLE81xx and QMI81xx adapters, a QLogic-specific small form factor
pluggable (SFP) must be installed.
NOTE:
Some SANsurfer FC/CNA 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.
SN0054614-00 K 1-1
1–Installation and Removal
Supported QLogic Adapters
Supported QLogic Adapters
SANsurfer FC/CNA HBA CLI is supported for the following QLogic adapters:
QLA2xx
QLA234x
QLE2xx
QLA246x
QLE246x
QLE256x
QLE8042
QLE81xx
QMI81xx
Not all SANsurfer FC/CNA HBA CLI features are available on every supported
adapter. For more information, see “Unsupported Features” on page 1-5.
NOTE:
If SANsurfer FC/CNA HBA CLI detects an unsupported adapter, the
following message appears, where X is the adapter instance number and
YYYYYYY is the adapter model:
Unsupported HBA (Instance X – YYYYYYY)
If SANsurfer FC/CNA HBA CLI detects an adapter for which no information
is known, the following message appears, where X is the adapter instance
number, 0xYYYY is the subsystem vendor ID, and 0xZZZZ is subsystem
device ID of the adapter:
Unknown HBA type (Instance X SSVID=0xYYYY SSDID=0xZZZZ)!
1-2 SN0054614-00 K
Supported Operating Systems
SANsurfer FC/CNA HBA CLI is supported on the following operating systems:
®
Microsoft
Windows 2000, 32-bit, Intel x86 Intel 64, AMD64
Windows Server 2003, 32-bit Intel x86, Intel 64, AMD64
Windows Server 2008, 32-bit Intel x86, Intel 64, AMD64
Windows XP Professional, 32-bit Intel x86, Intel 64, AMD64
Windows XP Professional, x64-bit Intel 64, AMD64
Windows Vista, 32-bit Intel x86
Windows Vista x64
Linux
Red Hat
Red Hat RHEL AS/ES 4.5 32-bit, 64-bit Intel IA64, Intel 64, AMD64
Red Hat RHEL AS/ES 4.0 32-bit, 64-bit Intel IA64, Intel 64, AMD64
Red Hat RHEL AS/ES 3.0 32-bit, 64-bit Intel x86, Intel 64, AMD64
Red Hat PowerPC64
Novell
Novell SLES 9 32-bit, 64-bit Intel IA64, Intel 64, AMD64
Novell SLES 8 32-bit, 64-bit Intel x86, AMD64
Novell PowerPC64
Windows®:
®
:
®
RHEL AS/ES 5.0 32-bit, 64-bit Intel IA64, Intel 64, AMD64
®
SLES 10 32-bit, 64-bit Intel IA64, Intel 64, AMD64
1–Installation and Removal
Supported Operating Systems
NOTE:
RHEL 3.0 and SLES 8 do not support 8Gb adapters.
®
Solaris
:
Solaris 9, 10 x86 32-bit, 64-bit Intel x86, Intel 64, AMD64
Solaris 2.6, 7, 8, 9, and 10 SPARC 32-bit, 64-bit SPARC
Apple
®
Macintosh®:
Mac OS X (Panther/Tiger), 32-bit, 64-bit PowerPC/Intel
NetWare
®
:
NetWare 6.5 32-bit Intel x86, Intel 64, AMD64
VMware
®
ESX:
ESX 3.5 32-bit, Intel 64, AMD64
SN0054614-00 K 1-3
1–Installation and Removal
System Requirements
NOTES:
Throughout this guide, the terms Windows, Linux, Solaris, and
Macintosh refer to all the respective supported operating systems unless
otherwise noted.
For specific service packs (SPs) and OS updates, refer to the
descriptions where this software version is posted on the QLogic Web
site: http://support.qlogic.com
System Requirements
The system requirements for SANsurfer FC/CNA HBA CLI are described in the
following sections:
“Hardware Requirements” on page 1-4
“Software Requirements” on page 1-5
.
Hardware Requirements
The minimum hardware requirements are as follows:
QLogic adapters (see “Supported QLogic Adapters” on page 1-2).
Single- or multiprocessor server or workstation:
Pentium
Server 2003, Windows XP Professional, Linux, and Solaris.
Windows Vista and Windows Server 2008—Use the minimum
requirements from Microsoft.
Power Mac
FC devices, such as disks and RAID subsystems.
QLogic FC adapters.
SANsurfer FC/CNA 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:
http://connect.qlogic.com/interopguide/Interoperability.asp
NOTE:
Tape devices are shown as part of the configuration, but are not fully
supported by SANsurfer FC/CNA HBA CLI. Only persistent binding and LUN
masking are available.
®
III with 450 MHz or greater for Windows 2000, Windows
®
G5 1.8 MHz or greater with 512 MB of memory.
1-4 SN0054614-00 K
256 MB physical RAM are required to run SANsurfer FC/CNA 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.
Software Requirements
The minimum software requirements are as follows:
QLogic drivers for your OS platform.
Administrative privileges to perform management functions.
One of the operating systems listed in “Supported Operating Systems” on
page 1-3.
Unsupported Features
Depending on your system, not all SANsurfer FC adapter features are available.
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 ports:
1–Installation and Removal
System Requirements
Adapter parameters settings
Adapter parameters restore default
Flash update from file
Flash save to file
Adapter parameters update from file
Adapter parameters save to file
Adapter parameters update from templates
Target link speed
Boot device settings
Driver settings
Adapter beacon
Target/LUN list
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
Adapter port statistics
Driver settings
Host topology
SN0054614-00 K 1-5
1–Installation and Removal
Downloading the Installation Package
Features Not Available When Running Linux with Converged Network Adapters
When running Linux OS with converged network adapters (QLE81xx and
QMI81xx), the following features are not available:
Support for inbox driver only; no driver update support
Persistent binding
Adapter port statistics
iiDMA support
Loopback test
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
Adapter port statistics
Driver settings
Host topology
Link status
Loopback test
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:
Adapter parameters settings
Adapter parameters restore default
Flash update from file
Flash save to file
Adapter parameters update from file
Adapter parameters save to file
Adapter parameters update from templates
Downloading the Installation Package
Follow these steps to download the SANsurfer FC/CNA HBA CLI installation
package from the QLogic Web site.
To download the installation package:
1. From the QLogic home page (www.qlogic.com
2. On the Driver Downloads / Manuals page, select Fibre Channel HBAs,
your adapter model, and operating system, and then click Go!
), click the Downloads tab.
1-6 SN0054614-00 K
1–Installation and Removal
Installing SANsurfer FC/CNA HBA CLI
Figure 1-1 shows an example.
Figure 1-1 Selecting Adapter Model (Example)
The resources page for the selected model appears.
3. Under Management Tools, click SANsurfer CLI....
The End User Software License Agreement page appears.
4. Scroll to the bottom and click Agree.
5. On the File Download dialog box, click Save. Select a directory on your
system and download the file.
Installing SANsurfer FC/CNA HBA CLI
NOTE:
If you have a previous version of SANsurfer FC HBA CLI already installed,
the installation program (except on Solaris) provides the option to upgrade
the previous version to this latest version. However, QLogic recommends
that you always uninstall any older version of SANsurfer before
installing the new version.
Follow the installation instructions in the section that corresponds to your
operating system (OS):
“Windows Installation” on page 1-8
“Linux Installation” on page 1-14
“Solaris Installation” on page 1-15
“Macintosh Installation” on page 1-18
“VMware Installation” on page 1-20
SN0054614-00 K 1-7
1–Installation and Removal
Installing SANsurfer FC/CNA HBA CLI
Windows Installation
To install SANsurfer FC/CNA HBA CLI on Windows, follow either the GUI or
command line installation steps:
“Standard (GUI) Installation” on page 1-8
“Command Line Installation” on page 1-12
Standard (GUI) Installation
Follow these steps to install SANsurfer FC/CNA HBA CLI on a Windows operating
system using the standard (GUI) method.
To install SANsurfer FC/CNA HBA CLI on Windows (GUI):
1. Locate and double-click the installer package.
The Preparing to Install dialog box appears, as shown in Figure 1-2. The
status bar indicates that the installation package is loading.
Figure 1-2 Preparing to Install Dialog Box
1-8 SN0054614-00 K
1–Installation and Removal
Installing SANsurfer FC/CNA HBA CLI
After the install package is loaded, the Welcome dialog box appears as
shown in Figure 1-3.
Figure 1-3 Welcome Dialog Box
2. Read the information, and then click Next.
SN0054614-00 K 1-9
1–Installation and Removal
Installing SANsurfer FC/CNA HBA CLI
The Choose Destination Location dialog box appears as shown in
Figure 1-4.
Figure 1-4 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
To select a different location:
a. Click Browse.
b. Select an installation location.
c. The Choose Destination Location dialog box reappears. Click
Next.
1-10 SN0054614-00 K
1–Installation and Removal
Installing SANsurfer FC/CNA HBA CLI
The Ready to Install the Program dialog box appears as shown in
Figure 1-5.
Figure 1-5 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 1-6.
Figure 1-6 Setup Status Dialog Box
SN0054614-00 K 1-11
1–Installation and Removal
Installing SANsurfer FC/CNA HBA CLI
If you want to stop the installation, click Cancel.
The InstallShield Wizard Complete dialog box appears as shown in
Figure 1-7.
Figure 1-7 InstallShield Wizard Complete DIalog Box
5. (Optional.) Select one of the following:
If you want to see more information about SANsurfer FC/CNA HBA
CLI, select the I would like to view the README file check box.
If you want to start SANsurfer FC/CNA HBA CLI, select the I would
like to launch SANsurfer FC CLI check box.
6. Click Finish.
Command Line Installation
To install SANsurfer FC/CNA HBA CLI using the command line installation, follow
the steps for either standard or silent installation:
“Standard Command Line Installation” on page 1-13
“Silent Command Line Installation” on page 1-13
1-12 SN0054614-00 K
Loading...