Emulex® Drivers for VMware ESXi User Guide Release 12.
Broadcom, the pulse logo, Connecting everything, Avago Technologies, Avago, the A logo, Brocade, Emulex, and OneCommand are among the trademarks of Broadcom and/or its affiliates in the United States, certain other countries, and/ or the EU. Copyright © 2003–2019 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. For more information, please visit www.broadcom.com.
Emulex Drivers for VMware ESXi User Guide Table of Contents Chapter 1: Introduction ...................................................................................................................... 5 1.1 ESXi Compatibility ....................................................................................................................................................5 1.2 Supported Guest Operating Systems ...............................................................................................
Emulex Drivers for VMware ESXi User Guide B.4 lpfc Driver Module Parameters .............................................................................................................................43 B.4.1 lpfc_prot_mask ..............................................................................................................................................43 B.4.2 lpfc_prot_guard .......................................................................................................................
Emulex Drivers for VMware ESXi User Guide Chapter 1: Introduction This product supports the following Emulex® HBAs: LPe12000-series adapters LPe16000-series adapters LPe31000-series adapters LPe32000-series adapters LPe35000-series adapters The VMware ESXi drivers support the FC protocol. This document explains how to install the VMware ESXi drivers on your system and how to configure the drivers’ capabilities.
Emulex Drivers for VMware ESXi User Guide Windows Server 2012 and R2 Windows Server 2016 Windows Server 2019 1.3 Abbreviations The following table lists the acronyms and abbreviations used in this document.
Emulex Drivers for VMware ESXi User Guide Table 1: Acronyms and Abbreviations (Continued) Acronym/Abbreviation Description RSP route/switch processor VASA vSphere APIs for Storage Awareness VIB vSphere Installation Bundle VMID Virtual Machine Identifier VPD vital product data vPort virtual port VVols virtual volumes XRI Extensible Resource Indicator Broadcom DRVVM-LPe-UG124-100 7
Emulex Drivers for VMware ESXi User Guide Chapter 2: Installation This section provides information for installing the ESXi driver for the FC protocol. 2.1 Installing the FC Driver This section provides installation information for the driver and the Emulex CIM Provider using the FC interface on ESXi systems. Before using this product, you need a working knowledge of FC storage devices. 2.1.1 Installing the FC Driver and Management Software The Emulex driver is available through the VMware support site.
Emulex Drivers for VMware ESXi User Guide 3. Restart the hostd using the following command: /etc/init.d/hostd restart After the driver has restarted, the elxfc namespace appears under esxcli.
Emulex Drivers for VMware ESXi User Guide 2.2 Updating Drivers with VMware Offline Bundle Media VMware recommends using the offline bundle to update software on VMware ESXi platforms. NOTE: For more information about the ESXi patch management activities, go to the VMware website. To update a driver with the offline bundle media, perform the following steps: 1. Run the following command to update the FC driver. esxcli software vib install --maintenance-mode -d /VMW-ESX-6.x.
Emulex Drivers for VMware ESXi User Guide Chapter 3: Configuration This chapter provides configuration information for the ESXi driver. 3.1 ESXi Command Line Tool Transition For the ESXi 6.5 release and all subsequent ESXi operating system releases, VMware is transitioning from esxcfg commands to esxcli commands. This section describes the transition to the esxcli commands. NOTE: Both sets of commands are supported in the ESXi 6.5 and ESXi 6.7 releases. 3.1.1 ESXi 6.5 and 6.7 Implementation For ESXi 6.
Emulex Drivers for VMware ESXi User Guide 3.2.1 FC Driver Parameters Configuration Methods Configure the driver parameters using any of the following methods: Permanent (global) Permanent (per adapter) Temporary (global) Temporary (per adapter) The OneCommand Manager application supports all four ways to configure driver parameters. Refer to the Emulex OneCommand Manager Application User Guide or the Emulex OneCommand Manager for VMware vCenter User Guide for more information.
Emulex Drivers for VMware ESXi User Guide 3. To reboot the server, type: reboot The new setting is used when the driver reloads. To verify the setting, type: esxcli system module parameters list -m lpfc 3.2.1.1.2 Examples of Permanent Per-Adapter Configuration The following example sets lun_queue_depth to 20 (the default is 30) for adapter 1. 1. Set the adapter-specific value by typing: esxcli system module parameters set -p lpfc1_lun_queue_depth=20 -m lpfc 2.
Emulex Drivers for VMware ESXi User Guide FC-SP-2 DHCHAP authentication is disabled by default. To enable FC-SP-2 DHCHAP authentication, you must pass the lpfc_enable_auth parameter to the driver by typing the following command: # esxcli system module parameters set -p lpfc_enable_auth=1 -m lpfc You must reboot the system to activate the parameter. After DHCHAP has been activated and configured, you can manually initiate authentication per adapter.
Emulex Drivers for VMware ESXi User Guide There are no driver parameters to enable trunking. Trunking is a one-time configuration, and the configuration is performed through the OneCommand Manager application. For more information on configuring trunking, refer to the Emulex OneCommand Manager Application User Guide. When trunking is configured for an adapter, Internal loopback and External loopback tests are supported.
Emulex Drivers for VMware ESXi User Guide To force the ESXi server to rescan all devices, perform one of these actions: Run the following command: esxcli storage core adapter rescan -A vmhbaX From the vSphere Client, select Configuration Tab > Storage Adapters, and then click Rescan All. 3.2.6 FC Driver Configuration Parameters Table 4 lists the FC driver module parameters, their descriptions, and their corresponding values in ESXi native mode.
Emulex Drivers for VMware ESXi User Guide Table 4: FC Driver Parameters (Continued) Module Parameter Description lpfc_enable_bb_credit_recovery Toggles the Buffer-to-Buffer Credit Recovery feature. This parameter requires a system reboot. ESXi 6.5 and ESXi 6.7 Native Mode Driver Model Values Comments Default = 1 Min. = 0 Max. = 1 Applicable to SLI-4 adapters only. lpfc_enable_da_id Controls the DA_ID CT command. Unregisters objects with the fabric nameserver. Default 1 = Enable Min.
Emulex Drivers for VMware ESXi User Guide Table 4: FC Driver Parameters (Continued) ESXi 6.5 and ESXi 6.7 Native Mode Driver Model Values Module Parameter Description lpfc_enable_rrq Enables Reinstate Recovery Default = 2 Qualifier functionality. Min. = 0 0x0 = Disabled, Max. = 2 XRI/OXID use not tracked. 0x1 = XRI/OXID reuse is timed with the resource allocation timeout (R_A_TOV), Reinstate Recovery Qualifier sent.
Emulex Drivers for VMware ESXi User Guide Table 4: FC Driver Parameters (Continued) ESXi 6.5 and ESXi 6.7 Native Mode Driver Model Values Module Parameter Description lpfc_hba_queue_depth The maximum number of FCP commands queued to an FC adapter. The driver automatically adjusts the hba_queue_depth to match adapter capabilities. This setting may be overridden. This parameter requires a system reboot. lpfc_iocb_cnt IOCBs allocated for ELS, CT, Default = 1 and abort sequence in 1024 Min.
Emulex Drivers for VMware ESXi User Guide Table 4: FC Driver Parameters (Continued) ESXi 6.5 and ESXi 6.7 Native Mode Driver Model Values Module Parameter Description lpfc_max_heap_size Maximum allowable memory Default = 128 MB — consumption per server for Min. = 64 MB the LPFC module. Max. = 512 MB This parameter requires a system reboot. lpfc_max_luns The maximum number of LUNs allowed. This parameter requires a system reboot.
Emulex Drivers for VMware ESXi User Guide Table 4: FC Driver Parameters (Continued) Module Parameter Description ESXi 6.5 and ESXi 6.7 Native Mode Driver Model Values lpfc_nlp_slab_cnt NLP slab entries. This parameter requires a system reboot. Default = 128 Min. = 32 Max. = 256 lpfc_ras_fwlog_buffsize Buffer size to be allocated in host memory for firmware logging. This parameter requires a system reboot. This parameter is supported only on Default = 0 LPe31000-series, LPe32000-series, and Min.
Emulex Drivers for VMware ESXi User Guide Table 4: FC Driver Parameters (Continued) ESXi 6.5 and ESXi 6.7 Native Mode Driver Model Values Module Parameter Description lpfc_sg_seg_cnt The maximum scatter gather Default = 64 segment count for DMA. Min. = 64 The maximum data allowed Max. = 4096 in one SG element is 0x80000000. This parameter requires a system reboot. — lpfc_suppress_link_up Default = 0 Suppresses link up at initialization: Min. = 0 0x0 = Bring up link Max.
Emulex Drivers for VMware ESXi User Guide Table 4: FC Driver Parameters (Continued) ESXi 6.5 and ESXi 6.7 Native Mode Driver Model Values Module Parameter Description lpfc_topology Default = 0 Selects FC topology. Valid values are: Min. = 0 0x0 = Attempt loop mode Max. = 6 then point-to-point 0x01 = Internal loopback mode 0x02 = Attempt point-to-point mode only 0x04 = Attempt loop mode only 0x06 = Attempt point-to-point mode then loop This parameter is dynamically updated.
Emulex Drivers for VMware ESXi User Guide Table 4: FC Driver Parameters (Continued) Module Parameter Description ESXi 6.5 and ESXi 6.7 Native Mode Driver Model Values lpfc_vmid_priority_tagging VMID CS_CTL tagging. This parameter requires a system reboot. Default = 0 Min. = 0 Max. = 2 NOTE: Comments Cisco VMID uses the priority tagging field to communicate the capability. 0 = Disables priority tagging. Priority tagging is also disabled when the parameter is set to anything other than 1 or 2.
Emulex Drivers for VMware ESXi User Guide Table 6: Adapter Attributes for fdmi_on Parameter (Continued) Hexadecimal Value Information Type 0x005 Model Description 0x006 Hardware Version 0x007 Driver Version 0x008 Option ROM Version (boot code) 0x009 Firmware Version 0x00A Operating System Name and Version 0x00B Maximum CT Payload Length 0x00C Node Symbolic Name 3.2.
Emulex Drivers for VMware ESXi User Guide Instead of OneCommand Manager for Windows, use the OneCommand Manager for VMware CLI (elxvcpcmd) or the esxcli elxmgmt utilities to manage HBAs installed on ESXi 6.7 Update 1. 3.2.8.2 Using the OneCommand Manager Application for VMware vCenter The OneCommand Manager for VMware vCenter Server application uses the standard CIM interface to manage the adapters and supports CIM-based device and adapter management.
Emulex Drivers for VMware ESXi User Guide The following note applies to vPorts. NOTE: Ensure you are using the latest recommended firmware for vPort functionality. Check the Broadcom website for the latest firmware. Loop devices and NPIV are not supported on the same port at the same time. If you are running a loop topology and you create a vPort, the vPorts link state is offline. VMware ESXi supports fabric mode only. You can create vPorts only on 8, 16, and 32 GFC adapters.
Emulex Drivers for VMware ESXi User Guide Chapter 4: Troubleshooting Your system may operate in an unexpected manner in certain circumstances. This section explains many of these circumstances and offers one or more workarounds for each situation. 4.1 Troubleshooting the FC Driver This section provides troubleshooting information for the FC driver. Table 7 identifies some of the common situations and their potential resolutions.
Emulex Drivers for VMware ESXi User Guide Table 7: Troubleshooting the FC Driver (Continued) Situation Resolution The system panics when booted with a failed adapter installed. Remove the failed adapter and reboot. The FC driver does not discover all remote ports in the configuration switch zone. Some initiators or targets may appear to be missing. Evaluate your switch zone. Count how many entries are there and add at least seven more (to account for fabric logins).
Emulex Drivers for VMware ESXi User Guide b.
Emulex Drivers for VMware ESXi User Guide Table 8: Message Log Table LOG Message Verbose Mask Definition Verbose Bit Verbose Description LOG_SLI 0x00000800 SLI events LOG_FCP_ERROR 0x00001000 Log errors, not underruns LOG_LIBDFC 0x00002000 Libdfc events LOG_VPORT 0x00004000 NPIV events LOG_MEM_SLAB 0x00008000 Memory tracker slab logging LOG_EVENT 0x00010000 CT, TEMP, DUMP, logging LOG_AUTH 0x00020000 DHCHAP logging LOG_FCP_UNDER 0x00040000 FCP underrun errors LOG_TASKMGMT 0x0010
Emulex Drivers for VMware ESXi User Guide Appendix A: esxcli Management Tool A.1 Usage The esxcli management tool supports both local and remote management.
Emulex Drivers for VMware ESXi User Guide Table 10: esxcli Management Commands (Continued) Command Description authconfig get -w -d Shows the authentication configuration details. d specifies the destination WWPN. It must be ff:ff:ff:ff:ff:ff:ff:ff for a switch or the actual WWPN for a target. NOTE: This command replaces the getauthconfig command. authconfig initiate -w Initiates authentication for a specified HBA port.
Emulex Drivers for VMware ESXi User Guide Table 10: esxcli Management Commands (Continued) Command Description authconfig set -w -d -b -p -s -m -r -a -t Sets the authentication configuration parameters for a specified HBA port. d specifies the destination WWPN. It must be ff:ff:ff:ff:ff:ff:ff:ff for a switch or the actual WWPN for a target.
Emulex Drivers for VMware ESXi User Guide Table 10: esxcli Management Commands (Continued) Command Description bootparams set -w -p Sets the boot parameter and boot type for the specified HBA port. -t -v - b p specifies the parameter name. t specifies the boot type: {X86, EFI, OB}. v specifies the value to be set for the parameter.
Emulex Drivers for VMware ESXi User Guide Table 10: esxcli Management Commands (Continued) Command Description – EnvVarEnable X86 { State } (0=Disable, 1=Enable) – SpinupDelayEnable X86 { State } (0=Disable, 1=Enable) – StartUnitCommandEnable X86 { State } (0=Disable, 1=Enable) – BootTargetScan EFI { 0, 1, 2, 3, 4 } – EnableFABL EFI { State } (0=Disable, 1=Enable) – MaxLunsPerTarget EFI { Value } – DelayDeviceDiscovery EFI { Value } – SfsFlag OB – { State } (0=Disable, 1=Enable) Boot Device Parameters – D
Emulex Drivers for VMware ESXi User Guide Table 10: esxcli Management Commands (Continued) Command Description congestparams set -w -v Sets the congestion parameters for a specified HBA port. -p v specifies the congestion parameter value. [-s
Emulex Drivers for VMware ESXi User Guide Table 10: esxcli Management Commands (Continued) Command Description dump -w Creates a dump file for a selected adapter. Dump files contain information, such as the firmware version, driver version, and operating system information. This information is useful when troubleshooting an adapter. Text (.txt extension) and binary files (.bin extension) files are created with the dump command.
Emulex Drivers for VMware ESXi User Guide Table 10: esxcli Management Commands (Continued) Command Description hbaport attributes -w Lists port attributes of an Emulex FC HBA. NOTE: This command replaces the portattributes command. hbaport speed set -w -s Sets port speed of an Emulex FC HBA. s specifies the supported link speed. Use the hbaport attributes command to get accurate list of supported speed values. Specify a value of 0 to configure Auto Detect mode.
Emulex Drivers for VMware ESXi User Guide Table 10: esxcli Management Commands (Continued) Command Description fwparams set -w -p -v Sets the firmware parameters. The only firmware parameter that is currently supported is FA-PWWN. p specifies the name of firmware parameter whose value is to be set. Valid values are: – FA-PWWN = {0=Disable, 1=Enable}. – FEC = {0=Disable, 1=Enable}.
Emulex Drivers for VMware ESXi User Guide Appendix B: lpfc Driver BlockGuard Functionality This appendix describes how to enable BlockGuard and set lpfc driver module parameters. B.1 Overview The BlockGuard feature checks the integrity of data read from and written to the host to the disk and back through the SAN. This check is implemented through the DIF defined in the ANSI T10 standard. The Emulex lpfc driver supports T10 DIF Type 1.
Emulex Drivers for VMware ESXi User Guide B.2 Enabling BlockGuard BlockGuard is disabled by default. To enable it, the parameter lpfc_enable_bg must be passed to the driver as follows: esxcli system module parameters set -m lpfc -p "lpfc_enable_bg=1" Additional module parameters can be added to this line, separated by spaces. B.
Emulex Drivers for VMware ESXi User Guide Table 11: Initiator Operations (Continued) Initiator Operation Initiator Host <-> Adapter Adapter <-> Target Comment READ_STRIP Unprotected Protected Reads data and protection data from the target. The adapter verifies data integrity, discards protection data, and only transfers the data to the initiator host. It does not send the protection data to the initiator host. Protection data is only sent on the SAN.
Emulex Drivers for VMware ESXi User Guide The following table shows how protection data gets placed for each supported profile. Table 13: Protection Data Placement for Supported Profiles Flag Value BlockGuard Profile Operation VMK_SCSI_TYPE1_PROT 1 A1 READ_STRIP/WRITE_INSERT VMK_SCSI_DIX_TYPE0_PROT 8 AST2 READ_INSERT/WRITE_STRIP VMK_SCSI_DIX_TYPE1_PROT VMK_SCSI_TYPE1_PROT 17 AST1 / C1 READ_PASS/WRITE_PASS B.4.
Emulex Drivers for VMware ESXi User Guide Appendix C: Using the VMID Feature on a Brocade Switch This appendix describes the setup required for the Broadcom ECD VMID feature to work on a Brocade switch. NOTE: The Broadcom ECD VMID feature is not supported on the LPe12000-series adapters. 1. Set up the Brocade switch. a. You must install firmware version 8.0.1 or later. b. The Broadcom ECD VMID feature is enabled by default on Brocade switches. 2. Set up the target. a.
Emulex Drivers for VMware ESXi User Guide An output similar to the following is shown: -----------------------------------------------------------Displaying results for Fabric -----------------------------------------------------------N_Port ID : 7e1200 Entity Name : Entity ID (ASCII) : 52 e1 b0 6f 8c 5f 66 6a-79 c3 a9 f6 32 4d 19 20 Entity ID (Hex) : 0x35322065312062302036662038632035662036362036612d37392063332061392066362033322034642031392032300 0 Application ID : 0x00000209h (521) ----------------------
Emulex Drivers for VMware ESXi User Guide Appendix D: Using the VMID Feature on a Cisco Switch This appendix describes the setup required for the Broadcom ECD VMID feature to work on a Cisco switch. NOTE: The Broadcom ECD VMID feature is not supported on the LPe12000-series adapters. 1. Set up the Cisco switch. a. You must install firmware version 8.2 or later. b. The Broadcom ECD VMID feature is not enabled by default on Cisco switches.
Emulex Drivers for VMware ESXi User Guide An output similar to the following is shown: -------------------------------------------------------------------------------------------INTERFACE VSAN FCID PORT NAME NODE NAME FLAGS -------------------------------------------------------------------------------------------fc3/4 102 0x010025 10:00:00:00:c9:d1:a4:ec 20:00:00:00:c9:d1:a4:ec PM fc3/9 102 0x010045 10:00:e0:07:1b:ce:58:62 20:00:e0:07:1b:ce:58:62 P Total number of flogi = 2.
Emulex Drivers for VMware ESXi User Guide Appendix E: License Notices E.1 OpenSSL Notice This is a copy of the current LICENSE file inside the CVS repository. LICENSE ISSUES ============== The OpenSSL toolkit stays under a dual license, i.e. both the conditions of the OpenSSL License and the original SSLeay license apply to the toolkit. See below for the actual license texts. Actually both licenses are BSD-style Open Source licenses.
Emulex Drivers for VMware ESXi User Guide */ Original SSLeay License ----------------------/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) * All rights reserved. * * This package is an SSL implementation written * by Eric Young (eay@cryptsoft.com). * The implementation was written so as to conform with Netscapes SSL. * * This library is free for commercial and non-commercial use as long as * the following conditions are aheared to.
