SANsurfer FC HBA CLI User s Guide

Transcription

1 ANsurfer FC HBA CLI User s Guide Command Line Interface for QLogic FC and FCoE Adapters N H

2 ANsurfer FC 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 which may result from its use. QLogic Corporation reserves the right to change product specifications at any time without notice. Applications described in this document for any of these products are for illustrative purposes only. QLogic Corporation makes no representation nor warranty that such applications are suitable for the specified use without further testing or modification. QLogic Corporation assumes no responsibility for any errors that may appear in this document. Apple, Finder, Mac O, Macintosh, Power Mac, Panther, Tiger, and afari are registered trademarks of Apple, Inc. AMD is a registered trademark of Advanced Micro Devices, Inc. Cisco Nexus is a trademark of Cisco ystems, Inc. EMC is a registered trademark of EMC Corporation. Intel and Pentium are trademarks of Intel Corporation. Linux is a registered trademark of Linus Torvalds. Microsoft, Windows, Windows 2000 operating system, Windows erver 2003 and 2008 operating systems, Windows XP Professional operating system, and Windows Vista operating system are registered trademarks of Microsoft Corporation. Novell, NetWare, and UE are registered trademarks of Novell, Inc. IBM and PowerPC are registered trademarks of International Business Machines Corporation. QLogic, the QLogic logo, QLA, and ANsurfer are registered trademarks of QLogic Corporation. Red Hat is a registered trademark of Red Hat, Inc. olaris is a registered trademark of un Microsystems, Inc. PARC is a registered trademark of PARC International, Inc. in the UA and other countries. tuffit is a registered trademark of mith Micro oftware, Inc. VMware is a registered trademark of VMware, Inc. All other brand and product names are trademarks or registered trademarks of their respective owners. Revision A, August 20, 2004 Revision B, eptember 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 Document Revision History QLogic Corporation. All Rights Reserved Worldwide. First Published: August 2004 QLogic Corporation, Aliso Viejo Parkway, Aliso Viejo, CA 92656, (800) or (949) Page ii PRELIMINARY N H

3 ANsurfer FC HBA CLI User s Guide Command Line Interface for QLogic FC and FCoE Adapters Changes ections Affected Revision H Changes: Removed note re Windows TORport driver version compatibility. FCoE Utility on page 4-64 Revision G Changes: Applied new QLogic book template. Modified guide s subtitle. Added note regarding messages displayed for unknown and unsupported HBAs. All Command Line Interface for QLogic FC and FCoE Adapters upported QLogic HBAs on page 1-4 Updated list of supported operating systems. upported Operating ystems on page 1-4 Corrected NPIV WWPN byte changes. Virtual Menu (Command Line Option -vp) on page 4-90 and -vp (Virtual Port) on page 5-43 Added QLE8052 to list of supported HBAs. upported QLogic HBAs on page 1-4 Added FCoE display and configuration information for QLE8042 HBA. Added introductions to the Utilities Menu, Beacon Menu, and Diagnostics Menu sections. Rearranged Utilities Menu: HBA Parameters Template section. HBA Information Menu (Command Line Option -i) on page 4-18 HBA Information (Command Line Option -i) on page 4-20 HBA Parameters Menu on page 4-23 HBA Parameters (Per FCoE Engine) on page 4-31 Utilities Menu on page 4-59, Beacon Menu on page 4-67, and Diagnostics Menu (Command Line Options -kl, -kr, and -dm) on page 4-69 HBA Parameters Template (Per HBA or All HBAs) (Command Line Option -n and OEM Name) on page 4-61 Added new FCoE Utility menu information. FCoE Utility on page 4-64 Removed Update Boot Code Only and Update FW Only options from Flash Update. Added FCoE command line information to Help menu. Added XML outputs for FCoE commands. Flash Update (Per HBA Port or All HBAs) (Command Line Option -b) on page 4-60 and Table E-1 (Command Line Option -b) Help Menu (Command Line Option -h) on page 4-93 Appendix A: XML Format 1, Appendix B: XML Format 2 N H Page iii

4 ANsurfer FC HBA CLI User s Guide Command Line Interface for QLogic FC and FCoE Adapters Modified error codes and added new error codes (for FCoE) to exit/error codes appendices. Added FCoe help commands to appendix. Added glossary entries. Appendix C: Interactive Exit Codes, Appendix D: Non-interactive Error Codes Appendix E: Help Commands Glossary Revision F Changes: Changed NVRAM to HBA Parameters. Changed Option ROM to Flash. Changed HBA No. to HBA Instance. Changed FF DMI to HBA transceiver details. All All All All Updated supported QLogic HBA list. upported QLogic HBAs on page 1-4 Updated supported operating system list. upported Operating ystems on page 1-4 All non-interactive information moved from ection 4 to ection 5. ection 4, ection 5 Command line options put in alphabetical order. Table 2-1, ection 4 Added Appendix B: XML Format 2. Added port virtualization (NPIV) information. Appendix B Virtual Menu (Command Line Option -vp) on page 4-90, -vp (Virtual Port) on page 5-43 Added support for Red Hat Linux REL 5.1. Linux Installation on page 3-9 Removed installation/uninstallation instructions for olaris PARC 6 and 7. olaris Installation on page 3-9 Added O LUN Name (olaris and Linux). Target/LUN List Menu (Command Line Options -t and -l) on page 4-34 Added guide overview section, including a description of what s in the guide and documentation conventions used. Added interactive mode exit codes listing. Moved tables other than help commands from Help Commands appendix to appropriate interactive commands sections. Expanded iidma settings information. How this Guide is Organized on page 1-2 Appendix C ection 4 Target Link peed or iidma ettings Menu (Command Line Option -q) on page 4-42 Page iv PRELIMINARY N H

