R Simplify SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters SN0054614-00 F Page i
S SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters Information furnished in this manual is believed to be accurate and reliable. However, QLogic Corporation assumes no responsibility for its use, nor for any infringements of patents or other rights of third parties which may result from its use. QLogic Corporation reserves the right to change product specifications at any time without notice.
A SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters Changed HBA No. to HBA Instance. All Changed SFF DMI to HBA transceiver details. All Updated supported QLogic HBA list. Section 1.3 Updated supported operating system list. Section 1.4 All non-interactive information moved from Section 4 to Section 5. Section 4, Section 5 Command line options put in alphabetical order. Table 2-1, Section 4 Added Appendix B: XML Format 2.
SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters Changed bullets describing interactive and non-interactive modes. Section 2.2, Section 2.3 Clarified the note about starting SANsurfer FC HBA CLI on a Solaris console serial port. Section 2.2 Added Macintosh column to Table 2-1. Section 2.3 Added support for Linux IOCTL module driver and driver on the OS installation CD (inbox driver).
A SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters Expanded Save/Update Flash section to list which OSs and HBAs save/update flash, BIOS, or the option ROM image. Section 4.10 Added description and preparation instructions for loopback and read/write buffer tests. Added description of these test results. Section 4.12.1.1, Section 4.12.2 The following options and commands were added in Rev. E: Host Topology (command line option -tp) Section 4.1.
SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters Configure HBA Settings (-n): added option to restore the BIOS (QLA/QLE/QEM24xx HBAs). 4.7.1, Section 5.3.22 Selective LUNs (command line option -m): added ALL option to command line to view all selective LUNs for all HBA ports. 4.8.1.2, Section 5.3.21 Set Boot Device (-e): removed references to OSs from the third paragraph; this command now applies to all OSs. 4.9.2.1.
A SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters Revision D Changes: Operating systems supported: Windows 2003 Server™ and Enterprise Server: added x64; removed IEM64T and AMD64. Added Windows® XP. Red Hat™ Linux® AS: added x86_64; removed IEM64T and AMD64. SuSE® Linux Enterprise Server (SLES) 8 and 9: added x86_64; removed IEM64T and AMD64. Removed Power PC (PPC) SLES 8 and 9. Solaris® SPARC®: removed v2.7; added version 7.
SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters S The following options and commands were changed in Rev. D: Interactive mode commands: Changed instructions and the example text to new port sorting and numbering scheme. No change to command function. Non-interactive mode commands: Changed the HBA Port No. parameter to HBA No. parameter to support new port sorting and numbering scheme. No change to command function.
A SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters Display LUN List (-l): 4.6 In interactive mode, added target type to information displayed. Removed asset tag and end tag from list of VPD information. In example text, changed the first two option names of the Selective LUN(s) Display Configuration menu. In example text, changed the first two option names of the Selective LUN(s) Configuration HBA/Device menu.
SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters S Notes Page x SN0054614-00 F
Table of Contents Section 1 1.1 1.2 1.3 1.4 1.5 1.6 1.7 Introduction Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Guide Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2.1 How this Guide is Organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2.2 Documentation Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supported QLogic HBAs . . . .
SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters 3.3 Uninstalling SANsurfer FC HBA CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.3.1 Windows Uninstall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.3.1.1 Standard (GUI) Uninstall. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.3.1.2 Command Line Uninstall. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.3.
A 4.4 4.5 4.6 4.7 SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters Target/LUN List Menu (Command Line Options -t and -l) . . . . . . . . . . . . . . 4.4.1 Target/LUN List (Per HBA Port). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.4.1.1 Per Target/LUN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.4.1.2 Per Target/All LUNs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.4.1.
SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters 4.8 4.9 4.10 4.11 4.12 4.13 S Boot Device Menu (Command Line Option -e) . . . . . . . . . . . . . . . . . . . . . . 4.8.1 HBA Port Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.8.1.1 Boot Device(s) (Per HBA Port) . . . . . . . . . . . . . . . . . . . . . . . . . . 4.8.1.2 Configure Boot Device(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.
A SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters 4.13.2 Link Status (Command Line Option -ls). . . . . . . . . . . . . . . . . . . . . . . . 4.13.2.1 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.13.2.2 Show Link Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.14 Virtual Menu (Command Line Option -vp) . . . . . . . . . . . . . . . . . . . . . . . . . . 4.14.
SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters 5.3.16 5.3.16.1 5.3.16.2 5.3.16.3 5.3.16.4 5.3.16.5 5.3.16.6 5.3.17 5.3.18 5.3.18.1 5.3.18.2 5.3.19 5.3.20 5.3.21 5.3.22 5.3.23 5.3.24 5.3.25 5.3.26 5.3.27 5.3.28 5.3.29 5.3.30 5.3.31 5.3.32 5.3.33 5.3.34 5.3.35 5.3.36 S -kl (Loopback Test) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DataPattern (DP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
A SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters A.2.3 A.2.4 A.2.5 A.2.6 A.2.7 A.2.8 A.2.9 A.2.10 Display HBA Information (Command Line Option -i) . . . . . . . . . . . . . . Display Device List (Command Line Option -t) . . . . . . . . . . . . . . . . . . Display LUN List (Command Line Option -l) . . . . . . . . . . . . . . . . . . . . Target Persistent Binding (Command Line Option -p) . . . . . . . . . . . . . Selective LUNs (Command Line Option -m) .
SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters B.8.7 B.8.8 B.8.9 B.8.10 B.8.11 B.8.12 B.8.13 S Display Device List (Command Line Option -t) . . . . . . . . . . . . . . . . . . Display All Information for One or All HBAs (Command Line Option -z). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Link Statistics (Command Line Option -ls). . . . . . . . . . . . . . . . . . . . . .
A SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters List of Figures Figure Page 3-1 Preparing to Install Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2 3-2 Welcome Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3 3-3 Choose Destination Location Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters S Notes Page xx SN0054614-00 F
Section 1 Introduction 1.1 Product Overview The SANsurfer® FC HBA CLI tool provides a command line interface (CLI) that lets you easily install, configure, and deploy QLogic® Fibre Channel (FC) host bus adapters (HBAs). It also provides robust diagnostic and troubleshooting capabilities and useful statistical information to optimize SAN performance. This tool only configures HBAs on the local machine (where SANsurfer FC HBA CLI is installed.
S 1 – Introduction Guide Overview Section 2 Getting Started: This section describes the two modes used in SANsurfer FC HBA CLI: interactive and non-interactive. It also explains some special terms used in this guide. Section 3 Initial Installation: This section provides step-by-step instructions for installing and uninstalling SANsurfer FC HBA CLI on Windows, Linux, Solaris, and Macintosh.
A 1 – Introduction Guide Overview # scli -z Text in ALL CAPITALS usually indicates the name of a key that you press on the keyboard. For example: Type the number for Host Information and then press ENTER. Italicized text indicates either a document reference, glossary term, or emphasis. For example: Attached Port means a QLogic HBA.... For a complete list, see the QLogic SAN Interoperability Guide. Italicized text within angle brackets indicates user-defined variables.
S 1 – Introduction Supported QLogic HBAs 1.3 Supported QLogic HBAs SANsurfer FC HBA CLI is supported for the following QLogic HBAs: QLA234x QLA2xx QLE2xx QLE246x QLA246x QLE256x 1.
A 1 – Introduction System Requirements Apple® Macintosh® Solaris x86 9/10 (with latest patches) Mac OS® X 10.3.x (PowerPC® (PPC)), 10.4.x (PPC/Intel), and 1.5.x (PPC/Intel) VMware® VMware ESX Server 3.5 NOTE: VMware does not support 8Gb. NOTE: Throughout this guide, the terms Windows, Linux, Solaris, and Macintosh refer to all the respective supported operating systems unless otherwise noted. 1.
S 1 – Introduction System Requirements NOTE: Tape devices are shown as part of the configuration, but are not fully supported by SANsurfer FC HBA CLI. Only persistent binding and LUN masking are available. 256 MB physical RAM are required to run SANsurfer FC HBA CLI; running with less memory can cause disk swapping (“paging” or “paging out”), which severely affects performance. Video card capable of 256 colors and a screen resolution of 800x600 pixels. About 7 MB of disk space. 1.5.
A 1 – Introduction Technical Support 1.5.2.1.2 Features Not Available When Running ioctl Module Driver When running the input/output control (ioctl) module driver on a Linux OS, the following features are not available: Persistent binding Selective LUN HBA port statistics Driver settings Host topology 1.5.2.1.
S 1 – Introduction Contact Information Visit the QLogic support Web site at: support.qlogic.com for the latest firmware and product updates. 1.6.1 Availability QLogic Technical Support for products under warranty is available during local standard working hours excluding QLogic Observed Holidays. 1.6.2 Training QLogic offers certification training for the technical professional for both the QLogic FC HBAs and switches. From the training link at www.qlogic.
A 1 – Introduction Contact Information Europe, Middle East, and Africa Region E-mail emeasupport@qlogic.com Phone Numbers by Language +353 1 6924960 – English +353 1 6924961 – Français +353 1 6924962 – Deutsch +353 1 6924963 – Español +353 1 6924964 – Português +353 1 6924965 – Italiano Asia Pacific Region E-mail apacsupport@qlogic.
S 1 – Introduction Contact Information Notes 1-10 PRELIMINARY SN0054614-00 F
Section 2 Getting Started 2.1 Introduction SANsurfer FC HBA CLI operates in two modes: Interactive (menu-driven). The CLI starts, and then waits for and executes input commands until terminated by the user. Use this mode to do multiple operations. Section 4 Interactive Commands covers this interface. Non-interactive (command line). The CLI starts, does the functions defined by the list of parameters provided, and then terminates.
S 2 – Getting Started Starting Interactive Mode 3. Run SCLI commands as required. 4. When finished, return to the main menu, and type the indicated number to quit SANsurfer FC HBA CLI. 5. Close the terminal window. The Main Menu appears as shown in the following: SANsurfer FC HBA CLI v1.x.
A 2 – Getting Started Starting Non-interactive Mode 2.3 Starting Non-interactive Mode To start SANsurfer FC HBA CLI in non-interactive mode, type the following in a command window: scli SANsurfer FC HBA CLI executes the command options, then terminates.
S 2 – Getting Started Starting Non-interactive Mode . Table 2-1. Non-interactive Mode Options Interactive Menu (Windows) Interactive Menu (Red Hat/SuSE Linux, Solaris SPARC) Interactive Menu (Macintosh) -a 11 11 11 Flash HBA beacon 5.3.1 -b 10 10 — Save/update BIOS/FCodea 5.3.2 CLI Option Description Section b -c 2 2 2 Show HBA settings 5.3.3 -d 10 — 10 Update driver 5.3.4 -dM 12 12 12 Transceiver details 5.3.5 -e 8 8 8 Boot device settings 5.3.
A 2 – Getting Started Starting Non-interactive Mode Table 2-1. Non-interactive Mode Options (Continued) Interactive Menu (Windows) Interactive Menu (Red Hat/SuSE Linux, Solaris SPARC) Interactive Menu (Macintosh) -q 5 5 5 Target link speed 5.3.26 -r — — — Save/update NVRAM — — 1 1 1 Refresh — — 15 (16) 15 (16) 15 (16) Quit — -s — — — Silent mode 5.3.28 -t 4 4 4 Show device list 5.3.29 -tb 11 11 11 Flash target beacon 5.3.30 -tp 1 1 1 Show host topology 5.
S 2 – Getting Started Terminology 2.4 Terminology Some of the terms used in this guide are similar and some have changed slightly as technology changes. The following definitions apply: HBA Port HBA Port refers to the actual physical port on an HBA. For example, a QLA2462 has two ports called HBA port 1 and HBA port 2.
Section 3 Initial Installation Before you run SANsurfer FC HBA CLI, ensure that the following requirements are met: The HBAs must be installed. The HBA drivers must be installed. NOTES: Some SANsurfer FC HBA CLI features are not available when: You have a Solaris system that is running with the driver distributed with the OS installation CDs (QLC driver). You have a Linux system that is running with the ioctl or sysfs (inbox) driver.
3 – Initial Installation Installing SANsurfer FC HBA CLI S 3.2 Installing SANsurfer FC HBA CLI Follow the installation instructions in the section that corresponds to your operating system (OS): Windows—See section 3.2.1. Linux—See section 3.2.2. Solaris—See section 3.2.3. Macintosh—See section 3.2.4. 3.2.1 Windows Installation To install SANsurfer FC HBA CL on Windows, follow either the GUI or command line installation steps: Standard (GUI) installation—See section 3.2.1.1.
A 3 – Initial Installation Installing SANsurfer FC HBA CLI Figure 3-2 Welcome Dialog Box 2. Read the information, and then click Next. The Choose Destination Location dialog box appears as shown in Figure 3-3. Figure 3-3 Choose Destination Location Dialog Box 3. In the Choose Destination Location dialog box, do one of the following: To select the destination location in the dialog box, click Next (recommended).
S 3 – Initial Installation Installing SANsurfer FC HBA CLI To select a different location: a. Click Browse. b. Select an installation location. c. The Choose Destination Location dialog box reappears. Click Next. The Ready to Install the Program dialog box appears as shown in Figure 3-4. Figure 3-4 Ready to Install the Program Dialog Box 4. Read the information, and then click Install. The Setup Status dialog box appears as shown in Figure 3-5.
A 3 – Initial Installation Installing SANsurfer FC HBA CLI If you want to stop the installation, click Cancel. The InstallShield Wizard Complete dialog box appears as shown in Figure 3-6. Figure 3-6 InstallShield Wizard Complete DIalog Box 5. 6. (Optional.) Select one of the following: If you want to see more information about SANsurfer FC HBA CLI, select the I would like to view the README file check box.
S 3 – Initial Installation Installing SANsurfer FC HBA CLI By default, SANsurfer FC HBA CLI is installed in the following directory: Program files\QLogic Corporation\SANsurferCLI If you want to change the default location, enter the directory in the command line; for example: scli-1.x.x-xx.windows.exe installdir="c:\sansurfercli" 3.2.1.2.2 Silent Command Line Installation The command for a silent installation is the same as for a standard installation (see section 3.2.1.2.
A 3 – Initial Installation Installing SANsurfer FC HBA CLI To create a response file for a silent installation of SANsurfer FC HBA CLI, enter the following: scli-1.x.x-xx.windows.exe /r /f1"C:\Temp\install_1.iss" To run the installation in silent mode with a log file, enter the following: scli-1.x.x-xx.windows.exe /s /f1"C:\Temp\install_2.iss" To run the installation in silent mode with an alternate file in a temporary directory, enter the following: scli-1.x.x-xx.windows.exe /s /f1"C:\Temp\install_1.
S 3 – Initial Installation Installing SANsurfer FC HBA CLI To query for the installed SANsurfer FC HBA CLI package name, enter the following text from the command line: rpm -q scli 3.2.3 Solaris Installation To install SANsurfer FC HBA CLI on Solaris, follow the steps in one of these sections: Solaris SPARC 8, 9, 10—See section 3.2.3.1. Solaris x86 9 and 10—See section 3.2.3.2. 3.2.3.
A 3 – Initial Installation Installing SANsurfer FC HBA CLI 5. The pkgadd program does a series of checks, and then posts a script warning and asks whether to continue the installation. For example: Processing package instance from QLogic SANsurfer FC CLI (HBA Configuration Utility) (sparc) x.xx.xx Build xx QLogic Corporation ## Executing checkinstall script. Using as the package base directory. ## Processing package information.
S 3 – Initial Installation Installing SANsurfer FC HBA CLI NOTE: In the file name, x.xx.xx-xx stands for the current version of SANsurfer FC HBA CLI. The -xx stands for the build version. 2. To uncompress the file, type the following: # uncompress scli-x.xx.xx-xx.x86.Solaris.pkg 3. To see the available package file, type the following: # ls The available packages appear. For example: # scli.x.xx.xx-xx.SPARC-X86.Solaris.pkg 4. To install SANsurfer FC HBA CLI, type the following: # pkgadd -d scli-x.
A 3 – Initial Installation Installing SANsurfer FC HBA CLI . [ verifying class ] ## Executing postinatall script. Installation of was successful. 3.2.4 Macintosh Installation To install SANsurfer FC HBA CLI, follow either the standard GUI or command line installation method: Standard (GUI) installation—See section 3.2.4.1. Command line installation—See section 3.2.4.2. 3.2.4.1 Standard (GUI) Installation Follow these steps to install SANsurfer FC HBA CLI on a Macintosh: 1.
S 3 – Initial Installation Uninstalling SANsurfer FC HBA CLI tar -zxvf .tgz For example: qlogic:~ root#tar -zxvf scli-x.x.x-x.macos.pkg.tgz ./scli-x.x.x-x.pkg/ ./scli-x.x.x-x.pkg/Contents/ ./scli-x.x.x-x.pkg/Contents/Archive.bom ./scli-x.x.x-x.pkg/Contents/Archive.pax.gz ... ... This command extracts the compressed file to a directory named scli-x.x.x-x.pkg. 3. Install the package to the default directory. For example: installer -pkg scli-x.x.x-x.
A 3 – Initial Installation Uninstalling SANsurfer FC HBA CLI 3.3.1 Windows Uninstall To uninstall SANsurfer FC HBA CLI, use either the standard GUI or command line method: Standard (GUI) uninstall—See section 3.3.1.1 Command line uninstall—See section 3.3.1.2 3.3.1.1 Standard (GUI) Uninstall To uninstall SANsurfer FC HBA CLI using the GUI, do the following steps: 1. From the Control Panel, click Add or Remove Programs. 2. Highlight SANsurfer FC HBA CLI. 3. Click Remove.
3 – Initial Installation Uninstalling SANsurfer FC HBA CLI S Solaris SPARC 8, 9, 10—See section 3.3.3.1. Solaris x86 8, 9, 10—See section 3.3.3.2. 3.3.3.1 Solaris SPARC 8, 9, and 10 Uninstall Follow these steps to uninstall SANsurfer FC HBA CLI: 1. Type the following to remove SANsurfer FC HBA CLI: # pkgrm QLScli 2. The program shows the package name and a script warning asking whether to continue the uninstall process.
A 3 – Initial Installation Uninstalling SANsurfer FC HBA CLI 2. The program shows the package name and a script warning asking whether to continue the uninstall process. For example: The following package is currently installed: QLSclix QLogic SANsurfer FC CLI (HBA Configuration Utility) (x86) 1.x.x Build xx Do you want to remove this package? 3. Type y and press ENTER. The program shows a script warning asking whether to continue the uninstall process.
3 – Initial Installation Uninstalling SANsurfer FC HBA CLI S Notes 3-16 SN0054614-00 F
Section 4 Interactive Commands This section describes the interactive mode command line options for specific QLogic FC HBAs. The interactive mode uses a series of menus from which you select the option you want and enter the number for that option. (See Section 5 for non-interactive mode operation in which you simply enter a one- or two-letter code to perform operations on the HBA.
S 4 – Interactive Commands General Information Menu (Command Line Option -g) Selections from the Main Menu open new menus. For example, if you click item 1 (General Information) on the main interactive menu, the system shows a new menu, the General Information Menu. From this menu you have several choices including 1: Host Information, 2: Host Topology, and so forth. On every menu you can type the number for Return to Previous Menu and move to the next higher level (parent) menu.
A 4 – Interactive Commands General Information Menu (Command Line Option -g) OS version (patches where applicable) SDM API version A list of HBAs including, for each HBA: HBA model and serial number (SN) Port number WWPN HBA Instance number Status (online/offline) (Repeats for each HBA) Total number of QLogic HBAs detected NOTE: The SAN Device Management (SDM) API is a QLogic-specific library required for SANsurfer FC HBA CLI.
4 – Interactive Commands General Information Menu (Command Line Option -g) S This option shows you the HBA Host Topology menu. NOTE: Under Linux, host topology (-tp) is disabled if you are using the ioctl or sysfs (inbox) driver. From the General Information Menu, type the number for Host Topology, and then press ENTER. When you select this option, the following options appear: Display Save As Txt file Save As XML File 4.1.2.
A 4 – Interactive Commands General Information Menu (Command Line Option -g) Interconnect element (HBA) Type World wide node name World wide port name Vendor ID HBA Model HBA Serial Number HBA Alias Port Alias Driver Version Firmware Version Total Number of Devices Host Number of Port Beacon Status Port Type Port State Port Information (repeats for each port) (Every port may not use all items): Physical Port Number (Switch or HBA port number), including:
4 – Interactive Commands General Information Menu (Command Line Option -g) S Here is an example: ================================= = InterConnect Element = ================================= Type : HBA World Wide Node Name : 20-00-00-E0-8B-03-55-7C World Wide Port Name : 21-00-00-E0-8B-03-55-7C Vendor Id : QLogic Corporation HBA Model : 2200 HBA Serial Number : C28437 HBA Alias : Port Alias : Driver Version : SCSI Miniport 8.1.5.15 (W2K IP) Firmware Version : 2.02.
A 4 – Interactive Commands General Information Menu (Command Line Option -g) Port Name : 20-01-00-C0-DD-00-6A-9F Port state : Offline Port Type : Vendor Specific/Reserved Port Type.
S 4 – Interactive Commands General Information Menu (Command Line Option -g) ================================= Type : HBA World Wide Node Name : 20-00-00-E0-8B-85-8C-7C World Wide Port Name : 21-00-00-E0-8B-85-8C-7C Vendor Id : QLogic Corporation HBA Model : QLA2462 HBA Serial Number : FFC0551D59564 HBA Alias : Port Alias : Driver Version : STOR Miniport 9.1.0.18 (w32) Firmware Version : 4.00.
A 4 – Interactive Commands General Information Menu (Command Line Option -g) Topology has been successfully saved to file BRAGI_topology_06152007_093855.xml 4.1.2.3.2 Save to XML File – Format 2 (Command Line Option -x2) 1: General Information 2: Host Topology 3: Save As XML File 2: Save As XML File format 2 The system responds with the name of the XML Format 2 file; for example: Topology has been successfully saved to file BRAGI_topology_06152007_093855.xml 4.1.
S 4 – Interactive Commands General Information Menu (Command Line Option -g) HBA General Information HBA VPD Header (Vital Product Data) Information (for QLA/QLE24xx only) HBA Instance HBA Type Port Number WWPN Port ID The actual VPD information: 4-10 Host Name HBA Instance HBA Model HBA Description HBA ID HBA Alias HBA Port Port Alias Node Name (WWNN) Port Name (WWPN) Port ID Serial Number Driver Version BIOS Ve
A 4 – Interactive Commands General Information Menu (Command Line Option -g) HBA Parameters Settings Header (Command Line Options -c) HBA Parameter Settings HBA Instance HBA Part Number Port Number WWPN Port ID Driver Settings (repeats for each HBA Instance) Driver Settings - Group: Persistent Persistently bound Plus New targets Persistently bound targets only Driver Settings - Group: Binding Bind by WWPN Bind by Port ID Device/L
4 – Interactive Commands General Information Menu (Command Line Option -g) Device Vendor ID Device Product ID Serial Number Device Port Name Device Port ID Boot Device Settings 4-12 HBA Instance HBA Part Number Port Number WWPN Port ID Selective LUN Information Product Vendor Product ID Product revision LUN Size Type WWULN Selective LUN Information Header (repeats for each selective LUN) Path Target Device ID Product Vendor Product ID Product Revision Serial
A 4 – Interactive Commands General Information Menu (Command Line Option -g) Primary Boot Port Address Alternate 1 Boot Port Name Alternate 1 Boot Port Address Alternate 2 Boot Port Name Alternate 2 Boot Port Address Alternate 3 Boot Port Name Alternate 3 Boot Port Address An example follows: SANsurfer FC HBA CLI v1.7.1 Build 9 Copyright (C) 2003-2007 QLogic Corp. All rights reserved.
4 – Interactive Commands General Information Menu (Command Line Option -g) S Port Name : 21-01-00-E0-8B-23-55-7C Port ID : 11-06-00 Serial Number : C28437 Driver Version : SCSI Miniport 8.1.5.15 (W2K IP) BIOS Version : 1.83 Firmware Version : 2.02.
A 4 – Interactive Commands General Information Menu (Command Line Option -g) Present targets that are persistently bound Only : Disable -------------------------------Driver Settings - Group: Binding -------------------------------Bind by World Wide Port Name : Enable Bind by Port ID : Disable -----------------------------------------------------------------------------Devices/LUNs Information -----------------------------------------------------------------------------------------------------------------
4 – Interactive Commands General Information Menu (Command Line Option -g) S LUN Count(s) : 1 Status : Online -------------------------------------------------------------------------------------------------LUN 0 --------------------------------------Product Vendor : SEAGATE Product ID : ST118273 CLAR18 Product Revision : SG1D LUN : 0 Size : 16.95 GB Type : SBC-2 Direct access block device (e.g.
A 4 – Interactive Commands HBA Information Menu (Command Line Option -i) (Primary ) Boot Port Name ---------------------------00-00-00-00-00-00-00-00 ---------------------------(Alternate 1) Boot Port Name ---------------------------00-00-00-00-00-00-00-00 ---------------------------(Alternate 2) Boot Port Name ---------------------------00-00-00-00-00-00-00-00 ---------------------------(Alternate 3) Boot Port Name ---------------------------00-00-00-00-00-00-00-00 Finish in 1 second(s)...
S 4 – Interactive Commands HBA Information Menu (Command Line Option -i) [additional port(s) as appropriate] Additional HBAs (as appropriate) All HBAs Here is an example of a typical HBA Information Menu screen.
A 4 – Interactive Commands HBA Information Menu (Command Line Option -i) HBA Model WWNN Serial number Alias With this option you can create, modify, or delete the symbolic name or alias, for an HBA. From the Main Menu, follow these steps: 1. Type the number for the HBA Information option and press ENTER. 2. Type the number for the HBA you want to configure and press ENTER. 3. Type the number for the HBA Alias option and press ENTER.
S 4 – Interactive Commands HBA Information Menu (Command Line Option -i) The HBA Port Alias option allows you to create, modify, or delete a symbolic name (Alias) for the specified HBA port. Follow these steps to create, modify, or delete an HBA port alias: 1. From the Main Menu, type the number for the HBA Information option, and then press ENTER. 2. Type the number for the HBA Port for which you want to change the Port Alias, and then press ENTER. 3.
A 4 – Interactive Commands HBA Parameters Menu EFI Driver Version Firmware Version BIOS Version (Windows and Linux) FCode Version (Solaris) If the HBA does not support VPD, the following message appears: VPD not supported on current HBA 6! 4.2.2 HBA Information (All HBAs) 2: HBA Information n: All HBAs Depending on how many HBAs are in the host, the number to select this option varies.
S 4 – Interactive Commands HBA Parameters Menu All HBAs Here is an example of an HBA Information Menu screen. In this example, the host includes three HBAs with two ports each and one HBA with a single port: HBA Model QLA2342: 1. Port 1 WWPN 21-00-00-EO-8B-01-43-9B Online 2. Port 2 WWPN 21-01-00-E0-8B-21-43-9B Online HBA Model QLA2300: 3. Port 1 WWPN 21-00-00-E0-8B-05-CB-D8 Loop down 4. Port 2 WWPN 21-01-00-E0-8B-25-CB-D8 Online HBA Model QLA2462: 5. Port 1 WWPN 21-00-00-E0-8B-1P-9D-P0 Online 6.
A 4 – Interactive Commands HBA Parameters Menu Execution Throttle Login Retry Count Enable LIP Reset Port Down Retry Count Enable LIP Full Login Link Down Timeout (seconds) Enable Target Reset LUNs Per Target Enable Receive Out Of Order Frame 4.3.1.
S 4 – Interactive Commands HBA Parameters Menu Table 4-1. HBA Parameters Settings (NVRAM) Parameter Name Alias Value Description ConnectionOption CO 0–3 See table note 1. DataRate DR 0–4 See table note 2. EnableBIOS EB 0, 1 See table notes 3, 4. EnableExtendedLogging EL 0, 1 See table notes 3, 4. EnableFCTape EF 0, 1 See table note 3. EnableHardLooplD HL 0, 1 See table note 3. EnableLIPFullLogin FL 0, 1 See table note 3. EnableLipReset LP 0, 1 See table note 3.
A 4 – Interactive Commands HBA Parameters Menu 3. Others: 0 = Disable 1 = Enable 4. Option is not available on 4Gb or latest HBAs. 5. Option is available on 4Gb or latest HBAs. 6. Operation Modes: 0 = Interrupt for every I/O completion 5 = Interrupt when Interrupt Delay Timer expires. 6 = Interrupt when Interrupt Delay Timer expires or no active I/O. 4.3.1.2.1 Connection Options 3: HBA Parameters 1: Port Number 2: Configure HBA Parameters n.
S 4 – Interactive Commands HBA Parameters Menu Frame Size: 512 Frame Size: 1024 Frame Size: 2048 Type the number for the frame size you want and press ENTER. 4.3.1.2.4 Hard Loop ID 3: HBA Parameters N: Port Number 2: Configure HBA Parameters n. Hard Loop ID This option prompts you to enter a valid Hard Loop ID from 0 to 125. Type the number you want and press ENTER. 4.3.1.2.5 Loop Reset Delay 3: HBA Parameters N: Port Number 2: Configure HBA Parameters n.
A 4 – Interactive Commands HBA Parameters Menu 4.3.1.2.9 Operation Mode 3: HBA Parameters N: Port Number 2: Configure HBA Parameters n. Operation Mode This option shows the Operation Mode Menu. From it you can select: Interrupt for every I/O Completion Interrupt when Interrupt DelayTimer expires Interrupt when Interrupt Delay Timer expires or no active I/O Type the number for the Operation Mode you want and press ENTER. 4.3.1.2.
S 4 – Interactive Commands HBA Parameters Menu This choice gives you the option to set the Port Down Retry Count to a value from 0 to 255. 4.3.1.2.15 Enable LIP Full Login 3: HBA Parameters N: Port Number 2: Configure HBA Parameters n. Enable LIP Full Login This choice gives you the option to enable or disable LIP Full Login. 4.3.1.2.16 Link Down Timeout 3: HBA Parameters N: Port Number 2: Configure HBA Parameters n.
A 4 – Interactive Commands HBA Parameters Menu 4.3.1.2.20 Abort Changes 3: HBA Parameters N: Port Number 2: Configure HBA Parameters n: Abort changes Choose this option to stop without making any changes. 4.3.1.3 Restore Defaults 3: HBA Parameters n: Port Number 3: Restore Defaults This option is for 4Gb and 8Gb HBAs only. Selecting the Restore Defaults option causes the following warning to appear: Warning: Please update the HBA parameters with extreme care.
4 – Interactive Commands Target/LUN List Menu (Command Line Options -t and -l) S 4.4 Target/LUN List Menu (Command Line Options -t and -l) 4: Target/LUN List This option shows the main Target List Menu. which includes a list of all HBAs and port instances detected on the host. You have the option to select: Each HBA port individually All HBAs Here is an example of the Target List Menu: HBA Model QLA2342: 1. Port 1 WWPN 21-00-00-EO-8B-01-43-9B Online 2.
A 4 – Interactive Commands Target/LUN List Menu (Command Line Options -t and -l) 4.4.1 Target/LUN List (Per HBA Port) 4: Target/LUN List 1 - n Target List Menu - Port n When you select an HBA Port instance from the Target/LUN List, a list of LUNs (disks) attached to that port instance appears.
S 4 – Interactive Commands Target/LUN List Menu (Command Line Options -t and -l) LUN Number Vendor Product ID Port Name Port ID All LUN(s) Here is an example of the LUN List Menu: 1: LUN 0 Vendor Product ID Port Name Port ID : : : : SEAGATE ST318453FC 22-00-00-11-C6-2D-5B-F9 02-0A-DC And so on. M: All LUN(s) N: Return to Previous Menu 4.4.1.
A 4 – Interactive Commands Target/LUN List Menu (Command Line Options -t and -l) 4.4.1.3 All Targets 4: Target/LUN List 1 - n Target List Menu Port n 1 - n: Target m: All LUNs When you select a particular LUN from the LUN list, the following information for all LUNs appears: Product Vendor Product ID Product Revision LUN Size Type WWULN OS LUN Name (on Solaris and Linux) (Repeats for each LUN) Here is an example of the LUN information.
S 4 – Interactive Commands Target/LUN List Menu (Command Line Options -t and -l) This choice shows the Target List Menu for All HBAs.
A 4 – Interactive Commands Target/LUN List Menu (Command Line Options -t and -l) Status Here is an example of the Target information: Path Target Device ID Product Vendor Product ID Product Revision Serial Number Node Name Port Name Port ID Product Type LUN Count(s) Status : : : : : : : : : : : : : 0 3 0x87 SEAGATE ST336607FC 0006 3JA9TN7600007517T6P1 20-00-00-11-C6-2D-5B-F9 22-00-00-11-C6-2D-5B-F9 02-0A-DC Disk 1 Online 4.4.2.
4 – Interactive Commands Target/LUN List Menu (Command Line Options -t and -l) S WWULN : 20-00-00-0C-50-68-1E-9A -----------------------------------------------Hit (RETURN) to continue: 4.4.2.
A 4 – Interactive Commands Target/LUN List Menu (Command Line Options -t and -l) 4.4.2.
S 4 – Interactive Commands Target Link Speed or iiDMA Settings Menu (Command Line Option -q) LUN Size Type WWULN OS LUN Name : 0 : 68.37 GB : SBC-2 Direct access block device (e.g., magnetic disk) : 20-00-00-00-87-72-85-B2 : /dev/sda Here is an example of the All LUNs information on Solaris with a QLA driver: Product Vendor Product ID Product Revision LUN Size Type : : : : : : SUN StorEdge 3510 415F 15 4.88 GB SBC-2 Direct access block device (e.g.
A 4 – Interactive Commands Target Link Speed or iiDMA Settings Menu (Command Line Option -q) 8. All HBAs 9. Return to Previous Menu Table 4-3 lists the target link speed settings and descriptions. Table 4-3. Target Link Speed Settings Target Link Speed Settings Description
IP Address. HBA number (HBA instance number). HBA World Wide Port Name, format xx-xx-xx-xx-xx-xx-xx-xx or xxxxxxxx.4 – Interactive Commands Target Link Speed or iiDMA Settings Menu (Command Line Option -q) 4. S To use Basic Configuration: a. Select the HBA. b. Select the intelligent interleave factor from the intelligent interleave factor speed list (1 Gbps, 2 Gbps, 4 Gbps, or 8 Gbps) to all attached devices. c. Choose one of the following options: To apply the new settings to all attached devices, select Yes. The following is returned: iiDMA settings have been saved to selected target(s) on HBA instance n.
A 4 – Interactive Commands Target Link Speed or iiDMA Settings Menu (Command Line Option -q) Product Revision Serial Number Port Name Port ID Max Target Link Rate Next Target Type (for example, Disk) Apply Changes to Selected Targets Here is an example of the Target Link Speed Menu for all HBA Instances: Target Link Speed Menu HBA Instance 0 (QLA2463 Port 1) : Online Desc: QLA2462 PCI-X 2.
4 – Interactive Commands Target Link Speed or iiDMA Settings Menu (Command Line Option -q) S iiDMA Menu HBA Instance 3 (QLA2462 Port 2) : Online WWPN: 21-01-00-E0-8B-A5-8C-7C Desc: QLA2462 PCI-X 2.
A 4 – Interactive Commands Target Link Speed or iiDMA Settings Menu (Command Line Option -q) When you have set the speed for all the links you want, type the number for Apply changes to Selected Target(s) and then press ENTER. 4.5.4 Target Link Speed – All HBAs 5: Target Link Speed 2: All HBAs When you select this option, the Target Link Speed Menu for All HBAs appears. It offers two options: Basic configuration Advanced Configuration 4.5.4.
4 – Interactive Commands Target Link Speed or iiDMA Settings Menu (Command Line Option -q) S Apply Changes to Selected Targets Here is an example of the Target Link Speed Menu (Advanced) for All HBAs: Target Link Speed Menu (Advanced) All HBAs 1: Disk 0 on QLA2462 (HBA Instance 0) Vendor : SEAGATE Product ID : ST318453FC Product Rev : DF12 Serial Number : 3EV0NYSG000072496DYD Port Name : 22-00-00-04-CF-9C-24-CA Port ID : 02-00-E1 Max Target Link Rate : 4 Gbps 2: Disk 1 on QLA2462 (HBA Instance 0) V
A 4 – Interactive Commands Target Persistent Bindings Menu (Command Line Option -p) When you select an HBA to set its link speed, the Target Link Speed Menu (Advanced) menu for a particular HBA instance appears. It shows the link speed options you can choose from. The options vary according to the HBA in use.
S 4 – Interactive Commands Target Persistent Bindings Menu (Command Line Option -p) When you select this option, SANsurfer FC HBA CLI shows the Target Persistent Binding menu listing standard HBA port instances (see 4.5.2), where you can select an individual HBA port or All HBAs. The following sections describe how to view, set, and delete the HBA’s target persistent binding in interactive and non-interactive modes.
A 4 – Interactive Commands Target Persistent Bindings Menu (Command Line Option -p) Target information (model name and number, for example) Port Name Port ID Target ID 4.6.1.2 Target Persistent Bindings – Bind Target(s) (Command Line Option -p) 6: Target Persistent Bindings 1 - n: Target Persistent Bindings HBA Instance n 2: Bind Target(s) When you select the Bind Targets option, the Target Persistent Binding Menu for HBA Instance n appears.
S 4 – Interactive Commands Target Persistent Bindings Menu (Command Line Option -p) Product ID Port Name Port ID Bind Target ID ... n: Disk Vendor Product ID Port Name Port ID Bind Target ID p: : ST318453FC : 22-00-00-11-C6-2D-5A-3F : 11-0A-E2 : No : : : : : : : SEAGATE ST318453FC 22-00-00-11-C6-2D-5A-3F 02-0A-E4 No All Target(s) 4.6.1.2.
A 4 – Interactive Commands Selective LUNs Menu (Command Line Option -m) 4.6.2.1 Display Target Persistent Binding 6: Target Persistent Binding p: All HBAs 1: Display Configuration When you select the Display Configuration option, the following information appears.
S 4 – Interactive Commands Selective LUNs Menu (Command Line Option -m) Auto Configure LUNs If this option is not available for the selected LUN, the following message appears: Configuration not permitted. persistently bound (HBA n)! Device(s) either not present or not 4.7.
A 4 – Interactive Commands Boot Device Menu (Command Line Option -e) 3: Return to Previous Menu The general view shows: -----------------------------------------------------------------------------HBA Instance 5: QLA2300 Port 2 WWPN 21-01-00-E0-8B-25-CB-D8 PortID 11-05-EF -----------------------------------------------------------------------------Enable Type Target/LUN Info Port Name LUN ID ------ -------- ----------------------- ----------------------- -----Yes Disk SEAGATE ST136403FC 21-00-00-20-37-1
4 – Interactive Commands Boot Device Menu (Command Line Option -e) S 4.8.1 HBA Port Instance 8: Boot Device 1 - m: HBA Port Instance When you select this option, SANsurfer FC HBA CLI shows the Boot Device Settings menu for HBA Instance m. You can choose to: Display Boot Device(s) Configure Boot Device(s) 4.8.1.
A 4 – Interactive Commands Boot Device Menu (Command Line Option -e) 00-00-00-00-00-00-00-00 ---------------------------(Alternate 3) Boot Port Name ---------------------------00-00-00-00-00-00-00-00 0 -----LUN -----0 4.8.1.2 Configure Boot Device(s) 8: Boot Device n: Port Number 2: Configure Boot Device(s) When you select this option, SANsurfer FC HBA CLI shows the Boot Device Settings menu for HBA Instance m, including the HBA model number, and details about its specifications.
S 4 – Interactive Commands Driver Settings Menu (Command Line Option -fg) 4.8.1.2.3 Save Configuration 8: Boot Device n: Port Number 2: Config.Boot Device 2: Device Settings 1: LUN List 1: Save Configuration When you select this option, the CLI shows the Save Configuration menu: Proceed Cancel 4.8.2 Boot Device(s) (All HBAs) 8: Boot Device 1: All HBAs When you select this option, SANsurfer FC HBA CLI shows information about all boot devices for all HBAs.
A 4 – Interactive Commands Driver Settings Menu (Command Line Option -fg) NOTE: Options on the Driver Settings menu differ according to the driver type: failover, non-failover, Windows, Solaris, or Macintosh: Present persistently bound target(s) plus any new target(s) with driver default (option available for all drivers) Present persistently bound target(s) Only (option available for all drivers) Present targets with driver default (option available for failover driver only) Bind by World Wide Po
S 4 – Interactive Commands Utilities Menu Table 4-4. Driver Settings (Continued) Parameter Name Alias Value BindPortID a BP 0,1 Description Bind devices by Port IDs. Driver Parameter NewOnly (NO) is supported only with the failover driver. 4.
A 4 – Interactive Commands Utilities Menu 4.10.3 HBA Parameters Update (Per HBA Port or All HBAs) (Command Line Option -r) 10: Utilities 3: HBA Parameters Update When you select HBA Parameters Update, you are prompted to select either one of your HBA port instances or All HBAs to update. SANsurfer FC HBA CLI then displays the following warning message: Warning: Please update the HBA parameters with extreme care. Incorrectly updating the HBA parameters may render the HBA inoperable.
S 4 – Interactive Commands Utilities Menu When you select the HBA Parameters Template option, SANsurfer FC HBA CLI prompts you to select an HBA port (or All HBAs), and then offers some or all of the following template types: EMC (EMC-specific settings) HP (HP-specific settings) HPQ (HP-specific settings – 2Gb HP HBAs) IBM (IBM-specific settings) QLGC (QLogic-specific settings) SUN (SUN-specific settings) Select one of the templates to apply it immediately to the HBA port instance (or All HBA
A 4 – Interactive Commands Utilities Menu Link Down Timeout specifies the time the driver waits for the link to come up after link down before returning the I/Os. This is analogous to the Port Down Retry Count setting, which is used when the port is down. The following tables list the parameter settings supported by templates for the specified HBAs. Table 4-5.
S 4 – Interactive Commands Utilities Menu Table 4-7. Template Supported Parameter Settings for QLA23xx HBAs (ISP2300/2310) Setting QLogic EMC IBM SUN Execution Throttle 16 256 256 16 Descending Loop ID Search 0 1 0 0 Maximum LUNs Per Target 128 256 0 8 Port Down Retry Count 30 45 30 30 Link Down Timeout 30 45 30 0 Table 4-8.
A 4 – Interactive Commands Beacon Menu 4.11 Beacon Menu 11: Beacon When you select the Beacon option, SANsurfer FC HBA CLI shows the Beacon Menu containing these options: Locate HBA Locate Target(s) 4.11.1 Locate HBA – HBA Beacon (Command Line Option -a) 11: Beacon 1: Locate HBA When you select this option, SANsurfer FC HBA CLI shows the HBA Beacon Menu that lists all HBA ports. Select any port and press ENTER to toggle the Beacon LED for that port: 4.11.
S 4 – Interactive Commands Diagnostics Menu (Command Line Options -kl, -kr, and -dm) You can select a disk number to blink the LED on that target. The blinking asterisk (*) below the Device Port Name line shows that the target beacon is active.
A 4 – Interactive Commands Diagnostics Menu (Command Line Options -kl, -kr, and -dm) Table 4-9.
S 4 – Interactive Commands Diagnostics Menu (Command Line Options -kl, -kr, and -dm) Loopback Test Read/Write Buffer Test Transceiver Details (available on 4Gb and 8Gb only) Test results for loopback and read/write buffer tests may include these test results: Loopback test results: Test Status CRC Error Disparity Error Frame Length Error Read/Write buffer test results: Loop ID/Status Data Miscompare Link Failure Loss of Sync Loss of Signal Invalid CRC 4.12.1.
A 4 – Interactive Commands Diagnostics Menu (Command Line Options -kl, -kr, and -dm) The loopback test is external to the HBA. If the HBA port is in loop mode, you can run the loopback test with a loopback connector. If the HBA port is in point-to-point mode and attached to a switch, an echo test is run instead (no loopback connector is used). In addition, some driver versions do not require a loopback connector. The test evaluates the ports (transmit and receive transceivers) on the HBA.
4 – Interactive Commands Diagnostics Menu (Command Line Options -kl, -kr, and -dm) S After completing the loopback test, do the following steps to prepare for normal HBA operations: 1. Remove the loopback connector from the HBA connector. 2. Reconnect the cable that you disconnected before installing the loopback connector. 3. From the Connections Options menu (interactive mode) or the -N command (non-interactive mode), change the setting back to its previous setting. 4.12.1.
A 4 – Interactive Commands Diagnostics Menu (Command Line Options -kl, -kr, and -dm) Display Test Parameters Reset Test Parameters Configure Test Parameters Start Diagnostics Test The read/write buffer test sends specified data through the SCSI Write Buffer command to a target device (disk). It then reads the data back through the SCSI Read Buffer command and compares the data for errors. The test also compares the link status of the target before and after the read/write buffer test.
S 4 – Interactive Commands Diagnostics Menu (Command Line Options -kl, -kr, and -dm) 4. 6. The Configure Diagnostic Loopback Test Parameters or Configure Diagnostic Read/Write Buffer Test Parameters submenu appears. Select one of the following options: 1. Show Test Configuration. Type 1 to show the current parameter values. 2. Restore Test Configuration to Default. Type 2 to return all parameters to their default values. 3. Customize Test Configuration.
A 4 – Interactive Commands Diagnostics Menu (Command Line Options -kl, -kr, and -dm) Diagnostics Menu 1: 2: 3: Loopback Test Read/Write Buffer Test Transceiver details Note: 0 to return to Main Menu Enter Selection: 1 SANsurfer FC HBA CLI v1.x.
4 – Interactive Commands Diagnostics Menu (Command Line Options -kl, -kr, and -dm) S Test Continuous : OFF -------------------------------------------------------------Press to continue: SANsurfer FC HBA CLI v1.x.x Build x Configure Loopback Test Parameters 1: 2: 3: 4: 5: Show Test Configuration Restore Test Configuration to Default Customize Test Configuration Run Diagnostic Test Return to Diagnostics Test Menu Note: 0 to return to Main Menu Enter Selection: 3 SANsurfer FC HBA CLI v1.x.
A 4 – Interactive Commands Diagnostics Menu (Command Line Options -kl, -kr, and -dm) v1.x.x Build x Warning: The Diagnostic Loopback and Read/Write Buffer Tests require that the HBA has no outstanding input and output operations. Please make sure there is no active I/O before starting the test(s).
4 – Interactive Commands Diagnostics Menu (Command Line Options -kl, -kr, and -dm) S On Error : Ignore Test Continuous : OFF -----------------------------------------------------------------------Diagnostics - Read/Write Buffer Test Result -----------------------------------------------------------Hit to abort --------------------------------------------Iter No Data Pattern Status ------- ----------------------- --------------------------263 5B-57-4B-E5-29-D2-6A-1E Success 4.12.
A 4 – Interactive Commands Diagnostics Menu (Command Line Options -kl, -kr, and -dm) Value Status High Alarm High Warning Low Warning Low Alarm Temperature (C) -------------34.17 Normal 95.00 85.00 -5.00 -10.00 Voltage (V) ------3.33 Normal 3.63 3.56 3.04 2.97 Tx Bias (mA) ------5.86 Normal 9.00 8.50 2.00 2.00 Tx Power (mW) -------0.498 Normal 0.676 0.646 0.186 0.100 Rx Power (mW) -------1.174 Normal 4.000 2.832 0.200 0.100 4.12.3.
4 – Interactive Commands Diagnostics Menu (Command Line Options -kl, -kr, and -dm) S BR, max: 0x00 BR, min: 0x00 Vendor SN: AZ8P72890H23 Date code: 070709 Diag Monitoring Type:-Address change required: 0x0 -Power Measurement: 0x1 -Externally Calibrated: 0x0 -Internally Calibrated: 0x1 -Digital diag monitoring: 0x1 -Legacy diagnostic: 0x0 Enhanced Options:-Soft RATE_SELECT ctrl & monitoring: 0x0 -Soft RX_LOS monitoring: 0x1 -Soft TX_FAULT monitoring: 0x1 -Soft TX_DISABLE ctrl & monitoring: 0x0 -Alarm/warni
A 4 – Interactive Commands Diagnostics Menu (Command Line Options -kl, -kr, and -dm) Tx_I(Offset): 0x0000 Tx_PWR(Slope): 0x0000 Tx_PWR(Offset): 0x0000 T(Slope): 0x0000 T(Offset): 0x0000 V(Slope): 0x0000 V(Offset): 0x0000 Checksum: 0x63 Temperature MSB: 0x22 Temperature LSB: 0x2c Vcc MSB: 0x82 Vcc LSB: 0x21 TX Bias MSB: 0x0b TX Bias LSB: 0x76 TX Power MSB: 0x13 TX Power LSB: 0x77 RX Power MSB: 0x0b RX Power LSB: 0x7b Reserved MSB: 0x00 Reserved LSB: 0x00 Reserved MSB: 0x00 Reserved LSB: 0x00 Status/Control
4 – Interactive Commands Statistics Menu (Command Line Options -gs and -ls) S -Reserved Warning: 0x0 -Reserved Warning: 0x0 -Reserved Warning: 0x0 -Reserved Warning: 0x0 -RX Power Low Warning: 0x0 -RX Power High Warning: 0x0 Vendor Specific: 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 4.13 Statistics Menu (Command Line Options -gs and -ls) 13: Statistics The Statistics option allows you to view and change HBA and link statistics.
A 4 – Interactive Commands Statistics Menu (Command Line Options -gs and -ls) To change the HBA statistics: 1. From the Main Menu, type the number for the Statistics option, and then press ENTER. 2. From the Statistics Menu, type the number for the HBA Statistics option, and then press ENTER. 3. From the HBA Statistics Menu, type the number for the Configuration option, and then press ENTER. The HBA Statistics Settings Menu contains the following options: 4.
S 4 – Interactive Commands Statistics Menu (Command Line Options -gs and -ls) Table 4-10. HBA Port Statistics Options Parameter Name AutoPoll Alias Value Description AP 0 Turn on automatic updates of the HBA port statistics. 1–256 Turn on automatic updates of the HBA port statistics at a specified interval. Set the polling interval during automatic update (seconds). SetRate SR 5–30 LogToFile LF Log File Name Export the statistics to a file (CSV format). 4.13.1.1.
A 4 – Interactive Commands Statistics Menu (Command Line Options -gs and -ls) If you select the Manual Poll option, the system prompts you to enter a value for Manual Poll iteration: Manual Poll iteration (1-256) Enter a value from 1 to 256 and press ENTER. The system updates the Manual Poll iteration value and returns the following message: Manual Poll updated. 4.13.1.1.
4 – Interactive Commands Statistics Menu (Command Line Options -gs and -ls) S 3. From the HBA Statistics Menu, type the number for the Show HBA Statistics option, and then press ENTER. 4. The Statistics Menu appears and prompts you to select an HBA port. Type the number for the port, and then press ENTER. The HBA statistics for that port are shown.
A 4 – Interactive Commands Statistics Menu (Command Line Options -gs and -ls) Auto Poll Set Rate Log to file Table 4-11 shows the statistics and link status options. Table 4-11. Statistics/Link Status Options Parameter Name AutoPoll Alias Value AP 0 Description Update the link statistics automatically. 1–256 Update the link statistics up to a specified interval. SetRate SR 5–30 Set the Statistics Sampling Rate (seconds).
4 – Interactive Commands Statistics Menu (Command Line Options -gs and -ls) S Auto Poll Manual Poll If you select the Auto Poll option, the system enables Auto Poll and returns a message: Auto Poll enabled. If you select the Manual Poll option, the system prompts you to enter a value for Manual Poll iteration: Manual Poll iteration (1-256) Enter a value from 1 to 256 and press ENTER. The system updates the Manual Poll iteration value and returns the following message: Manual Poll updated. 4.13.2.
A 4 – Interactive Commands Virtual Menu (Command Line Option -vp) The Show Link Status option shows a menu of port numbers from which you can select the port for which you want the link status. To view the link status: 1. Type the number for the Statistics option, and then press ENTER. 2. The Statistics Menu appears. Type the number for the Link Status option, and then press ENTER. 3. The Link Status Menu appears. Type the number for the Show Link Status option, and then press ENTER. 4.
S 4 – Interactive Commands Virtual Menu (Command Line Option -vp) QLogic's SANsurfer FC HBA CLI for Windows works in conjunction with QLogic's N_Port ID Virtualization (NPIV)-capable Windows driver. NPIV is an ANSI T11 standard that describes how multiple unique fabric addresses (N_Port IDs) can share a single FC HBA physical port (N_Port) in SAN fabric topology. NPIV allows a physical HBA port to obtain N_Port IDs. The SANsurfer FC HBA CLI refers to these N_Port IDs as “virtual ports” (VPorts).
A 4 – Interactive Commands Virtual Menu (Command Line Option -vp) 4.14.1 Virtual Menu for HBA Instance 14: Virtual 1: Virtual Menu When you select this option, the Virtual Port Menu appears with the following options: List Virtual Ports Delete a Virtual port Create a Virtual port Enter the number for the option you want, and then press ENTER.
4 – Interactive Commands Virtual Menu (Command Line Option -vp) S List Virtual Ports including for each: Instance Number Virtual Port Number WWPN Status (Online or Loop Down) Here is an example: Virtual Menu HBA Model QLA2462: 0: VPort 3: WWPN: 21-00-7B-E0-8B-14-5A-CF Online 1: VPort 2: WWPN: 21-00-67-E0-8B-14-5A-CF Online 4: Return to Previous Menu 4.14.1.
A 4 – Interactive Commands Help Menu (Command Line Option -h) 4.14.1.3.1 Auto Generate 14: Virtual 1: Virtual Menu 3: Create a Virtual Port 1: Auto Generate When you select this option, the system creates a Virtual Port on this HBA physical port and reports the WWPN of the virtual port. For example: Virtual Port 21-00-25-E0-8B-14-5A-CF created successfully on HBA instance 4. To see the change to the virtual ports, you must manually refresh the configuration.
4 – Interactive Commands Help Menu (Command Line Option -h) S About Type the number for the option you want and press ENTER. 4.15.1 Contents 14 (or 15): Help 1: Contents When you select the Contents option, SANsurfer FC HBA CLI shows the entire Help menu. You can see the help menu options rearranged into alphabetical order in Appendix E. 4.15.2 Exit Codes 14 (or 15): Help 2: Exit Codes When you select the Exit Codes option, SANsurfer FC HBA CLI shows the entire list of exit codes.
Section 5 Non-interactive Commands 5.1 Introduction This section contains the information in the help (to view help, enter the command -h), plus additional explanation and examples. Each command line option is listed, followed by a command description and examples of the command in use and typical responses from the system. 5.2 Display System Information (Command Line Options -g, -z, and -tp) When you enter one of these options, general information appears in various formats.
S 5 – Non-interactive Commands Display System Information (Command Line Options -g, -z, and -tp) NOTE: The failover and SAN device management APIs are QLogic-specific libraries required for SANsurfer FC HBA CLI. The versions of these libraries are useful for debugging purposes. 5.2.2 Host Configuration (Command Line Option -z) The command line option -z shows all of the HBA’s information in a single command.
A 5 – Non-interactive Commands Display System Information (Command Line Options -g, -z, and -tp) 5.2.3 Host Topology (Command Line Option -tp) NOTE: Under Linux, host topology (-tp) is disabled if you are using the ioctl or sysfs (inbox) driver. The command format for Host Topology is: # scli -tp When you select this option, the SANsurfer FC HBA CLI tool shows the information in section 5.2.
S 5 – Non-interactive Commands Display System Information (Command Line Options -g, -z, and -tp) Port State Port Information Physical Port Number (switch port number), including: Port state Port type TX port type Port module type Attached Port (QLogic HBA, tape device, or disk device connected to the switch physical port), including: Target/initiator Node name Port name Vendor ID Product ID (if applicable) Product revision (if applicable) Product serial
A 5 – Non-interactive Commands Command Summary Table 5-1. Options Shown by -z (Continued) CLI Description Show HBA information (VPD information for QLA/QLE24xx -i See Section 5.3.15 only) -l Show LUN list 5.3.19 -m Configure selective LUNs 5.3.21 -p Configure target persistent binding 5.3.24 -t Show target list 5.3.29 5.
S 5 – Non-interactive Commands Command Summary You can use either the hyphen (-) character or the forward slash (/) character. For example, both of these commands are valid: scli -g scli /g Table 5-2 defines the command variables. . Table 5-2.
A 5 – Non-interactive Commands Command Summary To view the HBA port’s LED Beacon state, type: # scli -a ( | )(view | ?) When the HBA’s LED is flashing, the following message appears: HBA Port x - LED Flashing is ON. When the HBA’s LED is not flashing, the following message appears: HBA Port x - LED Flashing is OFF. In Solaris SPARC, include double quotes around the question mark (?) if the system is running with a csh or tsch shell.
S 5 – Non-interactive Commands Command Summary HBA Instance = HBA number (use -g command to find) HBA WWPN = World wide port name -rg = Flash region update mode (4GB HBAs onlya): fw = Update firmware only boot = Update bootcode only (BIOS/FCode/EFI image) all = Update all regions (BIOS/FCode/EFI) depending on the Flash image. BIOS/FCode File = Name or path of file continuing update BIOS/FCode Name a Region update only supported on QLA/QLE/QMC246x HBAs.
A 5 – Non-interactive Commands Command Summary Where: File Name = Absolute or full path name of the setup INF file or the compressed driver file in ZIP or EXE format. The binary image of the device driver must reside in the same absolute or full path location. For example: scli -d c:\temp\ql2300\qlxxx.inf 5.3.5 -dm (Display Diagnostics Monitoring Info) This option allows you to show general or detailed Digital Diagnostic Monitoring Interface for optical transceivers.
S 5 – Non-interactive Commands Command Summary In these commands: HBA Instance = HBA number (use -g command to find) HBA WWPN = World wide port name of the HBA Target WWNN = World wide node name of the target Target WWPN = World wide port name of the target Target ID = ID to which the target is bound LUN ID = ID of the LUN To view the current boot device selection on all HBAs: # scli -e (view | ?) To view the current boot device selection for a specific HBA: # scli -e ( | ) (view
A 5 – Non-interactive Commands Command Summary To cause the OS to boot from the first target it finds with a LUN, select a boot port name of 00-00-…00 (selectable boot); this applies only if the boot BIOS is enabled.
5 – Non-interactive Commands Command Summary S 5.3.7 -ei (List SANsurfer FC HBA CLI Error Codes) This command lists the SANsurfer FC HBA CLI error codes as shown in Appendix D. 5.3.8 -f (Input Parameter Options from a Text File) NOTE: The -f option is valid only in non-interactive mode, and cannot be combined with any other options. Only one command line parameter per file is valid. This option is used when it is run as a script file.
A 5 – Non-interactive Commands Command Summary 5.3.9 -fg (Show Driver Settings) NOTE: The -fg option is valid only in non-interactive mode. To show the driver settings, type: # scli -fg ( | ) (view | ?) Where: HBA Instance = HBA number (use -g command to find) HBA WWPN = World wide port name of the HBA 5.3.
S 5 – Non-interactive Commands Command Summary Table 5-3.
A 5 – Non-interactive Commands Command Summary Where: HBA Instance = HBA number (use -g command to find) HBA WWPN = World wide port name of the HBA Parameter Name = Name of the parameter (see table 4-7) Parameter Alias = Alias of the parameter (see table 4-7) Parameter Value = New value of the parameter (see table 4-7) Table 5-4 lists the HBA statistics parameter names, aliases, and values. Table 5-4.
S 5 – Non-interactive Commands Command Summary Command Line QLogic FC Host Bus Adapters scli -l ( | ) - shows LUN information for all HBAs. scli -l ( | ) (| ) - shows LUN information for a specific target scli -l ( | ) (| ) - shows LUN information for a specific LUN on a specific target NOTE: To view the current version information for SANsurfer FC HBA CLI, use the -v option section 5.3.
A 5 – Non-interactive Commands Command Summary 5.3.
S 5 – Non-interactive Commands Command Summary Parameter Name = One of the following: DataPattern (see 5.3.16.1) DataSize (see 5.3.16.2) TestCount (see 5.3.16.3) TestIncrement (see 5.3.16.4) OnError (see 5.3.16.5) Parameter Alias = One of the following: DP (see 5.3.16.1) DS (see 5.3.16.2) TC (see 5.3.16.3) TI (see 5.3.16.4) OE (see 5.3.16.5) Parameter Value = Value for selected parameter Sections 5.3.16.1 through 5.3.16.
A 5 – Non-interactive Commands Command Summary Table 5-5. Data Pattern Values Hex Binary 00h 00000000 55h 01010101 5Ah 01011010 A5h 10100101 AAh 10101010 FFh 11111111 Random Customized (00–FF) CRPAT (loopback test only) CJTPAT (loopback test only) CSPAT (loopback test only) Table Notes Complaint random data pattern in a valid FC frame, as defined by the ANSI document Methodologies for Jitter and Signal Quality Specification - MJSQ Annex A - Test bit sequences.
S 5 – Non-interactive Commands Command Summary Loopback test (Linux systems). The data size can be 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, or 65535. The default value is 512 bytes. 5.3.16.3 TestCount (TC) The number of loopback tests is either: TC TestCount For a read/write buffer test, the number of tests run must be in the range of 0–10000. For a loopback test, the number of tests run must be in the range of 0–65535.
A 5 – Non-interactive Commands Command Summary Table 5-6. OnError Values Value Description 0 The error is ignored. This is the default value. 1 The test stops on error. 2 On error, the data pattern and test repeat until the error is cleared. 5.3.16.6 Run a Loopback Test The loopback test sends and receives messages, through a loopback or through an echo command, to the switch. NOTE: The loopback test is disabled if you are using the drivers from the OS installation.
S 5 – Non-interactive Commands Command Summary # scli --kl ( | ) To do a loopback test with custom parameters, type: # scli --kl ( | ) [( | ) ] Section 5.3.16 describes the parameters and their default values. The following examples do 500 loopback tests with a test increment of 10, a data pattern of FFh, and a data size of 8 bytes. The test stops if an error occurs.
A 5 – Non-interactive Commands Command Summary Error – CRC, disparity, or frame length errors occurred. Failed – An error occurred when attempting to issue a command. Loop down – The loop is down. CRC – Number of CRC errors. Disparity – Number of disparity errors. Frame Length – Number of frame length errors. -kl ( | ) [{( | ) }] 5.3.
S 5 – Non-interactive Commands Command Summary Where: HBA Instance = HBA number (use -g command to find) HBA WWPN = World wide port name of the HBA -EX or -EXCLUDE = World wide port name of the target device that is Target WWPN excluded from the read/write test Parameter Name = One of the following: DataPattern (see section 5.3.16.1) DataSize (see section 5.3.16.2) TestCount (see section 5.3.16.3) TestIncrement (see section 5.3.16.4) OnError (see section 5.3.16.
A 5 – Non-interactive Commands Command Summary # scli -kr ( | ) To exclude a device or devices on the selected HBA port, type: # scli -kr (|) [(-EX | -EXCLUDE) ] [( | ) ] Sections 6.17.0.0.1 through 6.17.0.0.5 describe the parameters and their default values. The following examples do 500 read/write buffer tests with a test increment of 10, a data pattern of FFh, and a data size of 8 bytes.
S 5 – Non-interactive Commands Command Summary 5.3.18.2 Run HBA Diagnostics Read-write Buffer Test The {(-ex | exclude) } parameters specify a device that will be excluded from the read/write buffer test. The system shows the following information after a read/write buffer test completes: Loop ID/status Data miscompare Link failure Loss of sync Loss of signal Invalid CRC Table 5-8 lists the , , and options. Table 5-8.
A 5 – Non-interactive Commands Command Summary b Complaint random data pattern in a valid FC frame, as defined by the ANSI document Methodologies for Jitter and Signal Quality Specification - MJSQ Annex A - Test bit sequences. c Complaint jitter tolerance pattern in a FC frame, as defined by the ASIC document listed above. d Supply noise test sequence in a valid FC frame, as defined by the ASIC document listed above. e For read/write buffer test, the maximum size is 128; this is also the default.
5 – Non-interactive Commands Command Summary S Write buffer failed Link Failure – Number of link failures Loss of sync – Number of sync loss errors Loss of signal – Number of signal loss errors Invalid CRC – Number of invalid CRCs 5.3.
A 5 – Non-interactive Commands Command Summary Where: HBA Instance = HBA number (use -g command to find) HBA WWPN = World wide port name of the HBA Parameter Name = Name of the parameter (see Table 5-10) Parameter Alias = Alias of the parameter (see Table 5-10) Parameter Value = New value of the parameter (see Table 5-10) Table 5-10 defines the link status parameter names, aliases, and values. Table 5-10.
S 5 – Non-interactive Commands Command Summary Disable (deselect) a LUN on a specific target on a specific HBA (5) Enable all LUNs on a specific target on a specific HBA (6) Disable (deselect) all LUNs on a specific target on a specific HBA (7) Enable (select) all LUNs of all targets on a specific HBA (8) Disable (deselect) all LUNs of all targets on a specific HBA (9) For these commands: HBA Instance = HBA number (use -g command to find) HBA WWPN = World wide port name of the HBA Target WWNN
A 5 – Non-interactive Commands Command Summary # scli -m ( | ) { (0 | disable | deselect)} NOTE: To select multiple LUNs in the same command, repeat the following sequence: 0 To enable (select) all LUNs for a specific target on a specific HBA, type: # scli -m ( | ) select | enable To disable (deselect) all LUNs for a specific target on a specific HBA, type
S 5 – Non-interactive Commands Command Summary Table 5-11 lists the HBA parameter names and aliases. . Table 5-11.
A 5 – Non-interactive Commands Command Summary b Data Rate (QLA23xx/QLA24xx/QLE23xx/QLE24xx HBAs): 0 – 1 Gbs 1 – 2Gbs 2 – Auto 3 – 4 Gbs c EnableBIOS option not available on 4Gb HBA. d EnableExtendedLogging option not available on PPC64 or SPARC.
S 5 – Non-interactive Commands Command Summary 5.3.24 -p (Display Persistent Target Binding Info) With this command you can: Show binding information for one or on all HBAs (1) Bind a specific target to a selected HBA (2) Bind all targets on a specific HBA or on all HBAs (3) Unbind a specific target (4) Unbind all targets on a specific HBA or on all HBAs (5) NOTES: Under Solaris, if you use the driver from the OS installation CDs (QLC driver), these features are disabled.
A Yes Yes 5 – Non-interactive Commands Command Summary Disk xx-xx-xx-xx-xx-xx-xx-xx Disk xx-xx-xx-xx-xx-xx-xx-xx Press to continue: xx-xx-xx-xx-xx-xx-xx-xx xx-xx-xx-xx-xx-xx-xx-xx 10-02-E4 10-02-E8 1 2 To bind a selected target to a specific HBA, type: # scli -p ( | ) ( ) Where: HBA Instance = HBA number (use -g command to find) HBA WWNN = Word wide node name of the HBA HBA WWPN = World wide port name of the HBA Ta
S 5 – Non-interactive Commands Command Summary Where: HBA Instance = HBA number (use -g command to find) HBA WWPN = World wide port name of the HBA 5.3.
A 5 – Non-interactive Commands Command Summary Where: HBA Instance = HBA number (use -g command to find) HBA WWPN = World wide port name of the HBA all = Reports link speed for all targets on all HBAs in the system -targets = All Targets -t all targets To view the link speed of a specific Target attached to an HBA, type the following command: # scli -q ( | | Where: HBA Instance = HBA number (use -g command to find) HBA WWPN = World wide port name of the HBA Target
S 5 – Non-interactive Commands Command Summary 5.3.
A 5 – Non-interactive Commands Command Summary 5.3.
S 5 – Non-interactive Commands Command Summary NOTES: The <0 | ON> option flashes the LED until interrupted. The <1 | PRESET> option flashes the LED 12 times. This feature is supported only on JBOD devices. 5.3.31 -tp (Display Host Topology) Use the -tp option to show the topology configuration of the host: # scli -tp | topology Under Linux, this feature is disabled if you are using the ioctl or sysfs (inbox) driver. Section 5.2.3 covers this command. 5.3.
A 5 – Non-interactive Commands Command Summary Where: HBA Instance = HBA number (use -g command to find) HBA WWPN = World wide port name of the HBA vport WWPN = World wide port name of the virtual port vport hex = World wide port name of the virtual port with the two hex digits in byte three supplied by the user To list a specific virtual port on a physical HBA port, type: # scli -vp ( : ) list To create a virtual port with an automatic WWPN, type: # scli -vp (
5 – Non-interactive Commands Command Summary S 5.3.35 -x2 (Output in XML Format 2) NOTE: This option is valid only in non-interactive mode. You can use this option with all non-interactive mode options that have a corresponding interactive mode option (see Table 5-1). This option must be the first or last command in the command line. When you use this option, the system shows all result and status messages in XML format 2, standard XML format. These formats are described in Appendix B.
Appendix A XML Format 1 A.1 Introduction NOTE: XML files created using the -x1 command line option do not match standard output. They are designed for backward compatibility with customized legacy scripts. For new scripts, we strongly recommend using the -x2 command line option, which generates standard output XML files (see Appendix B). The -x1 command line option (see section 5.3.34) displays all output in XML format 1.
A – XML Format 1 XML Format 1 Tags for Each Option S A.1.3 Status Message Before the closing main tag , SANsurfer FC HBA CLI displays returning status from the execution of the command line parameters and the error messages.
A A – XML Format 1 XML Format 1 Tags for Each Option A.2.1 Display System Information (Command Line Option -g) The XML format 1 for system information output is as follows: SANsurfer FC HBA CLI vn.nn.
S A – XML Format 1 XML Format 1 Tags for Each Option PortDownRetryCount="value" EnableLipFulllogin="value" LinkDownTimeout="value" EnableTargetReset="value" LUNsPerTarget="value" /> 0 0 For clarity, each parameter is listed on a separate line; however, multiple parameters can be on the same line. For multiple adapters, repeat the above sequence with the ID number (ID Number="value") of the next adapter. A.2.
A A – XML Format 1 XML Format 1 Tags for Each Option PortType="value" Status="value" 0 0 Here is the information for the 4G HBAs: SANsurfer FC CLI vn.nn.nn Build n.
S A – XML Format 1 XML Format 1 Tags for Each Option 0 0 A.2.4 Display Device List (Command Line Option -t) The XML Format 1 for adapter device information is as follows:
A A – XML Format 1 XML Format 1 Tags for Each Option A.2.5 Display LUN List (Command Line Option -l) The XML Format 1 for the adapter LUN list information is as follows: SANsurfer FC HBA CLI vn.nn.
S A – XML Format 1 XML Format 1 Tags for Each Option 0 0 The sequence is repeated for each target bound to the adapter. A.2.7 Selective LUNs (Command Line Option -m) The XML Format 1 for the selective LUNs information is as follows: SANsurfer FC HBA CLI vn.nn.
A A – XML Format 1 XML Format 1 Tags for Each Option 0 The sequence is repeated for each boot device of the adapter. In Windows and Linux, the TargetID="value" field is not present. A.2.9 Diagnostics Results –Loopback Test (Command Line Option -kl) The XML Format 1 for the loopback test results is as follows: SANsurfer FC HBA CLI vn.nn.
S A – XML Format 1 XML Format 1 Tags for Each Option The sequence is repeated for each device attached to the adapter. A.2.11 View Driver Settings (Command Line Option -fg) The XML Format 1 for the current driver settings information is as follows: SANsurfer FC HBA CLI vn.nn.
A A – XML Format 1 XML Format 1 Tags for Each Option Table A-1. Options Displayed by -z (Continued) Non-interactive Option Description Section -p Target persistent binding 4.6 -m Selective LUNs 4.7 -E Boot device 4.8 The XML Format 1 for all adapter information is as follows: SANsurfer FC HBA CLI vn.nn.
A – XML Format 1 XML Format 1 Tags for Each Option S
A A – XML Format 1 XML Format 1 Tags for Each Option BindbyPortID="value" /> 0 0 NOTES: The … sequence is repeated for each HBA. The … sequence is repeated for each target. The parameter is repeated for each LUN. The parameter is repeated for each enabled LUN. The parameter is repeated for each target persistent binding entry.
A – XML Format 1 XML Format 1 Tags for Each Option S SANsurfer FC HBA CLI vn.nn.nn Build nn 0 0 A.2.
A A – XML Format 1 XML Format 1 Tags for Each Option 0 0 A.2.17 SFF DMI (Command Line Option -dm) The XML Format 1 for SFF DMI (general information) is as follows: SANsurfer FC HBA CLI vn.nn.
S A – XML Format 1 XML Format 1 Tags for Each Option (mA) "value" "value" "value" "value" "value" "value" (mW) "value" "value" "value" "value" "value" "value"
A A – XML Format 1 XML Format 1 Tags for Each Option "value" "value" "value" "value" "value" "value" "value" "value" "value"
S A – XML Format 1 XML Format 1 Tags for Each Option "value" 0x7d "value" "value" "value" "value" "value" "value" "value" "value"
A A – XML Format 1 XML Format 1 Tags for Each Option "value" "value" "value" "value" "value" "value" "value" "value" "value" "value" "value"
S A – XML Format 1 XML Format 1 Tags for Each Option A.2.18 Host Topology (Command Line Option -tp) The XML Format 1 for an HBA type interconnect element is as follows: SANsurfer FC HBA CLI vn.nn.
A A – XML Format 1 XML Format 1 Tags for Each Option DriverVersion="value" FirmwareVersion="value" TotalNumberOfDevices="value" Host="value"/> ... ... ... ...
A – XML Format 1 XML Format 1 Tags for Each Option S 0 0 A-22 SN0054614-00 F
Appendix B XML Format 2 B.1 Introduction NOTE: XML files created using the -x2 command line option match standard output. They do not match the X1 files which are designed for backward compatibility with customized legacy scripts. If you are developing new scripts, we strongly recommend using the -x2 command line option which generates standard output XML files (see Appendix A). The -x2 command line option (see section 5.3.35) displays all output in XML Format 2.
S B – XML Format 2 Status Message B.4 Status Message Before the closing main tag , SANsurfer FC HBA CLI displays any returning status from the execution of the command line parameters and the error messages.
A B – XML Format 2 XML2 Tags for Each Option scli -c 0 -x2 The XML Format 2 for adapter settings information is as follows: SANsurfer FC HBA CLI vn.n.nn Build nnn.
S B – XML Format 2 XML2 Tags for Each Option # scli -dm ( | | ) (general | gen) -x2 The XML Format 2 for the boot device information is as follows: SANsurfer FC HBA CLI vn.n.nn Build nnn.
A B – XML Format 2 XML2 Tags for Each Option (mW) "value" "value" "value" "value" "value" "value" (mW) "value" "value" "value" "value" "value" "value"
B – XML Format 2 XML2 Tags for Each Option S "value" "value" "value"
A B – XML Format 2 XML2 Tags for Each Option "value" "value" "value" "value" "value" "value" "value" "value" "value" "value" "value"
S B – XML Format 2 XML2 Tags for Each Option "value" "value" "value" "value" "value" "value" "value" "value" "value" "value" "valu
A B – XML Format 2 XML2 Tags for Each Option -e ( | ) (view | ?) -x2 The XML Format 2 for the boot device information is as follows: SANsurfer FC HBA CLI vn.n.nn Build nnn.
S B – XML Format 2 Display System Information (Command Line Option -g) B.7.4 View Driver Settings (Command Line Option -fg) The command format is: scli -fg ( | ) (VIEW | ?) -x2 The XML Format 2 for the current driver settings information is as follows: SANsurfer FC HBA CLI vn.n.nn Build nnn.
A B – XML Format 2 Display System Information (Command Line Option -g) n n "message" n /Reboot> The parameter repeats for each HBA in the system. B.8.
B – XML Format 2 Display System Information (Command Line Option -g) S n n /Reboot> The XML Format 2 for 4G HBAs is as follows: SANsurfer FC HBA CLI vn.n.n Build n 2.
A B – XML Format 2 Display System Information (Command Line Option -g) 0 0 B.8.
S B – XML Format 2 Display System Information (Command Line Option -g) scli -kr ( | ) [(-EX | -EXCLUDE) ] ( | ) -x2 The XML Format 2 for the read/write buffer test results is as follows: SANsurfer FC HBA CLI vn.n.nn Build nnn.
A B – XML Format 2 Display System Information (Command Line Option -g) Vendor="value" Product="value" Revision="value" Size="value" Type="value" /> n n /Reboot> The sequence repeats for each LUN attached to the target. The LUN list is listed under the target, not under the adapter. B.8.
S B – XML Format 2 Display System Information (Command Line Option -g) scli -p ( | | all) (view | ?) -x2 The XML Format 2 for the adapter target persistent binding information is as follows: SANsurfer FC HBA CLI vn.n.nn Build nnn.
A B – XML Format 2 Display System Information (Command Line Option -g) DeviceID= "value" PortID= "value" LunCount= "value" Type= "value" DeviceStatus= "value" /> n n /Reboot> The … sequence repeats for each target. The … sequence repeats for each HBA. B.8.
S B – XML Format 2 Display System Information (Command Line Option -g) SANsurfer FC HBA CLI vn.n.nn Build nnn.
A B – XML Format 2 Display System Information (Command Line Option -g) OperationMode="value" IntDelayTimer="value" ExecutionThrottle="value" LoginRetryCount="value" EnableLipReset="value" PortDownRetryCount="value" EnableLipFulllogin="value" LinkDownTimeout="value" EnableTargetReset="value" LUNsPerTarget="value" /> Target WWNN Target WWPN PAGE 224S B – XML Format 2 Display System Information (Command Line Option -g) NOTES: The … sequence repeats for each HBA. The sequence repeats for each HBA. The sequence repeats for each HBA. The … sequence repeats for each target. The sequence repeats for each LUN. The sequence repeats for each enabled LUN. The sequence repeats for each target persistent binding entry.
A B – XML Format 2 Display System Information (Command Line Option -g) The parameter repeats for each link. B.8.10 HBA Statistics (Command Line Option -gs) The command format is: scli -gs ( | ) [( | ) ] -x2 The XML Format 2 for the HBA statistics option is as follows: SANsurfer FC HBA CLI vn.n.nn Build nnn.
S B – XML Format 2 Display System Information (Command Line Option -g) n n /Reboot> B.8.12 HBA Port Alias (Command Line Option -pa) The command format is: scli -pa ( | ) view | ? -x2 The XML Format 2 for the HBA port alias option is as follows:
A B – XML Format 2 Display System Information (Command Line Option -g) "value" "value" "value" (C) "value" "value" "value" "value" "value" "value" (V) "value"
B – XML Format 2 Display System Information (Command Line Option -g) S 0 0 B.8.13 Host Topology (Command Line Option -tp) The command format is: scli -tp -x2 The XML Format 2 for an HBA type interconnect element is as follows (this example shows a switch): SANsurfer FC HBA CLI vn.n.nn Build nnn.
A B – XML Format 2 Display System Information (Command Line Option -g) PortAlias="value" DriverVersion="value" FirmwareVersion="value" Host="value"/> ...
B – XML Format 2 Display System Information (Command Line Option -g) S Notes B-26 SN0054614-00 F
Appendix C Interactive Exit Codes To list the exit codes while running SANsurfer FC HBA CLI in interactive mode: 1. From the Main Menu, select the Help option and then press ENTER. 2. On the Help Menu, select Exit Codes and then press ENTER. The CLI lists the exit code numbers, names, and descriptions as shown in Table C-1. (To see non-interactive error codes, see Appendix D.) NOTE: Exit codes are continually being updated.
S C – Interactive Exit Codes Table C-1.
A C – Interactive Exit Codes Table C-1.
S C – Interactive Exit Codes Table C-1.
A C – Interactive Exit Codes Table C-1.
S C – Interactive Exit Codes Table C-1.
A C – Interactive Exit Codes Table C-1.
S C – Interactive Exit Codes Table C-1.
A C – Interactive Exit Codes Table C-1.
S C – Interactive Exit Codes Table C-1.
A C – Interactive Exit Codes Table C-1.
S C – Interactive Exit Codes Table C-1.
Appendix D Non-interactive Error Codes To list the SANsurfer FC HBA CLI non-interactive error codes from the command line, type: scli -ei (To see the interactive exit codes, see Appendix C.) Table D-1.
S D – Non-interactive Error Codes Table D-1.
A D – Non-interactive Error Codes Table D-1.
S D – Non-interactive Error Codes Table D-1.
A D – Non-interactive Error Codes Table D-1.
S D – Non-interactive Error Codes Table D-1.
A D – Non-interactive Error Codes Table D-1.
S D – Non-interactive Error Codes Table D-1.
A D – Non-interactive Error Codes Table D-1.
S D – Non-interactive Error Codes Table D-1.
A D – Non-interactive Error Codes Table D-1.
S D – Non-interactive Error Codes Table D-1.
Appendix E Help Commands Table E-1 is an alphabetic listing of the Help commands. Unless otherwise noted, only one command line option per input file is valid. The hyphen (-) and slash (/) characters are equivalent. That is, scli -g and scli /g are both valid commands. Table E-1 uses the following variables: HBA instance number of an HBA port. World Wide Port Name of an HBA port. (xx-xx-xx-xx-xx-xx-xx-xx or xxxxxxxxxxxxxx).
S E – Help Commands Table E-1. Help Commands (Continued) Command Line Action –b Arguments Function ( | | ) [ ( <–rg> ) ] Updates the HBA boot code from a file, where: <–rg> Specifies Option ROM region update mode. Updates the flash from a full image file (1MB image file). Updates the firmware image only from a firmware file. Updates the boot code (BIOS/Fcode/EFI) image only from a boot code file.
A E – Help Commands Table E-1. Help Commands (Continued) Command Line Action Arguments Function –e ( | ) ( view | ? ) Shows the current boot device information on an HBA port. –e ( | ) ( view | ? ) Shows the current boot device information on an HBA port. –e ( | ) disable [ prim | alt1 | alt2 | alt3 ] Clears the selected current boot device settings on an HBA port (prim/alt1/alt2 or alt3 Boot Port Name).
S E – Help Commands Table E-1. Help Commands (Continued) Command Line Action Arguments Function –fs ( | ) { ( | ) } Configures the driver settings. –gs ( | ) { ( | ) } Shows the current statistics on an HBA port. –h | –? – Lists all the command options and syntax.
A E – Help Commands Table E-1. Help Commands (Continued) Command Line Action Arguments Function –ls ( | ) { ( | ) } Shows the current link status on an HBA port. –m ( | ) ( view | ? ) Views selective LUN information of all devices attached to an HBA port.
S E – Help Commands Table E-1. Help Commands (Continued) Command Line Action Arguments Function –p ( | ) { } Binds the selected device(s) attached to an HBA port. –p ( | ) remove | unbind Unbinds a specific device attached to an HBA port.
A E – Help Commands Table E-1. Help Commands (Continued) Command Line Action Arguments Function –s – Suppresses the output. This option can be combined with other options. However, this option must be at the beginning or at the end of the command line. –t ( | ) Displays the information about devices (disks or tapes) attached to an HBA port.
S E – Help Commands Table E-1. Help Commands (Continued) Command Line Action Arguments Function –x — Writes the output in XML format 1. Option –x can be used to generate an old-style format that is compatible with previous releases (XML format 1). This option can be combined with other options; however, this option must be at the beginning or at the end of the command line. –x2 — Writes the output in XML format 2.
Glossary adapter See HBA. AL_PA Arbitrated Loop_Physical Address. A low-level address on the FC loop. arbitrated loop A circular (ring) topology (versus point-to-point) where two or more ports can be interconnected, but only two ports can communicate at a time. All communication passes through all ports connected to the loop.
SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters driver The software that interfaces between the file system and a physical data storage device or network media. The level structure for Windows XP Professional/2000/Windows Server 2003 drivers is as follows: Class Driver. The highest driver level. There is a separate class for disk, Ethernet, and so forth. This level handles all generic aspects of operations for that class. Port Driver.
A SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters F_Port The “Fabric” port in a FC fabric switch provides a point-to-point link attachment to a single N_Port. F_Ports are intermediate ports in virtual point-to-point links between end ports, for example N_Port to F_Port to F_Port to N_Port using a single FC fabric switch. fabric A fabric consists of cross-connected FC devices and switches. fabric switch Also, Switched Fabric.
SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters IOCB I/O control block. An IOCB is a command structure in QLogic ISP architecture. ioctl (input/output control) A system call in Unix/Linux systems. Allows an application to control or communicate with a device driver outside usual read/write operations. JBOD (Just a Bunch of Disks) As opposed to a SAN. See SAN (Storage Area Network). L_Port (Loop Port) Does arbitrated loop functions and protocols.
A SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters N_Port ID Virtualization The ability for a single physical FC end point (N_Port) to support multiple, uniquely addressable, logical end points. With NPIV, a host FC adapter is shared in such a way that each virtual adapter is assigned to a virtual server and is separately identifiable within the fabric.
SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters N_Port (Node Port)—an FC port that supports point-to-point topology. NL_Port (Node Loop Port)—an FC port that supports loop topology. F_Port (Fabric Port)—a port in a fabric where an N_Port can attach. FL_Port (Fabric Loop Port)—a port in a fabric where an NL_Port can attach. port instance The number of the port in the system.
Index A -a 4-61, 5-6 abort changes to HBA parameters 4-29 about the product 4-88 adapter, definition of Glossary-1 Adjunct driver level, definition of Glossary-2 AL_PA, definition of Glossary-1 alias HBA 5-6, A-14 HBA information 4-18 HBA port 4-19 arbitrated loop, definition of Glossary-1 Arbitrated Loop_Physical Address, definition of Glossary-1 attached port definition of 4-4 viewing details 4-5 attaching loopback connector 4-65 auto poll, See automatic polling auto-generating a virtual port 4-87 automat
SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters commands interactive mode 4-1 non-interactive mode 2-3, 5-1, 5-5 -a 4-61, 5-6 -b 4-8, 4-56, 5-7 -c 4-18, 4-22, 5-8, A-3, B-2 -d 4-60, 5-8 -dm 4-62, 4-72, 5-9, A-15, B-3 -e 4-51, 5-9, A-8, B-8 -ei 5-12, D-1 -f 5-12 -fg 4-54, 5-13, A-10, B-10 -fs 5-13 -g 4-2, 5-1, A-3, B-10 -gs 4-76, 5-14, A-13, B-21 -h 4-87, 5-15 -ha 4-18, 5-16, A-14, B-21 -i 4-17, 4-18, 5-17, A-4, B-11 -kl 4-62, 4-63, 5-17, 5-21, A-9, B-13 -
A SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters DataSize parameter 5-26 default restoring 4-78 restoring for link 4-81 defining port alias 5-36 definitions of terms Glossary-1 delay timer, interrupt 4-23, 4-27 delay, loop reset 4-23 deleting virtual port 4-86 device configuring boot 4-53 definition of Glossary-1 list, viewing A-6, B-16 diagnostics configuration settings 4-62 loopback test 4-63, A-9 loopback test results B-13 parameters 5-26 port 4-63 r
S SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters enabling LUNs 5-29 error codes interactive mode C-1 listing 5-12 non-interactive mode D-1 error message XML Format 1 A-2 XML Format 2 B-2 execution throttle 4-23, 4-27 ExecutionTrottle parameter 5-32 exit codes, interactive mode 4-88, C-1 extended logging, enabling 5-32 F -f 5-5, 5-12 F_Port, definition of Glossary-3 fabric port (F_Port), definition of Glossary-3 fabric switch, definition of Glossary-3 f
A SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters HBA (continued) hard loop ID 4-23 host information, viewing 4-2 iiDMA settings 4-45 information 4-17, 4-18, 5-2 viewing 5-17, A-4, A-10, B-11, B-17 viewing all 5-42 viewing by port number 4-18 instance 5-6 locating (beacon LED) 4-61 parameters 4-21 aborting changes to 4-29 configuring 4-23 displaying 4-22 names and aliases 5-32 restoring defaults 4-29 saving 4-57 settings, viewing 5-8 template 4-57 templa
SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters installation (continued) Solaris 3-8 Solaris SPARC 8, 9, 10 3-8 Solaris x86 9, 10 3-9 Windows 3-2 instance number 5-6 port, definition of Glossary-6 interactive mode 4-1 See also non-interactive mode definition of 2-1 exit codes 4-88, C-1 starting 2-1, 4-1 interconnect element, viewing details 4-4 interrupt delay timer 4-23, 4-27 InterruptDelayTimer parameter 5-32 IOCB, definition of Glossary-4 ioctl (input/
A SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters loop preferred connection 4-25 reset delay 4-23, 4-26 loop (abitrated), definition of Glossary-1 loop ID, definition of Glossary-4 Loop Initialization Process (LIP), definition of Glossary-4 Loop Port (L_Port), definition of Glossary-4 loopback, definition of Glossary-4 loopback connector, attaching 4-65 loopback test 4-64, 5-17 after completing 4-66 example of 5-22 preparing for 4-65 results A-9, B-13 ru
SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters non-interactive mode (continued) error codes D-1 starting 2-3 Non-volatile Random Access Memory (NVRAM), definition of Glossary-5 NPIV (N_Port ID Virtualization) Virtual Menu option 4-83 NPIV, definition of Glossary-4 number of tests parameter 5-20, 5-26 NVRAM, definition of Glossary-5 O -o 5-5, 5-33 OE parameter 5-20, 5-26 ONC, definition of Glossary-5 OnError parameter 5-20, 5-26 Open Network Computing (O
A SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters port driver, definition of Glossary-2 PortDownRetryCount parameter 5-32 Q -q 4-38, 5-36 QLA/QLE/QEM HBAs supported by 1-4 QLA/QLE24xx 5-5 QLA23xx 4-23, 5-21 QLA24xx 5-21 QLA24xx HBA, VPD 4-20 QLE23xx 4-23, 5-21 QLE24xx 5-21 QLE24xx HBA, VPD 4-20 QLogic technical support hours 1-8 R -r 4-57, 5-38 rate, data 4-25 read/write buffer test 4-66 results A-9, B-13 running 4-67, 5-23, 5-24 reboot message XML For
SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters show HBA information 5-5 HBA settings 5-4 link status 4-82 LUN list 5-5 parameter settings 5-8 system information 5-4 target list 5-5 silent mode 5-5, 5-38 size, frame 4-25 Small Computer System Interface (SCSI), definition of Glossary-6 software requirements 1-6 Solaris installing on 3-8 operating systems supported by SANsurfer FC HBA CLI 1-4 SPARC driver structure Glossary-2 target ID 5-11 uninstalling fro
A SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters test count parameter 5-20 diagnostics loopback 4-63 increment parameter 5-20 loopback 4-64 loopback, preparing for 4-65 number of tests parameter 5-20, 5-26 pattern 5-26 read/write buffer 4-66, 5-23 results, loopback and read/write buffer 4-64 TestCount parameter 5-26 TestIncrement parameter 5-26 .
SANsurfer FC HBA CLI User’s Guide Command Line Interface for QLogic Fibre Channel Host Bus Adapters S W Windows driver level structure Glossary-2 installing on 3-2 operating systems supported by SANsurfer FC HBA CLI 1-4 uninstalling from 3-13 Windows Virtual Server environment 4-84 WWPN, bind by WWPN parameter 5-14 X -x 4-8, 5-5, 5-41 -x1 A-1 -x2 4-9, 5-42 XML file, saving as 4-8 Format 1 4-8, 5-41, A-1 Format 2 4-9, 5-42, B-1 .