Q-Logic SN0054621-00 E User Manual

SANsurfer iSCSI HBA CLI

User’s Guide

Command Line Interface for

QLogic iSCSI Host Bus Adapters

SN0054621-00 E

SANsurfer iSCSI HBA CLI User’s Guide

Command Line Interface for QLogic iSCSI Host Bus Adapters

Information furnished in this manual is believed to be accurate and reliable. However, QLogic Corporation assumes no responsibility for its use, nor for any infringements of patents or other rights of third parties which may result from its use. QLogic Corporation reserves the right to change product specifications at any time without notice. Applications described in this document for any of these products are for illustrative purposes only. QLogic Corporation makes no representation nor warranty that such applications are suitable for the specified use without further testing or modification. QLogic Corporation assumes no responsibility for any errors that may appear in this document.

Document Revision History

Revision A, September 30, 2005

Revision B, November 10, 2005

Revision C, July 14, 2006

Revision D, May 7, 2007

Revision E, October 17, 2008

Changes	Sections Affected


Revision E Changes:
Applied new user’s guide template.	All
Updated guide title and subtitle.	Title page, page headers
Enhanced and edited all content, including index.	All
Removed all references to obsolete features	All
related to DNS and SLP.
Expanded Introduction chapter to include new	Intended Audience, How This Guide is Organized
information.	(Typographic Conventions, Related Documents),
	License Agreements
Added supported operating systems Windows	“Supported Operating Systems” on page 1-4
Server 2008 and Windows PE.
Removed obsolete Linux attended installation sec-	“Installing on Red Hat/SUSE Linux/PPC” on
tion.	page 2-10
Removed Table 2-1.	“Starting Non-interactive Mode” on page 3-2
Updated map of interactive menus and options.	Table 4-1 on page 4-2
Added new firmware update option to Host Level	“Update Firmware, Multiple Adapters” on
Info & Operations menu.	page 4-11
Added new Port Link Settings Menu and menu	“Port Link Settings Menu” on page 4-19
items.
Updated Display Network Settings example.	Display Network Settings (CLI Options -netconf)

Page ii

SN0054621-00 E

SANsurfer iSCSI HBA CLI User’s Guide Command Line Interface for QLogic iSCSI Host Bus Adapters

Updated (added and removed parameters) the list of device settings.

Updated (added and removed parameters) the list of basic settings.

Updated (added and removed parameters) the list of advanced settings.

Changed Bootcode Settings Menu to new BIOS/UEFI (or FCode) Settings Menu.

Removed Unbind Target option from Target Level Info & Operations menu.

Added more detail for Display Target Information option.

Added new Target Discovery Menu and its options.

Removed subheadings referencing non-existent interactive mode commands.

Added new miscellaneous command line options.

Added new discovered target command line options.

Added new link configuration command line options.

Added other new target command line options.

Added unbind persistent target command line options.

Added new send target and statistics command line options.

Added new port and HBA configuration parameters (each in a separate table).

Added missing descriptions for parameters. Deleted obsolete parameters.

“Configure Device Settings” on page 4-25

“Configure Basic Settings” on page 4-26

“Configure Advanced Settings” on page 4-26

“BIOS/UEFI [or FCode] Settings Menu” on page 4-34

“Target Level Info & Operations” on page 4-36

“Display Target Information (CLI Option -t)” on page 4-37

“Target Discovery Menu” on page 4-44

5 Non-Interactive Mode Commands

“-acb” on page 5-3, “-dce” on page 5-7, “-dp” on page 5-8,

“-dtdsp (Display Discovered Targets)” on page 5-9 through “-dtrema (Remove Discovered Target)” on page 5-11

“-lc (Configure Link Configuration)” on page 5-18 and “-lcd (Display Configured Link Configuration)” on page 5-18

“-pad” on page 5-24, “-pdt” on page 5-24 and “-pet” on page 5-24

“-pu” on page 5-25 and “-px” on page 5-26

“-stadd” on page 5-29 through “-strema” on page 5-30

Appendix A Portand HBA-level Parameters

SN0054621-00 E

Page iii

SANsurfer iSCSI HBA CLI User’s Guide

Command Line Interface for QLogic iSCSI Host Bus Adapters



Added missing descriptions for IPv4TOS and		Appendix C Target Parameters
IPv4TTL parameters.
Deleted obsolete Primary_DNS and SLP_Address
parameters.
Moved trace information from 5 Non-Interactive		Appendix F Using Trace
Mode Commands to a new appendix.

Page iv

SN0054621-00 E

1	Introduction
	Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	1-1
	How This Guide is Organized. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	1-1
	Typographic Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	1-2
	Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	1-3
	Supported QLogic HBAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	1-4
	Supported Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	1-4
	License Agreements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	1-5
	Technical Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	1-5
	Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	1-5
	Training . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	1-5
	Contact Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	1-5

2	Installation and Removal
	Installing SANsurfer iSCSI HBA CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	2-1
	Downloading the Installation Package. . . . . . . . . . . . . . . . . . . . . . . . .	2-1
	Installing on Microsoft Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	2-4
	Windows Standard (GUI) Installation . . . . . . . . . . . . . . . . . . . . .	2-4
	Windows Command Line Installation . . . . . . . . . . . . . . . . . . . . .	2-9
	Installing on Red Hat/SUSE Linux/PPC . . . . . . . . . . . . . . . . . . . . . . .	2-10
	Installing on Solaris SPARC/Solaris x86 . . . . . . . . . . . . . . . . . . . . . . .	2-10
	Solaris Attended Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . .	2-10
	Solaris Silent Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	2-11
	Removing SANsurfer iSCSI HBA CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	2-12
	Microsoft Windows Uninstall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	2-12
	Start Menu Uninstall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	2-12
	Control Panel Uninstall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	2-12
	Command Line Uninstall. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	2-12
	Red Hat/SUSE Linux/PPC Uninstall . . . . . . . . . . . . . . . . . . . . . . . . . .	2-13
	Solaris SPARC/Solaris x86 Uninstall. . . . . . . . . . . . . . . . . . . . . . . . . .	2-13

SN0054621-00 E

Page v

SANsurfer iSCSI HBA CLI User’s Guide

Command Line Interface for QLogic iSCSI Host Bus Adapters


3	Getting Started
	Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-1
	Starting Interactive Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-1
	Starting Non-interactive Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-2