5 ANsurfer FC HBA CLI User s Guide Command Line Interface for QLogic FC and FCoE Adapters Added Virtual Menu information. Virtual Menu (Command Line Option -vp) on page 4-90 Expanded HBA parameter templates information. Expanded diagnostic testing information. HBA Parameters Template (Per HBA or All HBAs) (Command Line Option -n and OEM Name) on page 4-61 Diagnostics Menu (Command Line Options -kl, -kr, and -dm) on page 4-69 N H Page v

6 ANsurfer FC HBA CLI User s Guide Command Line Interface for QLogic FC and FCoE Adapters Page vi PRELIMINARY N H

7 Table of Contents 1 Introduction Intended Audience How this Guide is Organized Typographic Conventions Related Materials upported QLogic HBAs upported Operating ystems ystem Requirements Hardware Requirements oftware Requirements Unsupported Features License Agreements Technical upport Availability Training Contact Information Getting tarted tarting Interactive Mode tarting Non-interactive Mode Terminology Installing and Uninstalling ANsurfer FC HBA CLI Downloading the Installation Package Installing ANsurfer FC HBA CLI Windows Installation tandard (GUI) Installation Command Line Installation Linux Installation olaris Installation olaris PARC 8, 9, 10 Installation olaris x86 9 and 10 Installation N H Page vii

