Q-Logic FC, FC0E Preface

SN0054614-00 K xv

Preface

The SANsurfer® FC/CNA HBA CLI tool provides a command line interface (CLI)

that lets you easily install, configure, and deploy QLogic® Fibre Channel (FC)

adapters, as well as QLogic Fibre Channel over Ethernet (FCoE) converged

network adapters (CNAs). It also provides robust diagnostic and troubleshooting

capabilities and useful statistical information to optimize SAN performance. This

tool only configures adapters on the local machine (where SANsurfer FC/CNA

HBA CLI is installed.)

SANsurfer FC/CNA HBA CLI is a simplified, condensed version of the SANsurfer

FC HBA Manager graphical user interface (GUI), which manages both local and

remote hosts.

SANsurfer FC/CNA HBA CLI can be operated in two modes:

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

intervention.

Non-interactive mode (command line interface). Use this mode for

scripting or when you want to do a single operation.

Intended Audience

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

adapters.

What’s in This Guide

This preface provides a general overview of the product and covers the intended

audience, related materials, document conventions, and contact information for

technical support.

NOTE:

This guide uses interchangeably the terms HBA, CNA, and adapter.

Contents

Main Document Revision History Page Page Table of Contents Preface 1 Installation and Removal 2 Getting Started 3 Interactive Commands Page Page Page 4 Non-Interactive Commands AXML Format 1 BXML Format 2 C Error/Exit Return Codes D Help Commands Glossary Index List of Figures List of Tables Preface Intended Audience Whats in This Guide Documentation Conventions Related Materials License Agreements Technical Support Availability Training Contact Information 1 Supported QLogic Adapters Supported Operating Systems System Requirements Hardware Requirements Software Requirements Unsupported Features Downloading the Installation Package Figure 1-1 Selecting Adapter Model (Example) Installing SANsurfer FC/CNA HBA CLI Windows Installation Standard (GUI) Installation Figure 1-2 Preparing to Install Dialog Box Page Figure 1-4 Choose Destination Location Dialog Box Page Figure 1-7 InstallShield Wizard Complete DIalog Box Command Line Installation Page Linux Installation Solaris Installation Solaris SPARC 8, 9, 10 Installation Page Solaris x86 9 and 10 Installation Macintosh Installation Standard (GUI) Installation Command Line Installation VMware Installation Uninstalling SANsurfer FC/CNA HBA CLI Windows Uninstall Standard (GUI) Uninstall Command Line Uninstall Linux Uninstall Solaris Uninstall Solaris SPARC 8, 9, and 10 Uninstall Solaris x86 8, 9, and 10 Uninstall Macintosh Uninstall VMware Uninstall 2 Starting Interactive Mode Page Page Starting Non-Interactive Mode Page Page Page Page Ter mi no lo gy Advanced Features N_Port ID virtualization (NPIV). Quality of service (QoS). 3 Page Page General Information Menu Host Information (Command Line Option -tp | -topology) Display (Host Topology) ( Page Page Page Generate Report Generate Report (Per Adapter Port) Page Page Page Page Page Page Page Generate Report (All Adapters) Refresh HBA Information Menu (Command Line Option -i) HBA General Information (per Adapter Port) HBA Information HBA Alias HBA Port Alias HBA VPD Information HBA Information (All HBAs) Information HBA Parameters Menu HBA Parameters (Per Adapter Port) Display HBA Parameters Configure HBA Parameters Page Page Page Page Page Page HBA Parameters (Per FCoE Engine) Display FCoE Parameters Configure FCoE Parameters Page Page HBA Parameters (All HBAs) Target/LUN List Menu (Command Line Options -t and -l) Target/LUN List (Per Adapter Port) Per Target/LUN Per Target/All LUNs Page 1. Info 2. Add 3. Delete All Targets Target/LUN List (All Adapters) Individual Target Individual LUN All Targets All Target(s) All LUN(s) Here is an example of the All LUNs information on Solaris with a QLA driver: Target Link Speed or iiDMA Settings Menu (Command Line Option -q) Configuring the iiDMA Settings HBA Port Instance HBA Port If you select a port for adapter model QLA2462, the following information appears: Advanced Configuration Target Link Speed: All HBAs Target Link Speed: All HBAs, Basic Configuration Target Link Speed: All HBAs, Advanced Configuration Page iiDMA Settings: Disk iiDMA: All HBAs Target Persistent Bindings Menu Target Persistent Bindings (Per Adapter Port) Display Target Persistent Binding Target Persistent Bindings: Bind Target(s) Here is an example of the Target Persistent Binding Menu for HBA Instance n: Target Persistent Binding - FC Port Configuration Target Persistent Binding (All HBAs) Selective LUNs Menu Selective LUNs (Per Adapter Port) Selective LUNs (All HBAs) Display LUN Configuration Manual Configure LUNs Auto Configure LUNs Boot Device Menu HBA Port Instance Boot Device(s) (Per Adapter Port) Configure Boot Device(s) Boot Device(s) (All HBAs) Driver Settings Menu Page Utilities Menu Update Flash (Per Adapter Port or All HBAs) (Command Line Option -b) Save Flash (Per Adapter Port) (Command Line Option -b and Reserved Word save) Update HBA Parameters (Per Adapter Port or All HBAs) Save HBA Parameters (Per Adapter Port) (Command Line Option -r and Reserved Word save) HBA Parameters Template (Per Adapter or All HBAs) (Command Line Option -n and OEM Name) Page Page Update Driver (Command Line Option -d) Update Firmware Preload Table Save Firmware Preload Table Update MPI Config Table Save MPI Config Table Driver Rescan (Command Line Option -rs) Firmware Area Update (Command Line Option -u) Page Firmware Area Save (Command Line Option -u) Beacon Menu Locate HBA: HBA Beacon (Command Line Option -a) Locate Target(s): Target Beacon (Command Line Option -tb) Diagnostics Menu (Command Line Options -kl, -kr, and -dm) Test Results Diagnostics Loopback Test Page Display Test Parameters (Loopback) Page Table 3-10. Adapter Diagnostics Configuration Settings Parameter Name <param name> Alias <param alias> Value <param value> Description Start Diagnostic Test (Loopback) Diagnostics Read/Write Buffer Test Configure Test Parameters (Read/Write) Start Diagnostic Test (Read/Write Buffer) Diagnostics Transceiver Details: DMI Transceiver Details: General Transceiver Details: Details Page Page Statistics Menu (Command Line Options -gs and -ls) HBA Statistics: Monitoring Configuration Page Page Show HBA Statistics Link Status Page Page Show Link Status Virtual Menu (Command Line Option -vp) Virtual Menu for Adapter Instance List Virtual Port(s) Delete Virtual Port(s) Page QoS Menu (Command Line Option -qos) Page QoS Priority Menu QoS Bandwidth Menu QoS Bandwidth Speed Menu Page QoS Bandwidth Percentage Menu FCoE Menu (Command Line Option -cna) FCoE Utilities Menu for QLE80xx Adapters Update Firmware Stats Menu To show port statistics using the command line option, enter the following command: Logs Menu FCoE Utilities Menu for QLx81xx Adapters (Command Line Option -cna) Information Data Center Bridging Page DCE Statistics Page Page Page TLV Page Help Menu (Command Line Option -h) Contents Exit Codes About Page 4 Display System Information (Command Line Options -g, -z, and -tp) Host Information Host Configuration Page Host Configuration Command Summary -a (View or Toggle Beacon Status) -b (Save or Update the Flash BIOS or FCode) -c (Show Parameter Settings) -cna (FCoE Utilities Menu for QLx81xx Adapters) Page -d (Update Device Driver) -dm (Display Diagnostics Monitoring Info) -e (Boot Device View | Select | Disable) Page -ei (List SANsurfer FC/CNA HBA CLI Error Codes) -f (Input Parameter Options from a Text File) -fcoe (Display and Configure FCoE Engine Parameters) Page -fg (Show Driver Settings) -fs (Configure Driver Settings) Page -g (Display System Information) -gs (Show HBA Statistics) -h (Help) -ha (Set | Delete HBA Alias) -i (Display HBA General Information or VPD Information for One or All HBAs) -kl (Loopback Test) DataPattern (DP) Page DataSize (DS) TestCount (TC) TestIncrement (TI) OnError (OE) LoopbackType (LT) Run a Loopback Test Page Page -kl (Run HBA Diagnostics Loopback Test) -kr (Run Read/Write Buffer Test) Run a Read/Write Buffer Test Page Run Adapter Diagnostics Read-write Buffer Test Page -l (Display LUN Info) -ls (Display Link Status) -m (View, Enable, or Disable LUNs) Page -n (Set Selected HBA Parameter) Table 4-14. Adapter Parameters Description Name Alias Value -o (Output to a File) -p (Display Persistent Target Binding Info) Page -pa (Define Port Alias) -pl (Show, Add, and Delete Persistent Names) -q (View or Set Target Link Speed) -qos (QoS Menu) -r (Update HBA Parameters) -s (Silent Mode) -t (Display Target Information) -tb (Target Beacon On/Off) -tp (Display Host Topology) -u -v (Display Version) -vp (Virtual Port) -x (Output in XML Format 1) (Output in XML Format 2) -x2 -z (Display All HBA information for One or All HBAs) Page A Output Parts Main Tag Utility Header Status Message XML Format 1 Tags for Each Option Display System Information The parameter <HBA/> repeats for each adapter in the system. Display Adapter Settings (Command Line Option -c) The XML Format 1 for adapter settings information is as follows: For multiple adapters, repeat the preceding sequence with the ID number Display HBA Information (Command Line Option -i) The XML Format 1 for adapter general information is as follows: Here is the information for the 4G adapters: NOTE: 4G adapters include VPD information as an option to the -i command. Here is the VPD information: Display Device List (Command Line Option -t) The XML Format 1 for adapter device information is as follows: The <Target></Target> sequence is repeated for each adapter target. Display LUN List Target Persistent Binding Selective LUNs Boot Device Diagnostics ResultsLoopback Test Diagnostics ResultsRead/Write Buffer Test (Command Line Option -kr) The XML Format 1 for the read/write buffer test results is as follows: The <Target> sequence is repeated for each device attached to the adapter. View Driver Settings Display All Information for One or All Adapters Page Page Link Statistics HBA Statistics HBA Alias (Command Line Option -ha) The XML Format 1 for the adapter alias option is as follows: HBA Port Alias (Command Line Option -pa) HBA Transceiver Details The XML Format 1 for adapter transceiver details (general information) is as The XML Format 1 for adapter transceiver details (detailed information) is as Page Page The XML Format 1 for an adapter type interconnect element is as follows: The XML Format 1 for a switch type interconnect element is as follows: Display FCoE Information The XML Format 1 for FCoE information output is as follows: Display FCoE Parameters The XML Format 1 for FCoE parameter output is as follows: Display FCoE Link Events The XML Format 1 for FCoE link events output is as follows: Page Display FCoE DCBX The XML Format 1 for FCoE DCBX output is as follows: Display FCoE Network Interface Statistics The XML Format 1 for FCoE network interface statistics output is as follows: Page Page Page Page Page Page B Output Parts Main Tag Utility Header Status Message Reboot Message Error Message XML Format 2 Tags for Each Option Display System Information The XML Format 2 for system information output is as follows: The parameter <HBA/> repeats for each adapter in the system. Display Adapter Settings (Command Line Option -c) Display HBA Information (Command Line Option -I) Another version of the command shows all information or VPD information: The XML Format 2 for adapter general information is as follows: The XML Format 2 for 4G adapters is as follows: Here is the VPD information: Display Device List (Command Line Option -t) The XML Format 2 for adapter device information is as follows: Display LUN List (Command Line Option -l) The XML Format 2 for the adapter LUN list information is as follows: Target Persistent Binding Selective LUNs The <Target> </Target> sequence repeats for each enabled LUN on the target. Boot Device The command format for all adapters is: The command format for a single adapter is: The XML Format 2 for the boot device information is as follows: Diagnostics ResultsLoopback Test Diagnostics ResultsRead/Write Buffer Test (Command Line Option -kr) The XML Format 2 for the read/write buffer test results is as follows: The <Target>... </Target> sequence repeats for each target. View Driver Settings Display All Information for One or All Adapters The XML Format 2 for all adapter information is as follows: Table B-1. Options Shown by -z (Continued) Non- interactive Option Description See User Guide Section Page Link Statistics HBA Statistics The <Statistics.../> sequence repeats for each adapter. The XML Format 2 for the adapter statistics option is as follows: HBA Alias (Command Line Option -ha) The XML Format 2 for the adapter alias option is as follows: HBA Port Alias (Command Line Option -pa) The XML Format 2 for adapter transceiver details (detailed information) is as HBA Transceiver Details The XML Format 2 for adapter transceiver details (general information) is as The XML Format 2 for the boot device information is as follows: Page The XML Format 2 for adapter transceiver details (general information) is as The XML Format 2 for adapter transceiver details (detailed information) is as Page Page Page The <InterconnectElement></InterconnectElement> sequence repeats for each interconnect element. Display FCoE Information The XML Format 2 for FCoE information output is as follows: The XML Format 2 for FCoE link events output is as follows: Display FCoE Parameters The XML Format 2 for FCoE parameter output is as follows: Page Display FCoE DCBX The XML Format 2 for FCoE DCBX output is as follows: Display FCoE Network Interface Statistics The XML Format 2 for FCoE network interface statistics output is as follows: Page Page Page Page Page Page C Table C-1. Error/Exit Return Codes Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page Page D Table D-1. Variables Used in Arguments Table D-2. Help Commands Command Table D-1. Variables Used in Arguments (Continued) Variab le Description Page Page Page Page Page Page Page Page Glossary Page Page Page Page Page Page Page Page Page Index Numerics A B C Page D E F G H I J K L M N O P Q R S T U V W X Z