4	Interactive Mode Commands
	Display Program Version Information (CLI Option -ver) . . . . . . . . . . . . . . . .	4-8
	Host Level Info & Operations Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-8
	Display General System Information (CLI Option -g) . . . . . . . . . . . . .	4-9
	Import HBA Menu, Multiple Adapters (CLI Options -import and
	-save) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-9
	Save Host Configuration (CLI Option -save) . . . . . . . . . . . . . . .	4-9
	Import HBA Configuration (CLI Option -import) . . . . . . . . . . . . .	4-10
	Update Firmware, Multiple Adapters . . . . . . . . . . . . . . . . . . . . . . . . . .	4-11
	Install HBA Driver, All Adapters (CLI Option -d) . . . . . . . . . . . . . . . . .	4-11
	Select HBA Port. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-11
	HBA Level Info & Operations Menu (CLI Option -i) . . . . . . . . . . . . . . . . . . .	4-12
	HBA Information (CLI Option -ch) . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-12
	HBA Options Menu (No CLI Option) . . . . . . . . . . . . . . . . . . . . . . . . . .	4-13
	Update BIOS/UEFI [or FCode] Code Image (CLI Option
	-bootcode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-13
	Update Firmware Image (CLI Option -f) . . . . . . . . . . . . . . . . . . .	4-13
	Update ROM Image (CLI Option -r) . . . . . . . . . . . . . . . . . . . . . .	4-14
	HBA Reset (CLI Option -b) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-14
	HBA Diagnostic Menu (No CLI Option) . . . . . . . . . . . . . . . . . . . . . . . .	4-15
	Retrieve FW Crash Record (CLI Option -gcr). . . . . . . . . . . . . . .	4-15
	Retrieve FW Flash & NVRAM Record (CLI Option
	-dumpnvram) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-15
	Retrieve FW Coredump Record (CLI Option -dumpcore). . . . . .	4-16
	Display HBA Level Statistics (CLI Option -stathba) . . . . . . . . . .	4-16
	HBA Level Parameters Menu (No CLI Option) . . . . . . . . . . . . . . . . . .	4-17
	Display HBA Level Parameters (CLI Option -i). . . . . . . . . . . . . .	4-17
	Configure HBA Level Parameters (CLI Option -n) . . . . . . . . . . .	4-18
	Save Changes and Reset HBA . . . . . . . . . . . . . . . . . . . . . . . . .	4-18
	Display VPD Information (CLI Option -vpd). . . . . . . . . . . . . . . . . . . . .	4-18
	Port Level Info & Operations Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-19
	Port Link Settings Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-19
	Display Active Link Configuration . . . . . . . . . . . . . . . . . . . . . . . .	4-19
	Display Configured Link Configuration (CLI Option -lcd) . . . . . .	4-20

Page vi

SN0054621-00 E

SANsurfer iSCSI HBA CLI User’s Guide Command Line Interface for QLogic iSCSI Host Bus Adapters

Configure Link Configuration (CLI Option -lc). . . . . . . . . . . . . . . 4-20 Save Changes and Reset HBA (if necessary) . . . . . . . . . . . . . . 4-20 Port Network Settings Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20 Display Network Settings (CLI Options -netconf) . . . . . . . . . . . . 4-20 Configure IP Settings (CLI Option -ipdhcp) . . . . . . . . . . . . . . . . 4-21 iSNS Settings (CLI Option -isns) . . . . . . . . . . . . . . . . . . . . . . . . 4-21

Edit Configured Port Settings Menu . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22 Display Configured Port Settings (CLI Option -c) . . . . . . . . . . . . 4-22 Change Port ISCSI Alias Name (No CLI Option) . . . . . . . . . . . . 4-22 Port Firmware Settings Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23 Legacy QLA4010 Restore Default Port Settings . . . . . . . . . . . . 4-28

Port Restore Factory Defaults (CLI Option -rdh) . . . . . . . . . . . . . . . . . 4-28 Port Diagnostic Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-29 Ping Target (CLI Option -ping) . . . . . . . . . . . . . . . . . . . . . . . . . . 4-30 Perform Loopback Test (CLI Option -lb) . . . . . . . . . . . . . . . . . . . 4-31 Perform Read/Write Buffer Test (CLI Option -rwt) . . . . . . . . . . . 4-31 Display Port Statistics (CLI Option -stat). . . . . . . . . . . . . . . . . . . 4-32 Reset Statistics (CLI Option -sreset). . . . . . . . . . . . . . . . . . . . . . 4-32 Display ARP Table (CLI Option -arp) . . . . . . . . . . . . . . . . . . . . . 4-32 Display Connection Error Log. . . . . . . . . . . . . . . . . . . . . . . . . . . 4-32 Export Connection Error Log . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-33 Display Neighbor Cache (IPv6) (CLI Option -nc) . . . . . . . . . . . . 4-33 Display Destination Cache (IPv6) (CLI Option -dc) . . . . . . . . . . 4-33 Display Default Router List (IPv6) (CLI Option -dr). . . . . . . . . . . 4-33 Display Local Prefix List (IPv6) (CLI Option -lp) . . . . . . . . . . . . . 4-33 BIOS/UEFI [or FCode] Settings Menu. . . . . . . . . . . . . . . . . . . . . . . . . 4-34

Display BIOS/UEFI [or FCode] Information (CLI Option

-binfo) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-35

Set BIOS/UEFI [or FCode] Mode (CLI Option

-bootcodemode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-35

Set Primary Boot Target Information (CLI Option

-pbootcode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-35

Set Secondary Boot Target Information (CLI Option

-sbootcode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-35

Clear Primary Boot Target Information (CLI Option

-cpbootcode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-36

Clear Secondary Boot Target Information (CLI Option

-csbootcode). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-36 Set Alternative Client ID (CLI Option -sbootcodecid) . . . . . . . . . 4-36

SN0054621-00 E

Page vii

SANsurfer iSCSI HBA CLI User’s Guide

Command Line Interface for QLogic iSCSI Host Bus Adapters


	. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Target Level Info & Operations	4-36
	List Targets (CLI Option -t) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-37
	Display Target Information (CLI Option -t) . . . . . . . . . . . . . . . . .	4-37
	Bind Target (CLI Option -pb). . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-39
	Delete Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-39
	Configure Target Parameters (CLI Option -tc) . . . . . . . . . . . . . .	4-39
	Add a Target (CLI Option -pa). . . . . . . . . . . . . . . . . . . . . . . . . . .	4-40
	Disable a Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-40
	Enable a Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-40
	Configure Target Authentication Menu . . . . . . . . . . . . . . . . . . . .	4-40
	Target Discovery Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-44
	List LUN Information (CLI Option -l) . . . . . . . . . . . . . . . . . . . . . .	4-47
	Save Target/CHAP Changes (No CLI Option) . . . . . . . . . . . . . .	4-47
	List All QLogic iSCSI HBA Ports Detected (CLI Option -i) . . . . . . . . . . . . . .	4-48
	Help (CLI Option -h) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-49
	Select HBA Port (No CLI Option) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-49
	Refresh (No CLI Option). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-49
	Exit (No CLI Option) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-50
5	Non-interactive Mode Commands
	Non-interactive Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-3
	-acb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-3
	-addchap (Add a CHAP Entry) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-3
	-arp (Display ARP Table) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-3
	-b (HBA Reset) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-3
	-binfo (Display BIOS/UEFI [or FCode] Information). . . . . . . . . . . . . . .	5-4
	-bootcode (Update BIOS/UEFI [or FCode] Mode). . . . . . . . . . . . . . . .	5-4
	-bootcodemode (Set BIOS/UEFI [or FCode] Mode) . . . . . . . . . . . . . .	5-4
	-c (Display Configured Port Settings) . . . . . . . . . . . . . . . . . . . . . . . . .	5-5
	-ch (HBA Information) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-5
	-chapmap (Display Targets Using CHAP Entries) . . . . . . . . . . . . . . . .	5-6
	-cpbootcode (Clear Primary Boot Target Information) . . . . . . . . . . . . .	5-6
	-csbootcode (Clear Secondary Boot Target Information) . . . . . . . . . .	5-6
	-d (Install HBA Driver, All Adapters) . . . . . . . . . . . . . . . . . . . . . . . . . .	5-6
	-dc (Display Destination Cache [IPv6 only]) . . . . . . . . . . . . . . . . . . . .	5-7
	-dce . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-7
	-defbidi (Add a Default BIDI CHAP). . . . . . . . . . . . . . . . . . . . . . . . . . .	5-7
	-delchap (Delete a CHAP Entry) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-7
	-df . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-8
	-dp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-8

Page viii

SN0054621-00 E

SANsurfer iSCSI HBA CLI User’s Guide Command Line Interface for QLogic iSCSI Host Bus Adapters


. . . . . . . . . . . . . . . . . . . .-dr (Display Default Router List [IPv6 only])		5-8
-dspchap (Display a CHAP Table). . . . . . . . . . . . . . . . . . . . . . . . . . . .		5-9
-dtdsp (Display Discovered Targets) . . . . . . . . . . . . . . . . . . . . . . . . . .		5-9
-dtdspa (List Targets) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		5-9
-dtdupd (Duplicate a Discovered Target) . . . . . . . . . . . . . . . . . . . . . . .		5-9
-dtdupd (Duplicate a Persistent Target) . . . . . . . . . . . . . . . . . . . . . . . .		5-10
-dtli (Login and Persist a Discovered Target). . . . . . . . . . . . . . . . . . . .		5-10
-dtlia (Login and Persist a Discovered Target). . . . . . . . . . . . . . . . . . .		5-10
-dtrem (Remove Discovered Target) . . . . . . . . . . . . . . . . . . . . . . . . . .		5-10
-dtrema (Remove Discovered Target) . . . . . . . . . . . . . . . . . . . . . . . . .		5-11
-dumpcore (Retrieve FW Coredump Record) . . . . . . . . . . . . . . . . . . .		5-11
-dumpnvram (Retrieve FW Flash & NVRAM Record) . . . . . . . . . . . . .		5-11
-dv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		5-11
-edchap (Edit a CHAP Entry). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		5-11
-ei) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		5-12
-f (Update Firmware Image—Specific HBA) . . . . . . . . . . . . . . . . . . . .		5-12
-fa (Update Firmware Image—All HBAs). . . . . . . . . . . . . . . . . . . . . . .		5-12
-g (Display General System Information) . . . . . . . . . . . . . . . . . . . . . .		5-13
-gcr (Retrieve FW Crash Record) . . . . . . . . . . . . . . . . . . . . . . . . . . . .		5-13
-h (Help). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		5-13
-i (List All QLogic iSCSI HBA Ports Detected). . . . . . . . . . . . . . . . . . .		5-14
-import (Import HBA Configuration). . . . . . . . . . . . . . . . . . . . . . . . . . .		5-15
-ipdhcp (Configure IP Settings) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		5-16
-isns (Configure iSNS Settings). . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		5-16
-isns6 (iSNS Settings) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		5-17
-l (List LUN Information) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		5-17
-lb (Perform Loopback Test) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		5-18
-lc (Configure Link Configuration) . . . . . . . . . . . . . . . . . . . . . . . . . . . .		5-18
-lcd (Display Configured Link Configuration) . . . . . . . . . . . . . . . . . . . .		5-18
-linkchap (Assign a CHAP Entry to a Target). . . . . . . . . . . . . . . . . . . .		5-19
-lp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		5-19
-model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		5-19
-n (Configure iSCSI Settings) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		5-19
-nc (Display Neighbor Cache) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		5-21
-netconf (Configure IPv6 Settings) . . . . . . . . . . . . . . . . . . . . . . . . . . .		5-21
-netconf6 (Configure IPv6 Settings) . . . . . . . . . . . . . . . . . . . . . . . . . .		5-22
-nh (Configure iSCSI Settings) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		5-23
-pa (Add a Target) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		5-23
-pad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .		5-24

SN0054621-00 E

Page ix

SANsurfer iSCSI HBA CLI User’s Guide

Command Line Interface for QLogic iSCSI Host Bus Adapters


	. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .-pb (Bind Target)	5-24
	-pbootcode (Set Primary Boot Target Information) . . . . . . . . . . . . . . .	5-24
	-pdt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-24
	-pet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-24
	-pinfo (Port Information). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-24
	-ping (Ping Target). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-25
	-ps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-25
	-pu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-25
	-px . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-26
	-r (Update ROM Image). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-26
	-rdf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-26
	-rdh (Port Restore Factory Defaults) . . . . . . . . . . . . . . . . . . . . . . . . . .	5-27
	-rwt (Perform Read/Write Buffer Test) . . . . . . . . . . . . . . . . . . . . . . . . .	5-28
	-save (Save Host Configuration) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-28
	-sbootcode (Set Secondary Boot Target Information) . . . . . . . . . . . . .	5-29
	-sbootcodecid (Set Alternative Client ID). . . . . . . . . . . . . . . . . . . . . . .	5-29
	-sdmrc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-29
	-sreset (Reset Statistics) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-29
	-stadd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-29
	-stat (Display Port Statistics) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-30
	-stathba . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-30
	-stdsp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-30
	-strd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-30
	-strem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-30
	-strema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-30
	-t (Display Target Information) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-30
	-tc (Configure Target Parameters). . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-31
	-tp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-31
	-ts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-31
	-ver (Display Program Version Information) . . . . . . . . . . . . . . . . . . . .	5-31
	-vpd (Display VPD Information) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-32
	-z . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-32
A	Portand HBA-level Parameters
	Port-level Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	A-1
	HBA-level Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	A-10

BHBA Statistics

CTarget Parameters

Page x

SN0054621-00 E

SANsurfer iSCSI HBA CLI User’s Guide Command Line Interface for QLogic iSCSI Host Bus Adapters

D	Error Codes
D	Error Codes
	Interactive Mode Error Codes . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . . . . . . D-1
	Non-interactive Mode Error Codes. . . . . . . . . . . . . .	. . . . . . . . . . . . . . . . . . D-5

EDownloadable File Names

FUsing Trace

Trace Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	F-2
Trace Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	F-2
Trace Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	F-4

Glossary

Index

SN0054621-00 E

Page xi

SANsurfer iSCSI HBA CLI User’s Guide

Command Line Interface for QLogic iSCSI Host Bus Adapters

List of Figures

Figure		Page
2-1	Install Wizard: Welcome. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	2-4
2-2	Install Wizard: Select Which Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	2-5
2-3	Install Wizard: Destination Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	2-5
2-4	Install Wizard: Ready to Install. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	2-6
2-5	Install Wizard: Installing SANsurferiCLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	2-7
2-6	Install Wizard: Complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	2-8
3-1	Windows iSCSI icon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	3-1
5-1	HBA Port Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-14

List of Tables

Table		Page
1-1	Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	1-3
1-2	Supported HBAs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	1-4
4-1	Command Line Interface Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	4-2
5-1	Non-interactive Command Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-2
5-2	CHAP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-12
5-3	HBA Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	5-19
A-1	Port Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	A-1
A-2	HBA Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	A-10
B-1	HBA Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	B-1
C-1	Target Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	C-2
D-1	Interactive-Mode Error Code Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	D-1
D-2	Non-interactive Mode Error Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	D-5
E-1	File Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	E-1
F-1	Trace Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	F-2
F-2	Trace Level Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	F-3
F-3	Some More Info About Trace Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	F-3
F-4	Trace Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	F-4

Page xii

SN0054621-00 E

1 Introduction

The command line interface (CLI) application is a simplified, condensed version of the SANsurfer iSCSI HBA Manager graphical user interface (GUI). SANsurfer iSCSI HBA CLI does not provide any features that require a GUI.

This introductory chapter covers the following:

“Intended Audience” on page 1-1

“How This Guide is Organized” on page 1-1

“Supported QLogic HBAs” on page 1-4

“Supported Operating Systems” on page 1-4

“License Agreements” on page 1-5

“Technical Support” on page 1-5

Intended Audience

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

How This Guide is Organized

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

1 Introduction provides a general overview of the product, lists the supported QLogic HBAs and operating systems, and provides contact information for technical support.

2 Installation and Removal provides step-by-step instructions for installing and uninstalling SANsurfer iSCSI HBA CLI on Windows, Linux, and Solaris.

3 Getting Started describes the two modes used in SANsurfer iSCSI HBA CLI: interactive and non-interactive.

4 Interactive Mode Commands provides detailed explanations and examples of the command line options used in the menu-driven interactive mode.

5 Non-Interactive Mode Commands provides detailed explanations and examples of the command line options used in non-interactive mode.

SN0054621-00 E

1-1

1 – Introduction

How This Guide is Organized

Appendix A Portand HBA-level Parameters provides an alphabetic list of the HBA port firmware parameters and their values.

Appendix B HBA Statistics provides an alphabetic list of the HBA statistics shown when you select either the interactive mode Display HBA Statistics option or the non-interactive mode -stat command.

Appendix C Target Parameters provides an alphabetic list of target parameters, both fixed and configurable.

Appendix D Error Codes provides an alphabetic list of the error codes that can occur while running SANsurfer iSCSI HBA CLI in both interactive mode and non-interactive mode.

Appendix E Downloadable File Names lists, by file type and HBA, the typical file names of downloadable files for QLogic iSCSI HBAs.

Appendix F Using Trace provides information for using trace to identify application, HBA, and networking issues.

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

Typographic Conventions

This guide uses the following typographic conventions:

Text in bold font indicates a menu or menu item. For example:

From the HBA Import Menu, type the number for the Import option, and then press ENTER.

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

Enter an IP Address:

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

Type y for the Stop on error[Y]? option.

Text in ALL CAPITALS and sans serif font indicates the name of a key that you press on the keyboard. For example:

Type the number for Host Information and then press ENTER.

Italicized text indicates either a document reference, glossary term, or emphasis. For example:

The HBA port alias is a symbolic name you assign.

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

1-2	SN0054621-00 E

1 – Introduction How This Guide is Organized

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

-arp <hba_port_inst>

Text within square brackets indicates optional parameters. For example iscli [optional parameters] [Command Variable]

Text shown in blue indicates a cross-reference hyperlink to a Web site or to another section of this guide. Click the hyperlink to jump to that site or section. For example:

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

For a list of target parameters, see Table C-1.

Supported QLogic HBAs

SANsurfer iSCSI HBA CLI is supported on the following QLogic HBAs:

Table 1-2. Supported HBAs

HBA	Ports	Media

QLA4010	1	Optical

QLA4010C	1	Copper

QLA4050	1	Optical

QLA4050C	1	Copper

QLA4052C	2	Copper

QLE4060C	1	Copper

QLE4062C	2	Copper

QMC4052 (IBM)	2	Copper

QMH4062 (HP)	2	Copper

Supported Operating Systems

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

Windows® 2000 Server SP4+ (IA32, x64)

Windows Server™ 2003, Standard or Enterprise Edition SP1 (IA32, x64)

Windows Server 2003, Standard or Enterprise Edition, SP2 (IA32, x64)

Windows Server 2008, Standard or Enterprise Edition (IA32, x64)

Windows XP Professional, SP2 (IA32, x64)

Windows Vista (IA32, x64) (Business and Enterprise editions)

Windows Preinstallation Environment (PE) 2.0, 2.1, PE 2004, PE 2005

Red Hat® Enterprise Linux® (RHEL) 3.0, 4.0, 5.0 (IA32, x64)

Red Hat® Enterprise Linux® (RHEL) 4.0, 5.0 (PPC)

Novell® SUSE® Linux Enterprise Server (SLES) 8.0, 9.0, 10.0 (IA32, x64, PPC)

Solaris® SPARC 9, 10

Solaris x86 9, 10 (IA32, x64)

NOTE:

Throughout this guide, HBA may be shortened to adapter. The term device often refers to targets.

1-4	SN0054621-00 E

1 – Introduction

License Agreements

Refer to the QLogic Software End User License Agreement for a complete listing of all license agreements affecting this product.

Technical Support

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

For the latest firmware and software updates, visit the QLogic support Web site listed in Contact Information.

Availability

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

Training

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

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

North America Contact Information

E-mail support@qlogic.com

Phone

(952) 932-4040

Support contact information for other regions of the world is available at the QLogic Web site: http://support.qlogic.com

SN0054621-00 E

1-5

1 – Introduction

Technical Support

The QLogic knowledge database contains troubleshooting information for the QLogic HBAs. Access the database from the QLogic Web site, www.qlogic.com. Click the Support tab, and then use the search engine at the top of the page to look for specific troubleshooting information.

1-6	SN0054621-00 E

2 Installation and Removal

This section provides procedures for the following:

“Installing SANsurfer iSCSI HBA CLI” on page 2-1

“Removing SANsurfer iSCSI HBA CLI” on page 2-12

Before you can run SANsurfer iSCSI HBA CLI, ensure that your system meets the following requirements:

HBAs are installed.

HBA drivers are installed.

To install SANsurfer iSCSI HBA CLI, the PC hard disk must have about 1 MB free space.

NOTE:

SANsurfer iSCSI HBA CLI is designed to configure QLogic HBAs on the local machine (where it is installed). It cannot configure HBAs on remote machines.

Installing SANsurfer iSCSI HBA CLI

This section on SANsurfer iSCSI HBA CLI installation includes the following information:

“Downloading the Installation Package” on page 2-1

“Installing on Microsoft Windows” on page 2-4

“Installing on Red Hat/SUSE Linux/PPC” on page 2-10

“Installing on Solaris SPARC/Solaris x86” on page 2-10

Downloading the Installation Package

Follow the procedure in this section to download the SANsurfer iSCSI HBA CLI installation package from the QLogic Web site.

To download the installation package:

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

2.Select your HBA.

SN0054621-00 E

2-1

2 – Installation and Removal

Installing SANsurfer iSCSI HBA CLI

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

4.In the SANsurfer iSCSI row of the Management Tools table, in the

Download column, click Download.

SANsurfer iSCSI HBA CLI shows the End User License Agreement box.

5.Scroll to the bottom, and then click Agree.

SANsurfer iSCSI HBA CLI shows the File Download dialog box.

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

The installation package has the following naming convention:

iscli-AA.BB.CC-DD_<OS Type>_<Subtype>.<Install Type>

Where:

AA.BB.CC-DD = Version number

OS Type = One of the following:

win

linux

solaris

Subtype = One of the following:

i386

PPC 64 (Power PC)

sparc_x86

(There is no Subtype in the Windows package name.) Install Type = One of the following:

rpm (Linux)

exe (Windows)

Z (Solaris)

For example, a package for the Linux operating system can be named:

iscli-1.0.35-0_linux_i386.rpm

7.Follow the installation instructions in the section for your operating system (OS):

Microsoft® Windows® (see “Installing on Microsoft Windows” on page 2-4)

Windows 2000 Server SP4+ (IA32, x64)

Windows Server 2003, Standard or Enterprise Edition SP1 (IA32, x64)

2-2	SN0054621-00 E

2 – Installation and Removal

Installing SANsurfer iSCSI HBA CLI

Windows Server 2003, Standard or Enterprise Edition, SP2 (IA32, x64)

Windows XP Professional (IA32, x64) SP2

Windows Vista (IA32, x64) (Business and Enterprise editions)

Windows Preinstalled Environment (PE) 2.0, PE 2004, PE 2005

Red Hat/SUSE Linux/Power PC (PPC) (see “Installing on Red Hat/SUSE Linux/PPC” on page 2-10)

Solaris SPARC/Solaris x86 (see “Installing on Solaris SPARC/Solaris x86” on page 2-10)

SN0054621-00 E

2-3

2 – Installation and Removal

Installing SANsurfer iSCSI HBA CLI

Installing on Microsoft Windows

Choose one of the following options for installing SANsurfer iSCSI HBA CLI:

“Windows Standard (GUI) Installation” on page 2-4

“Windows Command Line Installation” on page 2-9

Windows Standard (GUI) Installation

Follow these steps to install SANsurfer iSCSI HBA CLI on a Windows operating system.

To install using the GUI installation:

1.Locate and double-click the install package on the CD or Web site. InstallShield Wizard opens, and shows the welcome window (Figure 2-1).

Figure 2-1 Install Wizard: Welcome

2.Read the information, and then click Next.

2-4	SN0054621-00 E

2 – Installation and Removal

Installing SANsurfer iSCSI HBA CLI

The Select Which Users window appears, as shown in Figure 2-2.

Figure 2-2 Install Wizard: Select Which Users

3.Choose whether you want SANsurfer iSCSI HBA CLI available for all users or only the current user, and then click Next.

The Destination Folder window appears, as shown in Figure 2-3.

Figure 2-3 Install Wizard: Destination Folder

SN0054621-00 E

2-5

2 – Installation and Removal

Installing SANsurfer iSCSI HBA CLI

4.Choose one of the following options:

To select the destination in the dialog box, click Next (recommended).

The default location for a Microsoft Windows system is:

Program Files\QLogic Corporation\SANsurferiCLI

To select a different location, click Change, select the location you want, and then click Next.

The Ready to Install window appears as shown in Figure 2-4.

Figure 2-4 Install Wizard: Ready to Install

5.To begin installation, click Install.

2-6	SN0054621-00 E

2 – Installation and Removal

Installing SANsurfer iSCSI HBA CLI

The installer shows the progress of file copying, as shown in Figure 2-5.

Figure 2-5 Install Wizard: Installing SANsurferiCLI

6.Read the information, and then click Next.

SN0054621-00 E

2-7

2 – Installation and Removal

Installing SANsurfer iSCSI HBA CLI

When finished, the installer shows the InstallShield Wizard Completed window, as shown in Figure 2-6.

Figure 2-6 Install Wizard: Complete

7.Click Finish.

8.Restart your computer.

2-8	SN0054621-00 E

2 – Installation and Removal

Installing SANsurfer iSCSI HBA CLI

Windows Command Line Installation

You can install SANsurfer iSCSI HBA CLI from the command prompt using the Microsoft Windows Installer (MSI). Use one of the following methods:

“Standard Windows Interactive (CLI) Installation” on page 2-9

“Quiet or Unattended Windows Installation” on page 2-9

“Passive Windows Installation” on page 2-9

“Overwrite Previous Windows Installations” on page 2-10

NOTE:

You can also configure the installation using MSI commands. To see a summary of MSI commands, at the command prompt, type: msiexec.

To obtain more information about MSI, visit the Microsoft Web site.

Standard Windows Interactive (CLI) Installation

To begin a standard installation of SANsurfer iSCSI HBA CLI on a Microsoft Windows operating system, at a command line, type one of the following:

SANsurferCLI.msi

msiexec /i SANsurferCLI.msi

The default directory for SANsurfer iSCSI HBA CLI application is:

Program files\QLogic Corporation\SANsurferCLI

If you want a different directory, type it in the command line. For example:

SANsurferCLI.msi INSTALLDIR="directory"

The preceding command installs SANsurfer iSCSI HBA CLI in the directory named directory. Use full path names.

Quiet or Unattended Windows Installation

Type the following for a quiet (silent) installation using default values. For example, the following command installs silently using defaults and does not show any errors:

SANsurferCLI.msi /q

Passive Windows Installation

Type the following for a passive installation using default values. For example:

SANsurferCLI.msi /passive

Installs with minimum interaction, showing only the progress bar and any errors.

SN0054621-00 E

2-9

2 – Installation and Removal

Installing SANsurfer iSCSI HBA CLI

Overwrite Previous Windows Installations

Type the following for an installation that overwrites any previous installations without asking for confirmation. Type:

SANsurferX-AgentOnly.msi /i FORCEINSTALL=TRUE

Installing on Red Hat/SUSE Linux/PPC

SANsurfer iSCSI HBA CLI installation on a Linux system requires that you use the “quiet” installation method. This method ensures that, if needed, the Linux driver interface module (ioctl module) is also installed.

To install quietly on Linux:

1.Unzip and untar the iSCSI CLI gzipped tar bundle as follows: tar -xvzf

2.To start the installation, type:

./iscli.dkms.install.sh install

Installing on Solaris SPARC/Solaris x86

You can install SANsurfer iSCSI HBA CLI on a Solaris SPARC or x86 system with one of the following methods:

“Solaris Attended Installation” on page 2-10

“Solaris Silent Installation” on page 2-11

Solaris Attended Installation

Follow this procedure from the command prompt to install SANsurfer iSCSI HBA CLI on a Solaris SPARC/Solaris x86 operating system.

To install attended on Solaris:

1.To uncompress the package you downloaded in “Downloading the Installation Package” on page 2-1, type the following:

uncompress iscli-AA.BB.CC-DD_solaris_sparc_x86.Z

2.To install iSANsurfer iSCSI HBA CLI on a Solaris SPARC/Solaris x86 operating system, type the following:

pkgadd -d iscli-AA.BB.CC-DD_solaris_sparc_x86

Solaris puts the files in the following directory:

/opt/QLogic_Corporation/SANsurferiCLI

It also adds this directory to the execution path.

2-10	SN0054621-00 E

2 – Installation and Removal

Installing SANsurfer iSCSI HBA CLI

Solaris Silent Installation

This section contains a pkgadd (SOLARIS) example for silent installation.

To install silently on Solaris:

1.Create the following two files:

response.txt noask_pkgadd.txt

2.Run the pkgadd command.

3.Create the response.txt file with contents of first question of arch, for example:

4.Create the noask_pkgadd.txt file with contents:

<BOF> action=nocheck <EOF>

5.Type the command to Install with the two additional (required) files:

pkgadd -d ./<Install Package Filename> -n -a

./noask_pkgadd.txt < ./response.txt

For example:

pkgadd -d ./iscli-1.1.00-11_solaris_sparc_x86 -n -a

./noask_pkgadd.txt < ./response.txt

Available packages include:

QLSisclisparc—QLogic SANsurfer iSCSI CLI (HBA Configuration Utility) (SPARC) 1.1.00 Build 11 (Solaris 8-11)

QLSisclix86—QLogic SANsurfer iSCSI CLI (HBA Configuration Utility) (x86) 1.1.00 Build 11 (Solaris 9-11)

6.Select the package(s) you want to process (or all to process all packages).

(default: all) [x,xx,q]:

SN0054621-00 E

2-11

2 – Installation and Removal

Removing SANsurfer iSCSI HBA CLI

To remove SANsurfer iSCSI HBA CLI from your system, follow the instructions that that correspond to your OS:

“Microsoft Windows Uninstall” on page 2-12

“Red Hat/SUSE Linux/PPC Uninstall” on page 2-13

“Solaris SPARC/Solaris x86 Uninstall” on page 2-13

Microsoft Windows Uninstall

The Windows OS offers the following methods of uninstalling SANsurfer iSCSI HBA CLI:

“Start Menu Uninstall” on page 2-12

“Control Panel Uninstall” on page 2-12

“Command Line Uninstall” on page 2-12

Start Menu Uninstall

On the Windows Start menu, point to All Programs > QLogic Management Suite > SANsurferiCLI, and then click Uninstall SANsurferiCLI.

Control Panel Uninstall

Follow these steps to uninstall SANsurfer iSCSI HBA CLI using the Windows Control Panel.

To uninstall from the Control Panel:

1.On the Start menu, click Control Panel.

2.Click Add/Remove Programs.

3.Select SANsurferiCLI.

4.Click Change/Remove.

Command Line Uninstall

You can uninstall SANsurfer iSCSI HBA CLI from the command line. Select interactive, passive, or silent uninstall.

To uninstall interactively from the command line:

Enter the following from a command prompt:

SANsurferiCLI.msi

To uninstall passively from the command line:

Enter the following from a command prompt:

msiexec /x SANsurferiCLI.msi

2-12	SN0054621-00 E

2 – Installation and Removal

Removing SANsurfer iSCSI HBA CLI

To uninstall quietly from the command line:

Enter the following from a command prompt:

msiexec /q /x SANsurferiCLI.msi

Red Hat/SUSE Linux/PPC Uninstall

To uninstall SANsurfer iSCSI HBA CLI on a Red Hat/SUSE Linux/PPC operating system, enter the following from a command prompt:

rpm -e iscli-AA.BB.CC-DD (be sure to omit the rest of the package name)

Solaris SPARC/Solaris x86 Uninstall

To uninstall SANsurfer iSCSI HBA CLI on a Solaris SPARC/Solaris x86 operating system, enter one of the following commands:

pkgrm QLisclix86 (Solaris x86) pkgrm QLisclisparc (Solaris SPARC)

SN0054621-00 E

2-13

2 – Installation and Removal

Removing SANsurfer iSCSI HBA CLI

Notes

2-14	SN0054621-00 E

3 Getting Started

Introduction

SANsurfer iSCSI HBA CLI operates in the two following modes:

Interactive mode. SANsurfer iSCSI HBA CLI starts and prompts for user input. Based on the input, the CLI executes the specified commands until terminated by the user. Use this mode to perform multiple operations.

4 Interactive Mode Commands covers this interface.

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

In both modes, SANsurfer iSCSI HBA CLI is case sensitive. In addition, file names in some operating systems are case sensitive; in this case, SANsurfer iSCSI HBA CLI is case sensitive for that particular file.

Starting Interactive Mode

To start SANsurfer iSCSI HBA CLI in interactive mode, choose one of the following options:

Type the following in a command window: iscli

For Windows, click the iSCLI icon (shown in Figure 3-1):

Figure 3-1 Windows iSCSI icon

SN0054621-00 E

3-1

3 – Getting Started

Starting Non-interactive Mode

The Windows system displays the Main Menu. For example:

main Interactive Menu

-------------------------------------------------------

Program Version: 1.2.00.xx Driver Version: 2.1.x.x (STOR w32) IC: 1

Current HBA/Port Information:	HBA Alias: qlogic
HBA: 0 Port: 0 HBA Port Index:	1 Model: QLA4050C
IP Address: 192.168.104.129	Link: Up

Port iSCSI Name: iqn.2000-04.com.qlogic:qla4050C.fs10506a02810.1 Port iSCSI Alias:

-------------------------------------------------------

1.Display Program Version Information

2.Host Level Info & Operations

3.HBA Level Info & Operations

4.Port Level Info & Operations

5.List All QLogic iSCSI HBA Ports detected

6.Help

7.Select HBA Port

8.Refresh

9.Exit

enter selection:

Depending on the menu selection, SANsurfer iSCSI HBA CLI prompts for more input as needed. For example, if you select Select HBA Port, SANsurfer iSCSI HBA CLI lists the current HBAs and prompts you to select an HBA whose settings you want to view or change.

Starting Non-interactive Mode

Type the following in a command window to start SANsurfer iSCSI HBA CLI in non-interactive mode:

iscli <Parameters>

SANsurfer iSCSI HBA CLI executes the command options, and then terminates. To list all of the available command line parameters, type the following:

iscli -h

All command line options must be preceded by the dash (–) notation. Most options have a corresponding menu selection in interactive mode.

3-2	SN0054621-00 E

4 Interactive Mode

Commands

This chapter provides an explanation of each menu and menu option in the SANsurfer iSCSI interactive command line interface (CLI).

The command line interface commands are nested and some selections from the main menu open new menus. For example, if you click item 2. Host Level Info & Operations on the main menu, SANsurfer iSCSI HBA CLI displays a new menu, the Host Level Info & Operations Menu. From this menu you have several choices, including 1. Display General System Information, 2. Import HBA Menu, Multiple Adapters, and so forth.

On every menu, to move to the next higher level (parent) menu, type the number for Exit.

Table 4-1 shows a map of the iSCSI CLI that will help you understand and navigate the menu hierarchy. The numbers in the left column (Level 1) represent the items on the main interactive menu.

SN0054621-00 E

4-1

4 – Interactive Mode Commands

Table 4-1. Command Line Interface Menu

Level 1	Level 2	Level 3	Level 4

(Shown in	(Shown in	(Shown in	(Shown in
Bold Black)	Black)	Brown)	Green)

1.Display Program Version Information (see page 4-8)

2.Host Level Info & Operations (see page 4-8)

1.DIsplay General System Information (see page 4-9)

2.Import HBA Menu, Multiple Adapters (see page 4-9)

1.Save Host Configuration (see page 4-9)

2.Import HBA Configuration (see page 4-10)

3.Select HBA Port (see page 4-49)

4.Refresh (see page 4-49)

5.Exit (see page 4-50)

3.Update Firmware, Multiple Adapters (see page 4-11)

4.Install HBA Driver, All Adapters (see page 4-11)

5.Select HBA Port (see page 4-11)

6.Refresh (see page 4-49)

7.Exit (see page 4-50)

3.HBA Level Info & Operations (see page 4-12)

1.HBA Information (see page 4-12)

2.HBA Options Menu (see page 4-13)

1.Update BIOS/UEFI [or FCode] Code Image (see page 4-13)

2.Update Firmware Image (see page 4-13)

3.Update ROM Image (see page 4-14)

4.Select HBA Port (see page 4-49)

5.Refresh (see page 4-49)

6.Exit (see page 4-50)

3.HBA Reset (see page 4-14)

4-2	SN0054621-00 E

4 – Interactive Mode Commands

Table 4-1. Command Line Interface Menu (Continued)

Level 1	Level 2		Level 3		Level 4

	4.	HBA Diagnostic Menu (see page 4-15)

			1.	Retrieve FW Crash Record (see page 4-15)
			2.	Retrieve FW Flash & NVRAM Record (see page 4-15)
			3.	Retrieve FW Coredump Record (see page 4-16)
			4.	Display HBA Level Statistics (see page 4-16)
			5.	Select HBA Port (see page 4-49)
			6.	Refresh (see page 4-49)
			7.	Exit (see page 4-50)

	5.	HBA Level Parameters Menu (see page 4-17)

			1.	Display HBA Level Parameters (see page 4-17)
			2.	Configure HBA Level Parameters (see page 4-18)
			3.	Select HBA Port (see page 4-49)
			4.	Save Changes and Reset HBA (see page 4-18)
			5.	Refresh (see page 4-49)
			6.	Exit (see page 4-50)

	6.	Display VPD Information (see page 4-18)
	7.	Select HBA Port (see page 4-11)
	8.	Refresh (see page 4-49)
	9.	Exit (see page 4-50)

4. Port Level Info & Operations (see page 4-19)

	1.	Port Link Settings Menu (see page 4-19)

			1.	Display Active Link Configuration (see page 4-19)
			2.	Display Configured Link Configuration (see page 4-20)
			3.	Configure Link Configuration (see page 4-20)
			4.	Save Changes and Reset HBA (if necessary) (see page 4-18)
			5.	Select HBA Port (see page 4-49)
			6.	Refresh (see page 4-49)
			7.	Exit (see page 4-50)

SN0054621-00 E

4-3

4 – Interactive Mode Commands

Table 4-1. Command Line Interface Menu (Continued)

Level 1	Level 2	Level 3	Level 4

2.Port Network Settings Menu (see page 4-20)

1.Display Network Settings (see page 4-20)

2.Configure IP Settings (see page 4-21)

3.iSNS Settings (see page 4-21)

4.Select HBA Port (see page 4-49)

5.Save Changes and Reset HBA (see page 4-18)

6.Refresh (see page 4-49)

7.Exit (see page 4-50)

3.Edit Configured Port Settings Menu (see page 4-22)

1.Display Configured Port Settings (see page 4-22)

2.Change Port iSCSI Alias Name (see page 4-22)

3.Port Firmware Settings Menu (see page 4-23)

1.Display Configured Port Settings (see page 4-23)

2.Edit a Specific Port Setting (see page 4-24)

3.Configure iSCSI Settings (see page 4-24)

4.Configure Firmware Settings (see page 4-25)

5.Configure Device Settings (see page 4-25)

6.Configure Basic Settings (see page 4-26)

7.Configure Advanced Settings (see page 4-26)

8.Configure IPv6 Settings (see page 4-27)

9.Configure IPv6 TCP Settings (see page 4-28) 10. Save Changes and Reset HBA (see page 4-18) 11. Select HBA Port (see page 4-49)

12. Refresh (see page 4-49)

13. Exit (see page 4-50)

4.Legacy QLA4010 Restore Default Port Settings (see page 4-28)

5.Select HBA Port (see page 4-49)

6.Save Changes and Reset HBA (if necessary) (see page 4-18)

7.Refresh (see page 4-49)

8.Exit (see page 4-50)

4.Port Restore Factory Defaults (see page 4-28)

4-4	SN0054621-00 E

4 – Interactive Mode Commands

Table 4-1. Command Line Interface Menu (Continued)


Level 1	Level 2	Level 3		Level 4

	5. Port Diagnostic Menu (see page 4-29)

		1.	Ping Target (see page 4-30)
		2.	Perform Loopback Test (see page 4-31)
		3.	Perform Read/Write Buffer Test (see page 4-31)
		4.	Display Port Statistics (see page 4-32)
		5.	Reset Statistics (see page 4-32)
		6.	Display ARP Table (see page 4-32)
		7.	Display Connection Error Log (see page 4-32)
		8.	Export Connection Error Log (see page 4-33)
		9.	Display Neighbor Cache (IPv6) (see page 4-33)
		10.	Display Destination Cache (IPv6) (see page 4-33)
		11. Display Default Router List (IPv6) (see page 4-33)
		12.	Display Local Prefix List (IPv6) (see page 4-33)
		13.	Select HBA Port (see page 4-49)
		14.	Refresh (see page 4-49)
		15.	Exit (see page 4-50)

	6. BIOS/UEFI [or FCode] Settings Menu (see page 4-34)

		1.	Display BIOS/UEFI [or FCode] Information (see page 4-35)
		2.	Set BIOS/UEFI Mode (see page 4-35)
		3.	Set Primary Boot Target Information (see page 4-35)
		4.	Set Secondary Boot Target Information (see page 4-35)
		5.	Clear Primary Boot Target Information (see page 4-36)
		6.	Clear Secondary Boot Target Information (see page 4-36)
		7.	Set Alternative Client ID (see page 4-36)
		8.	Save Changes and Reset HBA (see page 4-18)
		9.	Select HBA Port (see page 4-49)
		10.	Refresh (see page 4-49)

11. Exit (see page 4-50)

SN0054621-00 E

4-5

4 – Interactive Mode Commands

Table 4-1. Command Line Interface Menu (Continued)

Level 1	Level 2	Level 3	Level 4

7.Target Level Info & Operations (see page 4-36)

1.List Targets (see page 4-37)

2.Display Target Information (see page 4-37)

3.Bind Target (see page 4-39)

4.Delete Target (see page 4-39)

5.Configure Target Parameters (see page 4-39)

6.Add a Target (see page 4-40)

7.Disable a Target (see page 4-40)

8.Enable a Target (see page 4-40)

9.Configure Target Authentication Menu (see page 4-40)

1.Display CHAP Table (see page 4-41)

2.Display Targets Using CHAP Entries (see page 4-41)

3.Assign a CHAP Entry to a Target (see page 4-42)

4.Add a CHAP Entry (see page 4-42)

5.Add a Default BIDI CHAP (see page 4-43)

6.Edit a CHAP Entry (see page 4-43)

7.Delete a CHAP Entry (see page 4-44)

8.Select HBA Port (see page 4-49)

9.Save Target/CHAP Changes (see page 4-44)

10.Refresh (see page 4-49)

11.Exit (see page 4-50)

4-6	SN0054621-00 E

4 – Interactive Mode Commands

Table 4-1. Command Line Interface Menu (Continued)

Level 1	Level 2	Level 3	Level 4

10.Target Discovery Menu (see page 4-44)

1.Display Send Targets (see page 4-45)

2.Display Discovered Targets (see page 4-45)

3.Add a Send Target (see page 4-45)

4.Mark Send Target for Re-discovery (see page 4-45)

5.Remove a Send Target (see page 4-46)

6.Login and persist a discovered target (see page 4-46)

7.Duplicate a Persistent Target (see page 4-46)

8.Duplicate a Discovered Target (see page 4-46)

9.Remove Discovered Target (see page 4-46)

10.Display iSNS Settings (see page 4-46)

11.Configure iSNS (see page 4-46)

12.Save changes and reset HBA (see page 4-18)

13.Select HBA Port (see page 4-50)

14.Refresh (see page 4-50)

15.Exit (see page 4-50)

11.List LUN Information (see page 4-47)

12.Save Target/CHAP Changes (see page 4-47)

13.Select HBA Port (see page 4-49)

14.Refresh (see page 4-49)

15.Exit (see page 4-50)

8.Select HBA Port (see page 4-49)

9.Refresh (see page 4-49)

10.Exit (see page 4-50)

5.List All QLogic iSCSI HBA Ports Detected (see page 4-48)

6.Help (see page 4-49)

7.Select HBA Port (see page 4-49)

8.Refresh (see page 4-49)

9.Exit (see page 4-50)

SN0054621-00 E

4-7

4 – Interactive Mode Commands

Display Program Version Information (CLI Option -ver)

Display Program Version Information

(CLI Option -ver)

When you select this option, SANsurfer iSCSI HBA CLI displays the following

information:

SANsurfer iSCSI HBA CLI Program version : x.x.xx.xx

iSDMAPI (iSCSI SAN device manager API) xx.xx.xx.xx QLSDM.DLL 06 IOCTL

Host Level Info & Operations Menu

Before making a selection from the Host Level Info & Operations Menu, you must select an HBA.

To choose an HBA:

1.Type the number for the Select HBA Port option, and then press ENTER.

2.A list of HBA port instances appears.

3.Type the number for the HBA port instance you want to change, and then press ENTER.

4.Make changes in the following submenus:

1. Display General System Information (see page 4-9) 2. Import HBA Menu, Multiple Adapters (see page 4-9)

3.Update Firmware, Multiple Adapters (see page 4-11)

4.Install HBA Driver, All Adapters (see page 4-11)

5.Select HBA Port (see page 4-49)

6.Refresh (see page 4-49)

7.Exit (see page 4-50)

5.For each submenu, save the changes by typing the number for Save changes and reset HBA, and then pressing ENTER. This saves your changes and resets all ports on the HBA.

6.To update the firmware with these changes, type the number for Refresh, and then press ENTER. If you do not select this option, your changes will not be visible in SANsurfer iSCSI HBA CLI.

4-8	SN0054621-00 E

4 – Interactive Mode Commands Host Level Info & Operations Menu

Display General System Information

(CLI Option -g)

Choose the Display General System Information option to show information about SANsurfer iSCSI HBA CLI; for example:

Host Name		: (name)
Host Version: Service Pack n (Build			xxxx)
Host	Type	: Microsoft Windows Server 2003		Enterprise Edition x64
User	Type	: Privileged; HBA setup	allowed

Import HBA Menu, Multiple Adapters

(CLI Options -import and -save)

From the Import HBA Menu, choose one of the following options:

1.Save Host Configuration (to an XML file) (see page 4-9)

2.Import HBA Configuration (see page 4-10)

3.Select HBA Port (see page 4-49)

4.Refresh (see page 4-49)

5.Exit (see page 4-50)

Before making a selection from the Import HBA Menu, specify the HBA port whose settings you want to view or change by typing the number for Select HBA Port, and then press ENTER. A list of all iSCSI HBA ports is displayed. Type the number for the HBA port whose settings you want to change, and then press

ENTER.

Make changes in the submenus, as described in the following sections.

Save Host Configuration

(CLI Option -save)

To save the current host configuration to an XML file:

1.From the HBA Import Menu, type the number for the Save option, and then press ENTER.

SANsurfer iSCSI HBA CLI prompts you to enter a file name to save the host.

2.Type a file name or a path to a file. If you do not specify a path, the file is saved in the current directory:

Program Files\QLogic Corporation\SANsurfer

SN0054621-00 E

4-9

4 – Interactive Mode Commands

Host Level Info & Operations Menu

Import HBA Configuration

(CLI Option -import)

To import a single HBA configuration:

1.From the HBA Import Menu, type the number for the Import option, and then press ENTER.

SANsurfer iSCSI HBA CLI prompts you to enter a file name containing the HBA configuration.

2.Type the path and file name of the saved HBA configuration you want to import, and then press ENTER.

SANsurfer iSCSI HBA CLI reads the file, shows the HBAs whose configurations are in the file, and prompts you to select one to import.

3.Type the number of the HBA whose configuration you want to import, and then press ENTER.

The following appears:

You will now specify the target HBA to import the configuration to.

Please select a method for identifying the destination port(s):

1)Import to ALL ports.

2)Import to a list of ports (comma delimited).

3)Import to the currently selected port.

Please select an option:

4.Select a configuration import option, and then press ENTER.

You are now ready to choose which parameter sets to import. Please respond yes (y) or no (n) to each parameter set.

5.Select from the following parameter sets to import:

HBA Level Settings Network Settings iSCSI Name Firmware Settings CHAP Table

Target Settings (required if you Boot Settings is needed) Boot Settings

4-10	SN0054621-00 E

4 – Interactive Mode Commands Host Level Info & Operations Menu

NOTE:

Because the default is n (no), if you press ENTER after the prompt without typing y or n, you have essentially declined to import that setting.

After you have selected the parameter sets to import, the following message is displayed:

Resetting HBA This may take a few minutes.

After the HBA is reset, the HBA Import Menu reappears.

Update Firmware, Multiple Adapters

When you select the Update Firmware, Multiple Adapters option, SANsurfer iSCSI HBA CLI prompts you to enter the file name of the new firmware. Be sure to use full path names when specifying the new firmware file.

When finished typing the firmware file name and path, press ENTER.

Install HBA Driver, All Adapters

(CLI Option -d)

When you select the Install HBA Driver, All Adapters option, SANsurfer iSCSI HBA CLI shows the current driver version and prompts you to enter the name of a new driver. Be sure to use full path names when entering a new driver name.

Current driver version n.n.n.n for HBA Port: 0

Enter a driver file name or press <Enter> to return to Main Menu Driver file:

When finished typing the driver name and path, press ENTER.

Select HBA Port

For information regarding this option, see “Select HBA Port (No CLI Option)” on page 4-49.

SN0054621-00 E

4-11

4 – Interactive Mode Commands

HBA Level Info & Operations Menu (CLI Option -i)

HBA Level Info & Operations Menu

(CLI Option -i)

The HBA Level Info & Operations Menu provides the following options for each HBA port instance:

1.HBA Information (see page 4-12)

2.HBA Options Menu (see page 4-13)

3.HBA Reset (see page 4-14)

4.HBA Diagnostic Menu (see page 4-15)

5.HBA Level Parameters Menu (see page 4-17)

6.Display VPD Information (see page 4-18)

7.Select HBA Port (see page 4-49)

8.Refresh (see page 4-49)

9.Exit (see page 4-50)

On each submenu, save the changes by typing the number for Save changes and reset HBA, and then pressing ENTER. This saves your changes and resets all ports on the HBA.

To update the firmware with these changes, type the number for Refresh, and then press ENTER. If you do not select this option, your changes will not be visible in SANsurfer iSCSI HBA CLI.

HBA Information

(CLI Option -ch)

When you select the HBA Information option, information is listed for the working

adapter; for example:

Board Type	: QLE4060C
Chip Model	: ISP4032
Chip Version	: 0
Serial Number	: QS40620A00034
MAC Address	: 00-C0-DD-08-97-40
Driver Version	: 2.1.4.18 (STOR w32)
Firmware Version	: 3.0.1.45
ROM Version	: 1.0.0.0
iSCSI Version	: 0.20
BIOS/UEFI Version	: 1.00
BIOS/UEFI Full Version	: 1.00

4-12	SN0054621-00 E

4 – Interactive Mode Commands HBA Level Info & Operations Menu (CLI Option -i)

HBA Options Menu

(No CLI Option)

The HBA Options Menu provides the following selections:

1. Update BIOS/UEFI [or FCode] Code Image (see page 4-13)

2.Update Firmware Image (see page 4-13)

3.Update ROM Image (see page 4-14)

4.Select HBA Port (see page 4-49)

5.Refresh (see page 4-49)

6.Exit (see page 4-50)

On each submenu, save the changes by typing the number for Save changes and reset HBA, and then pressing ENTER. This saves your changes and resets all ports on the HBA.

To update the firmware with these changes, type the number for Refresh, and then press ENTER. If you do not select this option, your changes will not be visible in SANsurfer iSCSI HBA CLI

Update BIOS/UEFI [or FCode] Code Image

(CLI Option -bootcode)

This menu option varies, depending on your system architecture (automatically detected by SANsurfer iSCSI HBA CLI). Bootcode (that is, the bootable code image) is either BIOS, FCode, or EFI that allows system boot from an iSCSI drive.

Select the Update BIOS/UEFI Image or Update FCode Code Image option to update the bootcode code image, which should be done when QLogic releases a new bootcode with bug fixes or enhancements. At the prompt, type the name of the file containing the bootcode code image to upload to the HBA.

For information on bootcode file names, see Appendix E Downloadable File Names.

Update Firmware Image

(CLI Option -f)

The firmware is the code running on the HBA to perform the tasks involved in data management, the iSCSI protocol, and general HBA functioning.

Select the Update Firmware Image option to update the firmware image. At the prompt, type the name of the file containing the firmware image to upload to the HBA.

For information on firmware file names, see Appendix E Downloadable File Names.

SN0054621-00 E

4-13

4 – Interactive Mode Commands

HBA Level Info & Operations Menu (CLI Option -i)

CAUTION!

Before updating the firmware image, be sure that no I/O processes are running.

An administrator must take necessary actions to ensure changes will be fully recognized by the operating system (reboot, flush cache, sync disk, and so forth.)

A firmware update and reset will be performed that requires all applications accessing impacted LUNs to be shut down.

Any impacted systems must be unmounted.

Following firmware update, be sure to select Save changes and reset HBA; otherwise, the change will not take effect.

Update ROM Image

(CLI Option -r)

Select the Update ROM Image option to update the ROM image. At the prompt, type the name of the file containing the ROM image to upload to the HBA.

For information on ROM Image file names, see Appendix E Downloadable File Names.

CAUTION!

Before attempting to update the ROM image, contact QLogic Customer Support (support@qlogic.com).

Before updating the ROM image, ensure that no I/O processes are running.

An administrator must take necessary actions to ensure changes will be fully recognized by the operating system (reboot, flush cache, sync disk, and so forth).

A ROM update and reset will be performed that requires all applications accessing impacted LUNs to be shut down.

Any impacted systems must be unmounted.

To ensure your changes take effect, be sure to select Save changes and reset HBA.

HBA Reset

(CLI Option -b)

Select the HBA Reset option to reset the HBA after making configuration

changes.

4-14	SN0054621-00 E

4 – Interactive Mode Commands HBA Level Info & Operations Menu (CLI Option -i)

NOTE:

Issuing this command resets both ports (0 and 1) on the HBA.

You must disable bootcode mode (see “-bootcodemode (Set BIOS/UEFI [or FCode] Mode)” on page 5-4) to reset the HBA.

HBA Diagnostic Menu

(No CLI Option)

The HBA Diagnostic Menu provides the following options:

1. Retrieve FW Crash Record (see page 4-15)

2. Retrieve FW Flash & NVRAM Record (see page 4-15)

3.Retrieve FW Coredump Record (see page 4-16)

4.Display HBA Level Statistics (see page 4-16)

5.Select HBA Port (see page 4-49)

6.Refresh (see page 4-49)

7.Exit (see page 4-50)

Before making a selection from the HBA Diagnostic Menu, specify the HBA port you want to view or change by typing the number for Select HBA Port, and then pressing ENTER. A list of all iSCSI HBA ports is shown. Type the number for the HBA port whose settings you want to change, and then press ENTER.

Make changes in the submenus, as described in the following sections.

After making changes, refresh the HBA to show these changes by typing the number for (Refresh), and then pressing ENTER. If you do not select this option, your changes will not be visible in SANsurfer iSCSI HBA CLI.

Retrieve FW Crash Record

(CLI Option -gcr)

Select the Retrieve FW Crash Record option to get crash record information for the HBA. At the prompt, type a name and location for the crash file, and then press ENTER. Be sure to use full path names. For example:

Crash File Name: c:\QLogic_Corporation\iscli\crash_record

Retrieve FW Flash & NVRAM Record

(CLI Option -dumpnvram)

When you select the Retrieve FW Flash & NVRAM Record option, SANsurfer iSCSI HBA CLI queries you for the name of a file in which to dump the Flash and NVRAM contents. Be sure to use full path names. For example:

What is the filename you would like to save this Host NVRAM to: c:\QLogic_Corporation\iscli\NVRAM_dump

SN0054621-00 E

4-15

4 – Interactive Mode Commands

HBA Level Info & Operations Menu (CLI Option -i)

Retrieve FW Coredump Record

(CLI Option -dumpcore)

When you select the Retrieve FW Coredump Record option, SANsurfer iSCSI HBA CLI queries you for the name of a file in which to dump the Flash and core contents. Be sure to use full path names. For example:

What is the filename you would like to save this Host CoreDump to: c:\QLogic_Corporation\iscli\NVRAM_dump

Display HBA Level Statistics

(CLI Option -stathba)

When you select the Display HBA Level Statistics option, SANsurfer iSCSI HBA CLI lists statistics for the selected HBA. For example:

MACTxFramesCount	: 118
MACTxBytesCount	: 26705
MACTxMulticast	: 4
MACTxBroadcast	: 11
MACTxPauseFrames	: 0
MACTxControlFrames	: 0
MACTxDeferrals	: 0
MACTxExcessDeferrals	: 0
MACTxLateCollisions	: 0
MACTxAborts	: 0
MACTxSingleCollisions	: 0
MACTxMultipleCollisions	: 0
MACTxCollisions	: 0
MACTxFramesDropped	: 0
MACTxJumboFrames	: 0
MACRxFramesCount	: 673
MACRxBytesCount	: 173161
MACRxUnknownControlFrames	: 0
MACRxPauseFrames	: 0
MACRxControlFrames	: 0
MACRxDribble	: 0
MACRxFrameLengthError	: 0
MACRxJabber	: 0
MACRxCarrierSenseError	: 0
MACRxFramesDiscarded	: 0
MACRxFramesDropped	: 0
MACCRCErrorCount	: 0
MACEncodingErrorCount	: 0

4-16	SN0054621-00 E

+ 134 hidden pages

		Table 1-1. Related Documents

	Part Number	Title
	or Name	Title
	or Name

	IS0054501-00	Quick Start Guide: iSCSI HBA Installation (PDF).
	Rev C

	readme.txt	SANsurfer notes included with SANsurfer iSCSI HBA CLI.
	Release notes	SANsurfer iSCSI HBA CLI Release Notes provide details about
		modifications made since the previous version. Separate release
		notes are provided for each operating system.

	IS0054602-00	SANsurfer iSCSI HBA Manager User’s Guide provides details for
	Rev. B	using the graphical user interface tool to manage QLogic iSCSI
		HBAs.

Q-Logic SN0054621-00 E User Manual

Table of Contents

1 Introduction

Intended Audience

How This Guide is Organized

Typographic Conventions

Related Documents

Supported QLogic HBAs

Supported Operating Systems

License Agreements

Technical Support

Availability

Training

Contact Information

2 Installation and Removal

Installing SANsurfer iSCSI HBA CLI

Downloading the Installation Package

Installing on Microsoft Windows

Windows Standard (GUI) Installation

Windows Command Line Installation

Installing on Red Hat/SUSE Linux/PPC

Installing on Solaris SPARC/Solaris x86

Solaris Attended Installation

Solaris Silent Installation

Removing SANsurfer iSCSI HBA CLI

Microsoft Windows Uninstall

Start Menu Uninstall

Control Panel Uninstall

Command Line Uninstall

Red Hat/SUSE Linux/PPC Uninstall

Solaris SPARC/Solaris x86 Uninstall

3 Getting Started

Introduction

Starting Interactive Mode

Starting Non-interactive Mode

Display Program Version Information (CLI Option -ver)

Host Level Info & Operations Menu

Update Firmware, Multiple Adapters

Select HBA Port

HBA Level Info & Operations Menu (CLI Option -i)