8 ANsurfer FC HBA CLI User s Guide Command Line Interface for QLogic FC and FCoE Adapters Macintosh Installation tandard (GUI) Installation Command Line Installation Uninstalling ANsurfer FC HBA CLI Windows Uninstall tandard (GUI) Uninstall Command Line Uninstall Linux Uninstall olaris Uninstall olaris PARC 8, 9, and 10 Uninstall olaris x86 8, 9, and 10 Uninstall Macintosh Uninstall Interactive Commands General Information Menu (Command Line Option -g) Host Information (Command Line Option -g) Host Topology (Command Line Option -tp -topology) Display (Host Topology) (Command Line Option -tp -topology) ave As Txt File (Command Line Option -b) ave As XML File Generate Report (Command Line Option -z) Generate Report (Per HBA Port) Generate Report (All HBAs) (Command Line Option -z) Refresh HBA Information Menu (Command Line Option -i) HBA General Information (per HBA Port) HBA Information (Command Line Option -i) HBA Alias (Command Line Option -ha) HBA Port Alias (Command Line Option -pa) HBA VPD Information (Command Line Option -l and Reserved Word vpd ) HBA Information (All HBAs) Information HBA Parameters Menu HBA Parameters (Per HBA Port) Display HBA Parameters (Command Line Option -c#) Configure HBA Parameters (Command Line Option -n) Restore Defaults Page viii N H

9 A ANsurfer FC HBA CLI User s Guide Command Line Interface for QLogic FC and FCoE Adapters HBA Parameters (Per FCoE Engine) Display FCoE Parameters Configure FCoE Parameters HBA Parameters (All HBAs) Target/LUN List Menu (Command Line Options -t and -l) Target/LUN List (Per HBA Port) Per Target/LUN Per Target/All LUNs All Targets Target/LUN List (All HBAs) Individual Target Individual LUN All Targets All Target(s) All LUN(s) Target Link peed or iidma ettings Menu (Command Line Option -q) Configuring the iidma ettings HBA Port Instance HBA Port Advanced Configuration Target Link peed: All HBAs Target Link peed: All HBAs, Basic Configuration Target Link peed: All HBAs, Advanced Configuration iidma ettings: Disk iidma: All HBAs Target Persistent Bindings Menu (Command Line Option -p) Target Persistent Bindings (Per HBA Port) (Command Line Option -p) Display Target Persistent Binding (Command Line Option -p) Target Persistent Bindings: Bind Target(s) (Command Line Option -p) Target Persistent Binding: Unbind Targets (Command Line Option -p) Target Persistent Binding (All HBAs) Display Target Persistent Binding Target Persistent Binding: Bind Targets Target Persistent Binding: Unbind Targets elective LUNs Menu (Command Line Option -m) elective LUNs (Per HBA Port) N H Page ix

10 ANsurfer FC HBA CLI User s Guide Command Line Interface for QLogic FC and FCoE Adapters elective LUNs (All HBAs) Display LUN Configuration Manual Configure LUNs Auto Configure LUNs Boot Device Menu (Command Line Option -e) HBA Port Instance Boot Device(s) (Per HBA Port) Configure Boot Device(s) Boot Device(s) (All HBAs) Driver ettings Menu (Command Line Option -fg) Utilities Menu Flash Update (Per HBA Port or All HBAs) (Command Line Option -b) Flash ave (Per HBA Port) (Command Line Option -b and Reserved Word save ) HBA Parameters Update (Per HBA Port or All HBAs) (Command Line Option -r) HBA Parameters ave (Per HBA Port) (Command Line Option -r and Reserved Word save ) HBA Parameters Template (Per HBA or All HBAs) (Command Line Option -n and OEM Name) Driver Update (Command Line Option -d) FCoE Utility Update Firmware tats Menu Logs Menu Driver Rescan (Command Line Option -rs) Beacon Menu Locate HBA: HBA Beacon (Command Line Option -a) Locate Target(s): Target Beacon (Command Line Option -tb) Beacon elected Target(s) Diagnostics Menu (Command Line Options -kl, -kr, and -dm) Diagnostics Loopback Test (Command Line Option -kl) Configure Loopback Test Parameters Run a Loopback Test Diagnostics Read/Write Buffer Test Configure Read/Write Test Parameters Run Read/Write Buffer Test Page x N H

11 A ANsurfer FC HBA CLI User s Guide Command Line Interface for QLogic FC and FCoE Adapters Diagnostics Transceiver Details: DMI (Command Line Option -dm) Transceiver Details: General Transceiver Details: Details tatistics Menu (Command Line Options -gs and -ls) HBA tatistics: Monitoring (Command Line Option -gs) Configuration how HBA tatistics Link tatus (Command Line Option -ls) Configuration how Link tatus Virtual Menu (Command Line Option -vp) Virtual Menu for HBA Instance List Virtual Port(s) Delete Virtual Port(s) Create Virtual Port(s) Help Menu (Command Line Option -h) Contents Exit Codes About Non-interactive Commands Display ystem Information (Command Line Options -g, -z, and -tp) Host Information (Command Line Option -g) Host Configuration (Command Line Option -z) Host Topology (Command Line Option -tp) Host Configuration Command ummary a (View or Toggle Beacon tatus) b (ave or Update the Flash BIO or Fcode) c (how Parameter ettings) d (Update Device Driver) dm (Display Diagnostics Monitoring Info) e (Boot Device View elect Disable) ei (List ANsurfer FC HBA CLI Error Codes) f (Input Parameter Options from a Text File) fcoe (Display and Configure FCoE Engine Parameters) fg (how Driver ettings) fs (Configure Driver ettings) g (Display ystem Information) N H Page xi

12 ANsurfer FC HBA CLI User s Guide Command Line Interface for QLogic FC and FCoE Adapters A XML Format 1 -gs (how HBA tatistics) h (Help) ha (et Delete HBA Alias) i (Display HBA General Information or VPD Information for One or All HBAs) kl (Loopback Test) DataPattern (DP) Dataize (D) TestCount (TC) TestIncrement (TI) OnError (OE) Run a Loopback Test kl (Run HBA Diagnostics Loopback Test) kr (Run Read/Write Buffer Test) Run a Read/Write Buffer Test Run HBA Diagnostics Read-write Buffer Test l (Display LUN Info) ls (Display Link tatus) m (View, Enable, or Disable LUNs) n (et elected HBA Parameter) o (Output to a File) p (Display Persistent Target Binding Info) pa (Define Port Alias) q (View or et Target Link peed) r (Update HBA Parameters) s (ilent Mode) t (Display Target Information) tb (Target Beacon On/Off) tp (Display Host Topology) v (Display Version) vp (Virtual Port) x (Output in XML Format 1) x2 (Output in XML Format 2) z (Display All HBA information for One or All HBAs) Output Parts A-1 Main Tag A-1 Utility Header A-1 tatus Message A-2 Page xii N H

13 A ANsurfer FC HBA CLI User s Guide Command Line Interface for QLogic FC and FCoE Adapters Reboot Message A-2 Error Message A-2 XML Format 1 Tags for Each Option A-2 Display ystem Information (Command Line Option -g) A-3 Display Adapter ettings (Command Line Option -c) A-4 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 elective 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 ettings (Command Line Option -fg) A-10 Display All Information for One or All HBAs (Command Line Option -z) A-11 Link tatistics (Command Line Option -ls) A-14 HBA tatistics (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 DCX A-25 Display FCoE Network Interface tatistics A-26 B XML Format 2 Output Parts B-1 Main Tag B-1 Utility Header B-2 tatus Message B-2 Reboot Message B-2 Error Message B-2 XML Format 2 Tags for Each Option B-2 Display ystem Information (Command Line Option -g) B-4 Display Adapter ettings (Command Line Option -c) B-4 Display HBA Information (Command Line Option -I) B-5 Display Device List (Command Line Option -t) B-7 N H Page xiii

14 ANsurfer FC HBA CLI User s Guide Command Line Interface for QLogic FC and FCoE Adapters Display LUN List (Command Line Option -l) B-8 Target Persistent Binding (Command Line Option -p) B-9 elective LUNs (Command Line Option -m) B-9 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 ettings (Command Line Option -fg) B-12 Display All Information for One or All HBAs (Command Line Option -z) B-13 Link tatistics (Command Line Option -ls) B-16 HBA tatistics (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-26 Display FCoE Parameters B-27 Display FCoE Link Events B-27 Display FCoE DCX B-29 Display FCoE Network Interface tatistics B-30 C D E Interactive Exit Codes Non-interactive Error Codes Help Commands Glossary Index Page xiv N H

15 A ANsurfer FC HBA CLI User s Guide Command Line Interface for QLogic FC and FCoE Adapters List of Figures Figure Page 3-1 electing HBA Model (Example) Preparing to Install Dialog Box Welcome Dialog Box Choose Destination Location Dialog Box Ready to Install the Program Dialog Box etup tatus Dialog Box Installhield Wizard Complete DIalog Box List of Tables Table Page 2-1 Non-interactive Mode Options Windows Command Line Installation Parameters HBA Parameters ettings (NVRAM) Target/LUN Information Target Link peed ettings Driver ettings Template upported Parameter ettings for QLA246x/QLE246x and QLE256x HBAs Template upported Parameter ettings for QLA23xx HBAs (IP2312) Template upported Parameter ettings for QLA23xx HBAs (IP2300/2310) Template upported Parameter ettings for QLA23xx HBAs (IP2322) HBA Diagnostics Configuration ettings HBA Port tatistics Options tatistics/link tatus Options Options hown by -z Command Variables FCoE Engine Parameters Driver ettings Parameters HBA tatistics Parameters Data Pattern Values OnError Values Driver Versions Not Requiring a Loopback Connector Diagnostics Parameters Data Pattern (DP) Test Patterns Link tatus Parameters HBA Parameters A-1 Options Displayed by -z A-11 B-1 Options Displayed by -z B-13 C-1 Exit Code Descriptions: Interactive Mode C-1 D-1 Error Code Descriptions: Non-interactive Mode D-1 E-1 Help Commands E-1 N H Page xv

16 ANsurfer FC HBA CLI User s Guide Command Line Interface for QLogic FC and FCoE Adapters Page xvi N H

17 1 Introduction The ANsurfer FC HBA CLI tool provides a command line interface (CLI) that lets you easily install, configure, and deploy QLogic Fibre Channel (FC) host bus adapters (HBAs), 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 AN performance. This tool only configures HBAs on the local machine (where ANsurfer FC HBA CLI is installed.) ANsurfer FC HBA CLI is a simplified, condensed version of the ANsurfer FC HBA Manager graphical user interface (GUI), which manages both local and remote hosts. ANsurfer FC HBA CLI can be operated in two modes: Interactive mode (menu-driven interface). This mode requires user intervention. Non-interactive mode (command line interface). Use this mode for scripting or when you want to do a single operation. NOTE: This guide uses interchangeably the terms HBA, CNA, and adapter. This introductory chapter covers the following: Intended Audience on page 1-1 How this Guide is Organized on page 1-2 upported QLogic HBAs on page 1-4 upported Operating ystems on page 1-4 ystem Requirements on page 1-5 License Agreements on page 1-8 Technical upport on page 1-8 Intended Audience This guide is intended for end users responsible for administration of QLogic FC HBAs. N H 1-1

18 1 Introduction How this Guide is Organized How this Guide is Organized The ANsurfer FC HBA CLI User s Guide is organized into the following chapters and appendices: 1 Introduction: This chapter provides a general overview of the product, lists the supported QLogic HBAs and operating systems, lists the system hardware and software requirements, and provides contact information for technical support. 2 Getting tarted: This chapter describes the two modes used in ANsurfer FC HBA CLI: interactive and non-interactive. It also explains some special terms used in this guide. 3 Installing and Uninstalling ANsurfer FC HBA CLI: This chapter provides step-by-step instructions for installing and uninstalling ANsurfer FC HBA CLI on Windows, Linux, olaris, and Macintosh. 4 Interactive Commands: This chapter provides detailed explanations and examples of the command line options used in interactive mode. 5 Non-interactive Commands: This chapter provides detailed explanations and examples of the command line options used in non-interactive mode. A XML Format 1: This appendix provides explanations and examples of XML files created with the -x1 command line option. B XML Format 2: This appendix provides explanations and examples of XML files created with the -x2 command line option. C Interactive Exit Codes: This appendix lists the exit codes that can occur while running ANsurfer FC HBA CLI in interactive mode. For each exit code number, it provides the name and description. D Non-interactive Error Codes: This appendix lists the error codes that can occur while running ANsurfer FC HBA CLI in interactive mode. For each error code number, it provides the name and description. E Help Commands: This appendix provides an alphabetical list of the command line actions, arguments, and functions of the help commands. Following the appendices are a glossary of terms used and an index that will help you quickly find the information you need. Typographic Conventions This guide uses the following typographic conventions: Text in bold font indicates a menu or menu item. For example: From the General Information Menu, type the number for Host Topology. 1-2 N H

19 A 1 Introduction How this Guide is Organized Text in a sans serif font (Courier New) indicates CLI window text output. For example: The HBA already has the device selected as boot device. Text in a bold sans serif font (Courier New) indicates user input (what you type). For example: # scli -z Text in ALL CAPITAL 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: Attached Port means a QLogic HBA... For a complete list, see the QLogic AN Interoperability Guide. Italicized text within angle brackets indicates user-defined variables. For example: # scli -k (<HBA Instance> <HBA WWPN>) Text shown in blue indicates a cross-reference hyperlink to a Web site or to another section of this guide. Click the hyperlink to jump to that site or section. For example: Visit the QLogic support Web site at support.qlogic.com for the latest firmware and product updates. For information on the Virtual Menu, see Virtual Menu for HBA Instance on page In 4 Interactive Commands, a breadcrumbs line follows most command headings to show you how to access that option; that is, it shows the hierarchical path from the top level to the command under discussion. For example, to reach the ave to Text File options from the main ANsurfer FC HBA CLI menu, you would select option 1 to open the General Information menu, 2 to open the Host Topology menu, and 2 again to see the ave to Text File options. The following shows a breadcrumbs example: 1: General Information 2: Host Topology 2: ave to Text File Related Materials For additional information, refer to the ANsurfer FC HBA CLI ReadMe file and release notes. N H 1-3

20 1 Introduction upported QLogic HBAs upported QLogic HBAs ANsurfer FC HBA CLI is supported for the following QLogic HBAs: QLA2xx QLA234x QLE2xx QLA246x QLE246x QLE256x QLE8042 Not all ANsurfer FC HBA CLI features are available on every supported HBA. NOTE: If ANsurfer FC HBA CLI detects an unsupported HBA, the following message appears, where X is the adapter instance number and YYYYYYY is the adapter model: upported Operating ystems ANsurfer FC HBA CLI is supported on the following operating systems: Microsoft Windows : Windows 2000, 32-bit, Intel x86 Intel 64, AMD64 Windows erver 2003, 32-bit Intel x86, Intel 64, AMD64 Windows erver 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 : Unsupported HBA (Instance X YYYYYYY) If ANsurfer FC HBA CLI detects an HBA 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 HBA: Unknown HBA type (Instance X VID=0xYYYY DID=0xZZZZ)! Red Hat RHEL A/E bit, 64-bit Intel IA64, Intel 64, AMD64 Red Hat RHEL A/E bit, 64-bit Intel IA64, Intel 64, AMD64 Red Hat RHEL A/E bit, 64-bit Intel IA64, Intel 64, AMD64 Red Hat RHEL A/E bit, 64-bit Intel x86, Intel 64, AMD N H

21 A 1 Introduction ystem Requirements Novell LE bit, 64-bit Intel IA64, Intel 64, AMD64 Novell LE 9 32-bit, 64-bit Intel IA64, Intel 64, AMD64 Novell LE 8 32-bit, 64-bit Intel x86, AMD64 NOTE: RHEL 3.0 and LE 8 do not support 8Gb HBAs. olaris : olaris 9, 10 x86 32-bit, 64-bit Intel x86, Intel 64, AMD64 olaris 2.6, 7, 8, 9, and 10 PARC 32-bit, 64-bit PARC Apple Macintosh : Mac O X (Panther/Tiger), 32-bit, 64-bit PowerPC/Intel NetWare : NetWare bit Intel x86, Intel 64, AMD64 VMware EX: EX bit, Intel 64, AMD64 NOTE: VMware does not support 8Gb HBAs at the time of publication of this guide. NOTE: Throughout this guide, the terms Windows, Linux, olaris, and Macintosh refer to all the respective supported operating systems unless otherwise noted. For specific service packs (Ps) and O updates, refer to the descriptions where this software version is posted on the QLogic Web site: ystem Requirements The system requirements for ANsurfer FC HBA CLI are described in the following sections: Hardware Requirements on page 1-6 oftware Requirements on page 1-6 N H 1-5

22 1 Introduction ystem Requirements Hardware Requirements The minimum hardware requirements are as follows: QLogic HBAs (see upported QLogic HBAs on page 1-4). ingle- or multiprocessor server or workstation: Pentium III with 450 MHz or greater for Windows 2000, Windows erver 2003, Windows XP Professional, Linux, and olaris. Windows Vista and Windows erver 2008 Use the minimum requirements from Microsoft. Power Mac G5 1.8 MHz or greater with 512 MB of memory. FC devices, such as disks and RAID subsystems. QLogic FC HBAs. ANsurfer FC HBA CLI supports most FC devices. For a complete list of devices that support failover, see the QLogic AN Interoperability Guide, which you can download from the QLogic Web site, NOTE: Tape devices are shown as part of the configuration, but are not fully supported by ANsurfer FC HBA CLI. Only persistent binding and LUN masking are available. 256 MB physical RAM are required to run ANsurfer FC HBA CLI; running with less memory can cause disk swapping ( paging or paging out ), which severely affects performance. Video card capable of 256 colors and a screen resolution of 800x600 pixels. About 7 MB of disk space. oftware Requirements Unsupported Features The minimum software requirements are as follows: QLogic drivers for your O platform. Administrative privileges to perform management functions. One of the operating systems listed in upported Operating ystems on page 1-4. Depending on your system, not all ANsurfer FC HBA features are available. 1-6 N H

23 A 1 Introduction ystem Requirements Features Not Available When Running Windows Driver with NPIV Enabled When running the driver with NPIV enabled on Windows, the following features are not available with virtual port: HBA parameters settings HBA parameters restore default Flash update from file Flash save to file HBA parameters update from file HBA parameters save to file HBA parameters update from templates Target link speed Boot device settings Driver settings HBA beacon Target/LUN list Features Not Available When Running ioctl Module Driver When running the input/output control (ioctl) module driver on a Linux O, the following features are not available: Persistent binding elective LUN HBA port statistics Driver settings Host topology Features Not Available When Running ysfs Inbox Driver When running the ysfs Inbox driver on a Linux O, the following features are not available: Persistent binding elective LUN HBA 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 O, the following features are not available with virtual ports: HBA parameters settings HBA parameters restore default Flash update from file N H 1-7

24 1 Introduction License Agreements Flash save to file HBA parameters update from file HBA parameters save to file HBA parameters update from templates License Agreements Refer to the QLogic oftware End User License Agreement for a complete listing of all license agreements affecting this product. Technical upport Availability Customers should contact their authorized maintenance provider for technical support of their QLogic switch products. QLogic-direct customers may contact QLogic Technical upport; 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. QLogic Technical upport 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 ANblade HBAs and the ANbox switches. From the training link at you may choose Electronic-Based Training or schedule an intensive hands-on Certification course. Technical Certification courses include installation, maintenance and troubleshooting QLogic AN 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 at tech.training@qlogic.com. 1-8 N H

25 A 1 Introduction Technical upport Contact Information Please feel free to contact your QLogic approved reseller or QLogic Technical upport at any phase of integration for assistance. QLogic Technical upport can be reached by the following methods: Web: North America Contact Information support@qlogic.com Phone: (952) upport contact information for other regions of the world is available at the QLogic Web site: The QLogic knowledge database contains troubleshooting information for the QLogic HBAs. Access the data base from the QLogic Web site, Click the upport tab, and then use the search engine at the top of the page to look for specific troubleshooting information. N H 1-9

26 1 Introduction Technical upport Notes 1-10 N H

27 2 Getting tarted This chapter provides the following sections to help you get started using ANsurfer FC HBA CLI: tarting Interactive Mode on page 2-1 tarting Non-interactive Mode on page 2-3 Terminology on page 2-7 ANsurfer FC HBA CLI Modes ANsurfer FC HBA CLI operates in two modes: Interactive (menu-driven). The 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 do multiple operations. 4 Interactive Commands covers this interface. Non-interactive (command line). The CLI starts, executes the functions defined by the list of parameters provided, and then terminates. Use this mode to run ANsurfer FC HBA CLI from a script file or when you want to do a single operation. 5 Non-interactive Commands covers this interface. ANsurfer FC HBA CLI is not case sensitive in either mode. However, file names in some operating systems are case sensitive; in this case, ANsurfer FC HBA CLI is case sensitive for that specific file. tarting Interactive Mode To start ANsurfer FC HBA CLI in interactive mode, use one of these methods: For Windows, click the ANsurfer FC CLI icon on the desktop. For Linux or olaris, open a command window and type one of the following: scli INT scli NOTE: When starting ANsurfer FC HBA CLI from a olaris console serial port connection, the CLI may take a long time to come up. To resolve this issue, specify the INT flag, as shown in the preceding bullet. N H 2-1

28 2 Getting tarted tarting Interactive Mode For Mac O X, follow these steps: 1. Double-click the ANsurfer FC HBA CLI (CLI) icon. 2. A terminal window opens. CLI (interactive mode) scans the host for QLogic HBAs and AN storage. 3. Run CLI commands as required. 4. When finished, return to the main menu, and type the indicated number to exit ANsurfer FC HBA CLI. 5. Close the terminal window. The Main Menu appears as shown in the following: ANsurfer FC HBA CLI v1.x.x Build xx Main Menu 1: General Information 2: HBA Information 3: HBA Parameters 4: Target/LUN List 5: Target Link peed or 5: iidma ettings 6: Target Persistent Bindings 7: elective LUNs 8: Boot Device 9: Driver ettings 10: Utilities 11: Beacon 12: Diagnostics 13: tatistics 14: Help or 14: Virtual (if available) 15: Exit or 15: Help or 16: Exit NOTE: The Virtual menu is available only on Windows systems running with a driver that supports NPIV (N_Port ID Virtualization). Depending on which menu you select, may prompt you for more input. For example, if you select HBA Parameters, ANsurfer FC HBA CLI prompts you for the port number that corresponds to the HBA model you want to view. 2-2 PRELIMINARY N H

29 A 2 Getting tarted tarting Non-interactive Mode NOTE: The Driver Update option under Utilities (option 10) is only available on Windows. In olaris PARC, the option to ave/update BIO is ave/update FCode. tarting Non-interactive Mode To start ANsurfer FC HBA CLI in non-interactive mode, type the following in a command window: scli <Parameters> ANsurfer FC HBA CLI executes the command options, then terminates. To list all of the available command line parameters and the ANsurfer FC HBA CLI version, type one of the following: scli -h scli -? In olaris PARC, include double quotes around the view option (?) if the system is running with a csh or tsch shell. For example: # scli -e 0 "?" For world wide node name (WWNN), world wide port name (WWPN), and port ID parameter inputs, ANsurfer FC HBA CLI accepts the notation with and without the dash ( ). Hexadecimal values can be uppercase or lowercase. The following input formats are valid for the WWNN and WWPN: E0-8B C E08B0183C4 The following inputs are valid for the port ID: 68-5C-AB 685CAB All command line options must be preceded by the dash ( ) or forward slash (/) notation. Most options have a corresponding menu selection in interactive mode. The valid command line options are listed in Table 2-1. N H 2-3

30 2 Getting tarted tarting Non-interactive Mode. Table 2-1. Non-interactive Mode Options CLI Option Interactive Menu (Windows) Interactive Menu (Red Hat/UE Linux, olaris PARC) Interactive Menu (Macintosh) Description ee User Guide ection -a Flash HBA beacon -a (View or Toggle Beacon tatus) on page 5-6 -b ave/update BIO/FCode a b -b (ave or Update the Flash BIO or Fcode) on page 5-7 -c how HBA settings -c (how Parameter ettings) on page 5-8 -d Update driver -d (Update Device Driver) on page 5-8 -dm Transceiver details -dm (Display Diagnostics Monitoring Info) on page 5-9 -e Boot device settings -e (Boot Device View elect Disable) on page 5-9 -f Input from a file -f (Input Parameter Options from a Text File) on page fg View driver settings -fg (how Driver ettings) on page fs Driver settings -fs (Configure Driver ettings) on page HBA utilities -g how system information -g (Display ystem Information) on page PRELIMINARY N H

31 A 2 Getting tarted tarting Non-interactive Mode Table 2-1. Non-interactive Mode Options (Continued) CLI Option Interactive Menu (Windows) Interactive Menu (Red Hat/UE Linux, olaris PARC) Interactive Menu (Macintosh) Description ee User Guide ection -gs HBA statistics -gs (how HBA tatistics) on page h -? how usage how usage -h (Help) on page ha HBA alias -ha (et Delete HBA Alias) on page i how HBA information -i (Display HBA General Information or VPD Information for One or All HBAs) on page kl Loopback test -kl (Loopback Test) on page kr Read/write buffer test -kr (Run Read/Write Buffer Test) on page l how LUN list -l (Display LUN Info) on page ls how Link status -ls (Display Link tatus) on page m elective LUNs -m (View, Enable, or Disable LUNs) on page n Configure HBA settings -n (et elected HBA Parameter) on page 5-34 N H 2-5

32 2 Getting tarted tarting Non-interactive Mode Table 2-1. Non-interactive Mode Options (Continued) CLI Option Interactive Menu (Windows) Interactive Menu (Red Hat/UE Linux, olaris PARC) Interactive Menu (Macintosh) Description ee User Guide ection -o Output to a file -o (Output to a File) on page p Target persistent binding -p (Display Persistent Target Binding Info) on page pa HBA port alias -pa (Define Port Alias) on page q Target link speed -q (View or et Target Link peed) on page r ave/update NVRAM Refresh 15 (16) 15 (16) 15 (16) Quit -s ilent mode -s (ilent Mode) on page t how device list -t (Display Target Information) on page tb Flash target beacon -tb (Target Beacon On/Off) on page tp how host topology -tp (Display Host Topology) on page v how version -v (Display Version) on page x Output in XML format -x (Output in XML Format 1) on page PRELIMINARY N H

33 A 2 Getting tarted Terminology Table 2-1. Non-interactive Mode Options (Continued) CLI Option Interactive Menu (Windows) Interactive Menu (Red Hat/UE Linux, olaris PARC) Interactive Menu (Macintosh) Description ee User Guide ection -z how all information for one or all HBAs Table Notes -z (Display All HBA information for One or All HBAs) on page 5-44 a b Windows, Linux, olaris x86 olaris PARC Options that have a corresponding menu selection cannot be combined. That is, only one option is allowed in a single command. If multiple options are specified in a command, only the first one is processed. These options, however, can be combined with one or more options that do not have a corresponding menu selection, with the exception of -F. For all command line options, ANsurfer FC HBA CLI shows the following when there are errors in the command line input: Error <error message> ANsurfer FC HBA CLI v1.x.x Build xx Copyright QLogic Corp. All rights reserved. Command Line QLogic FC Host Bus Adapters description of command entered Usage: <current command use usage> Terminology ome of the terms used in this guide are similar and some have changed slightly as technology changes. The following definitions apply: HBA Port HBA Port refers to the actual physical port on an HBA. For example, a QLA2462 has two ports called HBA port 1 and HBA port 2. N H 2-7

34 2 Getting tarted Terminology HBA Instance, HBA Instance number, or HBA Port Instance. When you install HBA in a system with other HBAs, each HBA port gets assigned a number by the driver or API so it knows which HBA to communicate with. This assigned number might be called HBA Instance, HBA instance number, or HBA Port Instance. HBA Alias. When an alias is assigned to a physical HBA, no matter how many ports that HBA has, the HBA Alias refers to the HBA, not one of its ports. Port Alias. You can also assign an alias to an individual port on an HBA. This Port Alias refers to only that port and none other. Thus, an HBA can only have one HBA Alias, but each port on that HBA must, have a unique Port Alias. 2-8 PRELIMINARY N H

35 3 Installing and Uninstalling ANsurfer FC HBA CLI This chapter provides procedures for downloading and installing ANsurfer FC HBA CLI, as well as how to remove the product. Refer to the following sections: Downloading the Installation Package on page 3-1 Installing ANsurfer FC HBA CLI on page 3-2 Uninstalling ANsurfer FC HBA CLI on page 3-14 Prerequisites Before you run ANsurfer FC HBA CLI, ensure that the following requirements are met: The HBAs must be installed. The HBA drivers must be installed. NOTE: ome ANsurfer FC HBA CLI features are not available when: You have a olaris system that is running with the driver distributed with the O 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. Downloading the Installation Package Follow these steps to download the ANsurfer FC HBA CLI installation package from the QLogic Web site. To download the installation package: 1. From the QLogic home page ( click the Downloads tab. 2. On the Driver Downloads / Manuals page, select your HBA model and then click Go! (Figure 3-1 shows an example.) N H 3-1

36 3 Installing and Uninstalling ANsurfer FC HBA CLI Installing ANsurfer FC HBA CLI Figure 3-1 electing HBA Model (Example) The resources page for the selected model appears. 3. Under Management Tools, click ANsurfer CLI... The End User oftware License Agreement page appears. 4. croll to the bottom and click Agree. 5. On the File Download dialog box, click ave. elect a directory on your system and download the file. Installing ANsurfer FC HBA CLI Follow the installation instructions in the section that corresponds to your operating system (O): Windows Installation on page 3-2 Linux Installation on page 3-9 olaris Installation on page 3-9 Macintosh Installation on page 3-12 Windows Installation To install ANsurfer FC HBA CL on Windows, follow either the GUI or command line installation steps: tandard (GUI) Installation on page 3-2 Command Line Installation on page 3-7 tandard (GUI) Installation Follow these steps to install ANsurfer FC HBA CLI on a Windows operating system using the standard (GUI) method. 3-2 PRELIMINARY N H

37 A 3 Installing and Uninstalling ANsurfer FC HBA CLI Installing ANsurfer FC HBA CLI To install ANsurfer FC HBA CLI on Windows (GUI): 1. Locate and double-click the installer package. The Preparing to Install dialog box appears, as shown in Figure 3-2. The status bar indicates that the installation package is loading. Figure 3-2 Preparing to Install Dialog Box After the install package is loaded, the Welcome dialog box appears as shown in Figure 3-3. N H 3-3

38 3 Installing and Uninstalling ANsurfer FC HBA CLI Installing ANsurfer FC HBA CLI Figure 3-3 Welcome Dialog Box 2. Read the information, and then click Next. The Choose Destination Location dialog box appears as shown in Figure 3-4. Figure 3-4 Choose Destination Location Dialog Box 3-4 PRELIMINARY N H

39 A 3 Installing and Uninstalling ANsurfer FC HBA CLI Installing ANsurfer FC HBA CLI 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\ANsurferCLI To select a different location: a. Click Browse. b. elect an installation location. c. The Choose Destination Location dialog box reappears. Click Next. The Ready to Install the Program dialog box appears as shown in Figure 3-5. Figure 3-5 Ready to Install the Program Dialog Box 4. Read the information, and then click Install. The etup tatus dialog box appears as shown in Figure 3-6. N H 3-5

40 3 Installing and Uninstalling ANsurfer FC HBA CLI Installing ANsurfer FC HBA CLI Figure 3-6 etup tatus Dialog Box If you want to stop the installation, click Cancel. The Installhield Wizard Complete dialog box appears as shown in Figure 3-7. Figure 3-7 Installhield Wizard Complete DIalog Box 3-6 PRELIMINARY N H