Q-Logic FC HBA CLI manual

SANsurfer FC HBA CLI User’s Guide

Command Line Interface for QLogic Fibre Channel Host Bus Adapters

Notes

S

Page x

SN0054614-00 F

Image 10

Q-Logic FC HBA CLI manual

Contents

SANsurfer FC HBA CLI User’s Guide Document Revision History Changes Sections Affected Revision F Changes Added Appendix B XML Format Revision E Changes Section Following options and commands were added in Rev. E Following options and commands were changed in Rev. E SN0054614-00 F Revision D Changes Following options and commands were changed in Rev. D Page Page Table of Contents Section Interactive Commands SN0054614-00 F SN0054614-00 F Section Non-interactive Commands Appendix a XML Format Appendix B XML Format SN0054614-00 F List of Figures List of TablesPage Guide Overview Product OverviewHow this Guide is Organized Documentation Conventions Topology General Information Supported QLogic HBAs Supported Operating Systems System Requirements Hardware Requirements Unsupported Features Software Requirements Features Not Available When Running VMware Driver Features Not Available When Running ioctl Module DriverFeatures Not Available When Running Sysfs Inbox Driver Technical Support Contact Information AvailabilityTraining Support Headquarters Asia Pacific Region Europe, Middle East, and Africa RegionLatin and South America Region Preliminary Starting Interactive Mode Introduction Virtual if available Starting Non-interactive Mode Following inputs are valid for the port ID Red Hat/SuSE Menu Description Section Option InteractiveWindows Macintosh Non-interactive Mode Options Interactive Interactive Menu Terminology HBA Port Initial Installation Downloading the Installation Package Windows Installation Installing SANsurfer FC HBA CLIStandard GUI Installation Welcome Dialog Box Ready to Install the Program Dialog Box Command Line Installation Standard Command Line Installation Windows Command Line Installation Parameters Silent Command Line InstallationParameter Meaning Description For SuSE Sles IA64, the command line is Linux InstallationNew package is installed in the following directory To install SANsurfer FC HBA CLI, type the following Solaris InstallationSolaris Sparc 8, 9, 10 Installation Available packages appear. For example Solaris x86 9 and 10 Installation Enter Macintosh Installation Uninstalling SANsurfer FC HBA CLI For example Command Line Uninstall Windows UninstallStandard GUI Uninstall Linux Uninstall Solaris Sparc 8, 9, and 10 Uninstall Solaris x86 8, 9, and 10 Uninstall Macintosh Uninstall Page Interactive Commands Host Information Command Line Option -gGeneral Information Menu General Information Host Information Host Topology Command Line Option -tp -topologyGeneral Information 2 Host Topology Display Host Topology SN0054614-00 F Here is an example HBA Seagate Save As Txt File Command Line Option -bCommand Line Option Save As XML File Generate Report Command Line Option -zSave to XML File Format Generate Report Per HBA Port ‰ HBA ID ‰ Wwpn ‰ HBA Part Number ‰ Port Number ‰ Size ‰ Type HBA ID SN0054614-00 F LUN LUN ID Refresh Generate Report All HBAsHBA Information Menu HBA Information Command Line Option -haHBA General Information per HBA Port HBA Alias Command Line Option -pa HBA Port Alias Command Line Option -l and Reserved Word vpd HBA VPD Information HBA Parameters Menu HBA Information All HBAsInformation HBA Information n All HBAs Display HBA Parameters Command Line Option -c#HBA Parameters Per HBA Port HBA Parameters n Port Instance Configure HBA Parameters Command Line Option -n HBA Parameters Settings Nvram Parameter Name Alias Value Description Data Rate Connection OptionsFrame Size Enable HBA Hard Loop ID Loop Reset DelayEnable HBA Port Bios Enable Fibre Channel Tape Support Login Retry Count Operation ModeInterrupt Delay Timer Enable LIP Reset Enable Target Reset Enable LIP Full LoginLink Down Timeout LUNs per Target HBA Parameters All HBAs Restore DefaultsAbort Changes Choose this option to stop without making any changes Target/LUN Information Command Line Options -t and -lTarget/LUN List Menu Target/LUN List Target/LUN List Per HBA Port Per Target/LUN So on Per Target/All LUNs„ Size „ Type Individual Target All TargetsTarget/LUN List All HBAs So on. Repeats for each LUN Individual LUN „ Status Here is an example of the Target information „ LUN ID So forth Target/LUN List n Port Number All LUNs Hitachi Command Line Option -q Target Link Speed or iiDMA Settings MenuTarget Link Speed or 5 iiDMA Settings Target Link Speed Settings Configuring the iiDMA Settings3lists the target link speed settings and descriptions Target Link Speed Settings Description To use Basic Configuration HBA Port Instance IiDMA Settings 1 n HBA Port n HBA Port Advanced Configuration Target Link Speed All HBAs Target Link Speed All HBAs Basic ConfigurationTarget Link Speed All HBAs Advanced Configuration Target Link Speed 2 All HBAs 4.2.1 IiDMA All HBAs IiDMA Settings DiskCommand Line Option -p Target Persistent Bindings Menu Display Target Persistent Binding Target Persistent Bindings Per HBA PortTarget Persistent Binding Target Persistent Bindings Bind Targets Target Persistent Binding All HBAs Target Persistent Binding FC Port ConfigurationTarget Persistent Binding Unbind Targets Target Persistent Binding p All HBAs Selective LUNs Menu Command Line Option -mTarget Persistent Binding Bind Targets Selective LUNs Per HBA Port Selective LUNs All HBAs Display LUN ConfigurationSelective LUNs 1 All HBAs Boot Device Menu Manual Configure LUNsAuto Configure LUNs Command Line Option -e Boot Devices Per HBA Port „ Wwpn Boot Device Settings Configure Boot DevicesLUN List Menu Driver Settings Menu Save ConfigurationBoot Devices All HBAs Command Line Option -fg Driver Settings Parameter Name Alias Value Description Param name Utilities Menu Flash Update Per HBA Port or All HBAsCommand Line Option -b and Reserved Word save Flash Save Per HBA Port HBA Parameters Save Per HBA Port HBA Parameters Update Per HBA Port or All HBAsHBA Parameters Template Per HBA or All HBAs Using HBA Parameter Templates Setting QLogic IBM SUN Command Line Option -rs Driver UpdateCommand Line Option -d Driver Rescan Beacon Menu Command Line Option -aCommand Line Option -tb Locate HBA HBA Beacon HBA Diagnostics Configuration Settings Diagnostics MenuCommand Line Options -kl, -kr, and -dm Beacon Selected Targets Command Line Option -kl Diagnostics Loopback TestDiagnostics n Port Number Configure Loopback Test Parameters SN0054614-00 F Diagnostics Read/Write Buffer Test Run Loopback Test Configure Read/Write Test Parameters SN0054614-00 F SN0054614-00 F SN0054614-00 F Run Read/Write Buffer Test Command Line Option -dm Diagnostics Transceiver Details DMITransceiver Details General Transceiver Details Details SN0054614-00 F SN0054614-00 F Command Line Option -gs ConfigurationCommand Line Options -gs and -ls Statistics Menu Resetting to default settings..., done Auto Poll Current Settings10. HBA Port Statistics Options Log to File Set RateShow HBA Statistics Command Line Option -ls Link Status 11. Statistics/Link Status Options Restore DefaultAuto Poll Menu SANsurfer FC HBA CLI displays two polling options Show Link Status Virtual Menu Command Line Option -vpVirtual Menu Scli -vp -h List Virtual Ports Virtual Menu for HBA InstanceVirtual Create Virtual Ports Delete Virtual Ports‰ Status Online or Loop Down Here is an example User Generate Command Line Option -hAuto Generate Help Menu Exit Codes ContentsAbout Command format to show host information is Command Line Options -g, -z, and -tpDisplay System Information Where Host ConfigurationTo show the information for all HBAs, type Command Line Option -tp Options Shown by -z Description See Section „ -s= Silent mode see .3.28. For example Command SummaryCommand format for non-interactive mode is Only View or Toggle Beacon Status 2defines the command variablesCommand Variables Variable Definition Format To view the HBA port’s LED Beacon state, type Save or Update the Flash Bios or FcodeTo start or stop flashing the HBA’s LED beacon, type To save the BIOS/FCode to a file, type Show Parameter SettingsUpdate Device Driver To show the parameter settings for a specific HBA, type Boot Device View Select Disable Display Diagnostics Monitoring InfoTo show Transceiver monitoring detailed information, type These commands To view the current boot device selection on all HBAs To disable delete the boot device for a specific HBA, type SANsurfer FC HBA CLI specifies command line input from file List SANsurfer FC HBA CLI Error CodesInput Parameter Options from a Text File Type the following command to configure the driver settings Show Driver SettingsConfigure Driver Settings 3lists the driver configuration parameter names and aliases Show HBA Statistics For details of this command, see sectionDisplay System Information To view system information, type Type the following text to view the help file HelpHBA Statistics Parameters For example, typing scli -l-hshows Set Delete HBA Alias To show general or VPD information for a specific HBA, type Loopback TestTo do a loopback test with customized parameters, type To enter a customized value in the range of 00-FF, type DataPattern DPFor the loopback test, the data pattern is either 5lists all valid data patterns For the loopback test, the data size is either DataSize DSData Pattern Values Hex Binary TestCount TC OnError OEFor the loopback test, OnError is either Test Increment TI To do a loopback test using the current parameters, type OnError ValuesDriver Versions Not Requiring a Loopback Connector Run a Loopback Test To do a loopback test with custom parameters, type An example of a successful loopback test follows Run Read/Write Buffer Test Run HBA Diagnostics Loopback TestTo do a read/write test with customized parameters, type Run a Read/Write Buffer Test HBA Wwpn An example of a successful read/write buffer test follows Diagnostics Parameters Run HBA Diagnostics Read-write Buffer TestName Alias Value Description Data Pattern DP Test Patterns „ Status Display Link Status Display LUN InfoTo view the link status, type View, Enable, or Disable LUNs 10. Link Status Parameters To view an HBA’s selective LUN list, type To view all selective LUNs for all HBA ports, typeTo view the current select state of a specific LUN, type Set Selected HBA Parameter To enable select all LUNs of all targets on a specific HBATo restore the default Bios 4G HBAs only, type To set a specific parameter on a specific HBA, type 11lists the HBA parameter names and aliases 11. HBA Parameters Output to a File Display Persistent Target Binding Info To show persistent binding information for all HBAs, type To bind a selected target to a specific HBA, type To unbind a specific target, type To delete a port alias for the specified HBA port, type Define Port AliasView or Set Target Link Speed To view a port alias for the specified HBA port, type # scli -q HBA Instance HBA Wwpn Target Wwpn To update the HBA Parameters, type Update HBA ParametersSilent Mode To save the HBA parameters to a file, type Display Target Information Target Beacon On/Off Virtual Port Display Host TopologyDisplay Version System shows the following information To create a virtual port with an automatic WWPN, type Output in XML FormatTo create a virtual port with a specific WWPN, type 2 covers this command Display All HBA information for One or All HBAs Main Tag Utility Header Status Message Reboot MessageError Message XML Format 1 Tags for Each Option XML Format 1 for adapter settings information is as follows Display Adapter SettingsCommand Line Option -c XML format 1 for system information output is as follows Display HBA Information Here is the information for the 4G HBAs Here is the VPD information XML Format 1 for adapter device information is as follows Command Line Option -tDisplay Device List Target…/Target sequence is repeated for each HBA target Display LUN List Command Line Option -lTarget Persistent Binding XML Format 1 for the boot device information is as follows Boot DeviceSelective LUNs Command Line Option -kr Diagnostics Results -Loopback TestDiagnostics Results Read/Write Buffer Test XML Format 1 for the loopback test results is as follows Table A-1. Options Displayed by -z View Driver SettingsDisplay All Information for One or All HBAs Non-interactive Description Section Option XML Format 1 for all adapter information is as follows XML Format XML Format 1 Tags for Each Option XML Format 1 for the link statistics option is as follows Link StatisticsHBA Statistics XML Format 1 for the HBA statistics option is as follows XML Format 1 for the HBA alias option is as follows XML Format 1 for the HBA port alias option is as follows SFF DMI XML Format 1 for SFF DMI general information is as follows XML Format XML Format 1 Tags for Each Option XML Format 1 XML Format 1 Tags for Each Option XML Format XML Format 1 Tags for Each Option XML Format 1 XML Format 1 Tags for Each Option Host Topology XML Format 1 XML Format 1 Tags for Each Option InterConnectElement Status 0 /Status Reboot 0 /Reboot QLogic Appendix B Command format is XML2 Tags for Each Option XML Format 2 for adapter settings information is as follows XML Format 2 for SFF DMI general information is as follows XML Format 2 for the boot device information is as follows XML Format 2 for SFF DMI detailed information is as follows XML Format XML2 Tags for Each Option XML Format 2 XML2 Tags for Each Option Command format for all HBAs is Command format for a single HBAs is HBA Instance HBA Wwpn view ? XML Format 2 for system information output is as follows XML Format 2 for adapter general information is as follows XML Format 2 for 4G HBAs is as follows Diagnostics Results Loopback Test XML Format 2 for the loopback test results is as follows Target... /Target sequence repeats for each target Scli -m all view ? XML Format 2 for adapter device information is as follows Table B-1. Options Displayed by -z Non-interactive Setting Section OptionXML Format 2 for all adapter information is as follows XML Format Display System Information Command Line Option -g SN0054614-00 F XML Format 2 for the link statistics option is as follows XML Format 2 for the HBA statistics option is as follows View HBA AliasLinkStatus…/ parameter repeats for each link Statistics.../ sequence repeats for each HBA XML Format 2 for the HBA port alias option is as follows SN0054614-00 F Scli -tp SN0054614-00 F Page Table C-1. Exit Code Descriptions Interactive Mode Return Name Description Code Errormismatchchecksum Errorflashupdatenoregion Errorinvalidparamsettings Errorpreservenvramdata Errorduplicatetargetid Errorfailoverdriverloaded Errorclosezipfile Errorsavesellunconfig Errormissingipaddress Errorsavetargetiidmasettings Erroradapterpropmissing To see the interactive exit codes, see Appendix C Table D-1. Error Code Descriptions Non-interactive ModeCode Name Description Errorflashupdatenovalidregion Errordiagnosticsdatamiscompare Errormissingnvramtemplatefile Errorbootconfigdisableddriver Errorreadfrompersistentstorage Errorinualidhbawwid Driver sys file is missing in the driver Failed to save selective LUN configu 205 Reserved Not used 206 207 208 209 210 Errorsettargetiidmaunsupported 257 Reserved Not used 258 259 260 Table E-1. Help Commands Command Arguments Function All file name Disable prim alt1 alt2 Param name param Alias param value Hba instance hba wwpn Lun id view ? Hba instance hba wwpn Target portid target id Hba instance hba wwpn Portid All Writes the output in XML format 1. Option See HBA For the HBA and initializing and testing the HBAs ISPComma separated values CSV file Driver Red Hat/SuSE Linux, the driver layers include Port in a fabric where an NPort can attach Fabric consists of cross-connected FC devices and switchesQLogic Fast!UTIL FC HBA Bios utility Flash Prom contains the Bios code for the HBA Device’s Alpa on the loop As opposed to a SAN. See SAN Storage Area NetworkNPort ID Virtualization Network Interface Controller Remote procedure call developed by Sun MicrosystemsAlso FC-P2P. Two FC nodes directly connected not in a loop SAN Storage Area Network Index Index-2 SN0054614-00 F SN0054614-00 F Index-3 Fg4-54,5-4,5-13,A-10,B-10 file Txt Xml 4-8 text 4-8 XML HBA hard loop ID 4-23host LED SN0054614-00 F Index-7 Index-8 SN0054614-00 F Definition of Glossary-6 layers, definition of Glossary-2 SDM API Index-10 SN0054614-00 F Txt 4-8 text file XML