SANsurfer FC HBA CLI User’s Guide | Q-Logic instruction

R

S i m p l i f y

SANsurfer FC HBA CLI User’s Guide

Command Line Interface for QLogic Fibre Channel Host Bus Adapters

SN0054614-00 F

Page i

Image 1

Q-Logic manual SANsurfer FC HBA CLI User’s Guide

Contents

SANsurfer FC HBA CLI User’s Guide Changes Sections Affected Revision F Changes Document Revision History Revision E Changes Added Appendix B XML Format Section Following options and commands were changed in Rev. E Following options and commands were added 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 Tables List of FiguresPage Guide Overview Product OverviewHow this Guide is Organized Topology Documentation Conventions General Information Supported Operating Systems Supported QLogic HBAs Hardware Requirements System Requirements Software Requirements Unsupported Features Features Not Available When Running Sysfs Inbox Driver Features Not Available When Running ioctl Module DriverFeatures Not Available When Running VMware Driver Technical Support Training AvailabilityContact Information Support Headquarters Asia Pacific Region Europe, Middle East, and Africa RegionLatin and South America Region Preliminary Introduction Starting Interactive Mode Virtual if available Following inputs are valid for the port ID Starting Non-interactive Mode Red Hat/SuSE Menu Description Section Option InteractiveWindows Macintosh Interactive Interactive Menu Non-interactive Mode Options HBA Port Terminology Downloading the Installation Package Initial Installation Windows Installation Installing SANsurfer FC HBA CLIStandard GUI Installation Welcome Dialog Box Ready to Install the Program Dialog Box Standard Command Line Installation 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 Solaris Sparc 8, 9, 10 Installation Solaris InstallationTo install SANsurfer FC HBA CLI, type the following Available packages appear. For example Solaris x86 9 and 10 Installation Enter Macintosh Installation For example Uninstalling SANsurfer FC HBA CLI Standard GUI Uninstall Windows UninstallCommand Line Uninstall Linux Uninstall Solaris x86 8, 9, and 10 Uninstall Solaris Sparc 8, 9, and 10 Uninstall Macintosh Uninstall Page Interactive Commands General Information Menu Command Line Option -gHost Information General Information Host Information Host Topology Command Line Option -tp -topologyGeneral Information 2 Host Topology Display Host Topology SN0054614-00 F HBA Here is an example Seagate Command Line Option Command Line Option -bSave As Txt File Save As XML File Save to XML File Format Command Line Option -zGenerate Report Generate Report Per HBA Port ‰ HBA ID ‰ Wwpn ‰ Size ‰ Type ‰ HBA Part Number ‰ Port Number HBA ID SN0054614-00 F LUN LUN ID Refresh Generate Report All HBAsHBA Information Menu HBA General Information per HBA Port Command Line Option -haHBA Information HBA Alias HBA Port Alias Command Line Option -pa HBA VPD Information Command Line Option -l and Reserved Word vpd Information HBA Information All HBAsHBA Parameters Menu HBA Information n All HBAs HBA Parameters Per HBA Port Command Line Option -c#Display HBA Parameters HBA Parameters n Port Instance Command Line Option -n Configure HBA Parameters Parameter Name Alias Value Description HBA Parameters Settings Nvram Data Rate Connection OptionsFrame Size Enable HBA Port Bios Loop Reset DelayEnable HBA Hard Loop ID Enable Fibre Channel Tape Support Interrupt Delay Timer Operation ModeLogin Retry Count Enable LIP Reset Link Down Timeout Enable LIP Full LoginEnable Target Reset LUNs per Target Abort Changes Restore DefaultsHBA Parameters All HBAs Choose this option to stop without making any changes Target/LUN List Menu Command Line Options -t and -lTarget/LUN Information Target/LUN List Per Target/LUN Target/LUN List Per HBA Port So on Per Target/All LUNs„ Size „ Type Target/LUN List All HBAs All TargetsIndividual Target So on. Repeats for each LUN Individual LUN „ LUN ID „ Status Here is an example of the Target information Target/LUN List n Port Number So forth Hitachi All LUNs Command Line Option -q Target Link Speed or iiDMA Settings MenuTarget Link Speed or 5 iiDMA Settings 3lists the target link speed settings and descriptions Configuring the iiDMA SettingsTarget Link Speed Settings Target Link Speed Settings Description HBA Port Instance To use Basic Configuration HBA Port IiDMA Settings 1 n HBA Port n Advanced Configuration Target Link Speed All HBAs Advanced Configuration Target Link Speed All HBAs Basic ConfigurationTarget Link Speed All HBAs Target Link Speed 2 All HBAs 4.2.1 Command Line Option -p IiDMA Settings DiskIiDMA All HBAs Target Persistent Bindings Menu Display Target Persistent Binding Target Persistent Bindings Per HBA PortTarget Persistent Binding Target Persistent Bindings Bind Targets Target Persistent Binding Unbind Targets Target Persistent Binding FC Port ConfigurationTarget Persistent Binding All HBAs Target Persistent Binding p All HBAs Target Persistent Binding Bind Targets Command Line Option -mSelective LUNs Menu Selective LUNs Per HBA Port Selective LUNs All HBAs Display LUN ConfigurationSelective LUNs 1 All HBAs Auto Configure LUNs Manual Configure LUNsBoot Device Menu Command Line Option -e „ Wwpn Boot Devices Per HBA Port Boot Device Settings Configure Boot DevicesLUN List Menu Boot Devices All HBAs Save ConfigurationDriver Settings Menu Command Line Option -fg Parameter Name Alias Value Description Param name Driver Settings Command Line Option -b and Reserved Word save Flash Update Per HBA Port or All HBAsUtilities Menu 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 IBM SUN Setting QLogic Command Line Option -d Driver UpdateCommand Line Option -rs Driver Rescan Command Line Option -tb Command Line Option -aBeacon Menu Locate HBA HBA Beacon Command Line Options -kl, -kr, and -dm Diagnostics MenuHBA Diagnostics Configuration Settings Beacon Selected Targets Command Line Option -kl Diagnostics Loopback TestDiagnostics n Port Number Configure Loopback Test Parameters SN0054614-00 F Run Loopback Test Diagnostics Read/Write Buffer 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 Options -gs and -ls ConfigurationCommand Line Option -gs Statistics Menu Resetting to default settings..., done Auto Poll Current Settings10. HBA Port Statistics Options Log to File Set RateShow HBA Statistics Link Status Command Line Option -ls Auto Poll Menu Restore Default11. Statistics/Link Status Options 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 Auto Generate Command Line Option -hUser 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 Description See Section Options Shown by -z Command format for non-interactive mode is Command Summary„ -s= Silent mode see .3.28. For example Only Command Variables 2defines the command variablesView or Toggle Beacon Status 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 Update Device Driver Show Parameter SettingsTo save the BIOS/FCode to a file, type 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 To view the current boot device selection on all HBAs These commands 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 Configure Driver Settings Show Driver SettingsType the following command to configure the driver settings 3lists the driver configuration parameter names and aliases Display System Information For details of this command, see sectionShow HBA Statistics To view system information, type HBA Statistics Parameters HelpType the following text to view the help file 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 For the loopback test, the data pattern is either DataPattern DPTo enter a customized value in the range of 00-FF, type 5lists all valid data patterns Data Pattern Values DataSize DSFor the loopback test, the data size is either Hex Binary For the loopback test, OnError is either OnError OETestCount TC Test Increment TI Driver Versions Not Requiring a Loopback Connector OnError ValuesTo do a loopback test using the current parameters, type Run a Loopback Test An example of a successful loopback test follows To do a loopback test with custom parameters, type Run Read/Write Buffer Test Run HBA Diagnostics Loopback TestTo do a read/write test with customized parameters, type HBA Wwpn Run a Read/Write Buffer Test An example of a successful read/write buffer test follows Diagnostics Parameters Run HBA Diagnostics Read-write Buffer TestName Alias Value Description „ Status Data Pattern DP Test Patterns Display Link Status Display LUN InfoTo view the link status, type 10. Link Status Parameters View, Enable, or Disable LUNs 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 To restore the default Bios 4G HBAs only, type To enable select all LUNs of all targets on a specific HBASet Selected HBA Parameter To set a specific parameter on a specific HBA, type 11. HBA Parameters 11lists the HBA parameter names and aliases Output to a File To show persistent binding information for all HBAs, type Display Persistent Target Binding Info To unbind a specific target, type To bind a selected target to a specific HBA, type View or Set Target Link Speed Define Port AliasTo delete a port alias for the specified HBA port, type To view a port alias for the specified HBA port, type # scli -q HBA Instance HBA Wwpn Target Wwpn Silent Mode Update HBA ParametersTo update the HBA Parameters, type To save the HBA parameters to a file, type Target Beacon On/Off Display Target Information Display Version Display Host TopologyVirtual Port 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 Display All HBA information for One or All HBAs 2 covers this command Utility Header Main Tag Error Message Reboot MessageStatus Message XML Format 1 Tags for Each Option Command Line Option -c Display Adapter SettingsXML Format 1 for adapter settings information is as follows XML format 1 for system information output is as follows Display HBA Information Here is the VPD information Here is the information for the 4G HBAs Display Device List Command Line Option -tXML Format 1 for adapter device information is as follows 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 Diagnostics Results Read/Write Buffer Test Diagnostics Results -Loopback TestCommand Line Option -kr XML Format 1 for the loopback test results is as follows Display All Information for One or All HBAs View Driver SettingsTable A-1. Options Displayed by -z Non-interactive Description Section Option XML Format 1 for all adapter information is as follows XML Format XML Format 1 Tags for Each Option HBA Statistics Link StatisticsXML Format 1 for the link statistics option is as follows XML Format 1 for the HBA statistics option is as follows XML Format 1 for the HBA port alias option is as follows XML Format 1 for the HBA alias option is as follows XML Format 1 for SFF DMI general information is as follows SFF DMI 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 XML2 Tags for Each Option Command format is XML Format 2 for SFF DMI general information is as follows XML Format 2 for adapter settings 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 a single HBAs is Command format for all 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 XML Format 2 for the loopback test results is as follows Diagnostics Results Loopback Test 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 LinkStatus…/ parameter repeats for each link View HBA AliasXML Format 2 for the HBA statistics option is as follows 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 Return Name Description Code Table C-1. Exit Code Descriptions Interactive Mode 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 All file name Command Arguments Function 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 Red Hat/SuSE Linux, the driver layers include Driver QLogic Fast!UTIL FC HBA Bios utility Fabric consists of cross-connected FC devices and switchesPort in a fabric where an NPort can attach 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 Txt Xml 4-8 text 4-8 XML Fg4-54,5-4,5-13,A-10,B-10 file HBA hard loop ID 4-23host LED SN0054614-00 F Index-7 Index-8 SN0054614-00 F SDM API Definition of Glossary-6 layers, definition of Glossary-2 Index-10 SN0054614-00 F Txt 4-8 text file XML