Installing HBAs/Drivers on an VMware Host

 

Topic

Setting up a host environment

Selections

Select a host: VMware

Select a VMware task: Installing HBAs/drivers

Select a HBA type: Emulex

Select a switch type: Brocade

 

 

Contents

·             Installing Emulex HBA(s) on a VMware Host 4

·             Updating Emulex HBA firmware for VMware. 5

·             Loading an in-kernel Emulex driver for VMware HBA.. 11

·             Setting the FA port flags for a VMware host 12

·             Creating switch zones. 14

·             Determine WWN of new HBA for VMware. 16

·             Making LUNs or Devices available to VMware. 16

 


 

Install/Setup Emulex HBA/Driver Environment on VMware

 

Using various procedures, this section for VMware, featuring a Emulex HBA environment describes how to install and setup host bus adapters and other aspects of a host environment that deal with managing devices of a storage system. A series of procedures take you through installing HBAs, HBA firmware, and drivers.

 

·              Installing Emulex HBA(s) on a VMware Host

 

Overview

This procedure describes how to install Emulex HBAs on a V3.0 VMware ESX Server host.

 

These procedures are based on content from the following EMC manual:

  • EMC Host Connectivity Guide for VMware ESX Server
  • EMC Support Matrix VMware ESX Server

 

You can download these guides from EMC Online Support (registration required): https://support.EMC.com

 

 

1.   

Set Jumpers on adapter board

Review your host computer documentation for slot recommendations that meet or exceed the HBA capabilities.

 

Set the HBA jumpers as shown in the figure below to enable it for use with the Intel-based VMware host.

 

 

 

2.   

Install Adapter in card slot

With host system power off, install the HBA(s) by following the instructions included with your adapter. The adapter installs into a single slot PCI bus.

 

Repeat the installation steps for each server in which you are installing Fibre Channel HBAs.

 

 

3.   

Apply power and boot

Reapply power and allow the system to boot normally. The V3.x VMware operating system will detect a new adaptor in the PCI bus and automatically load the appropriate driver in the VMkernel.

 

 

 

4.   

Check driver is installed:

To examine the VMkernel to ensure the driver was installed, enter:

 

vmkload_mod -l

 

 

7Table of Contents

 

·        Updating Emulex HBA firmware for VMware

 

Overview

This procedure describes how to intall the appropriate firmware for an Emulex HBA on the VMware ESX Server platform.

 

These procedures are based on content from the following EMC manuals:

  • EMC Host Connectivity Guide for VMware ESX Server
  • EMC Support Matrix VMware ESX Server

 

You can download these guides from EMC Online Support (registration required): https://support.EMC.com

 

Each Emulex Fibre Channel controller has a flash upgradeable firmware and boot BIOS. In most instances, it is necessary to keep only the firmware up to date, since the BIOS is applied only when using connected storage as a boot device.

 

Note: If you are upgrading the firmware and BIOS, you must update the firmware first as it may contain an older BIOS version, which can be updated separately later.

 

The support details in the E-Lab Interoperability Navigator (ESM) supersedes any example suggestions in this document.

 

 

1.   

Download the firmware:

Obtain the latest firmware from the Emulex website at http://www.emulex.com/ts/docoem/framemc.htm.

 

Include the kernel source/development package and the gcc complier tools during the installation. If these tools are not installed, then the RPM installation will fail and the driver will not be installed.

 

Each Emulex Fibre Channel controller has a flash upgradeable firmware and BIOS. In most instances, it is necessary to keep only the firmware up to date, since the BIOS is applied only when using connected storage as a boot device.

 

From this site, select the appropriate file for your adapter.  The files are typically in a .zip file that contains different combinations of firmware and BIOS images. Extract the downloaded file to a diskette, and refer to the included readme.txt to determine which filename image to use.    If you are planning to boot from an EMC storage array, you need to use the file that includes the boot BIOS. Select the boot BIOS under the BootBIOS/FCode link for your HBA.

Either of two methods can be used to update the firmware and boot BIOS:

 

  • METHOD ONE – Using lputil at the command line.  Updating the HBA Firmware and HBA boot BIOS with lputil.

  • METHOD TWO – Booting from a DOS bootable diskette and using the lp6dutil utility.

 

 

METHOD ONE - Using lputil at the command line:

 

Update the HBA Firmware with lputil as follows:

 

The lputil utility is dependent upon the existence of the Emulex driver; therefore, the operating system and the Emulex driver must be installed prior to using lputil.  The lputil utility is included in the Emulex Application Kit along with the HBA API and HBAnyware.

 

a.     Download the Emulex Application Kit from the EMC-approved section of the Emulex website (refer to link above).

b.    Copy the appropriate firmware file from the EMC-approved section of the Emulex website to the appropriate directory, /usr/sbin/lpfc.

The following table lists the HBA models and the name of the corresponding firmware files:

HBA Model

Firmware File

LP982-E

 

lfbXXX.all (where XXX is the version)

Example: lfb191a1.all

LP9002-E

 

cdcXXX.all (where XXX is the version)

Example: cdc392a2.all

LP9802-E

hdXXX.all (where XXX is the version)

Example: hd191a1.all

LP9802DC-E

 

hfXXX.all (where XXX is the version)

Example: hf191a1.all

LP1050-E

 

mfXXX.all (where XXX is the version)

Example: mf191a1.all

LP1050DC-E

 

mfXXX.all (where XXX is the version)

Example: mf191a1.all

LP1050EX-E

 

mfXXX.all (where XXX is the version)

Example: mf191a1.all

LP10000-E

tdXXX.all (where XXX is the version)

Example: td191a1.all

LP10000DC-E

 

tdXXX.all (where XXX is the version)

Example: td191a1.all

LP10000EXDC-E

 

tdXXX.all (where XXX is the version)

Example: td191a1.all

LP101-E

 

embXXX.all (where XXX is the version)

Example: emb191a1.all

LPe111-E

 

ymXXX.all (where XXX is the version)

Example: ym250a8.all

LPe1150-E

 

wfXXX.all (where XXX is the version)

Example: wf250a4.all

LPe11002-E

 

zfXXX.all (where XXX is the version)

Example: zf210a7.all

LP1150-E

 

jfXXX.all (where XXX is the version)

Example: jf250a4.all

LP11002-E

 

bfXXX.all (where XXX is the version)

Example: bf250a4.all

LP1005DC Mezzanine for

HPQ Blade Servers

mfXXX.all (where XXX is the version)

Example: mf191a2.all

LP1005-HP Mezzanine for HPQ Blade Servers

zfXXX.all (where XXX is the version)

Example: zf250a8.all

LP1005DC Mezzanine for

IBM Blade Servers

mfXXX.all (where XXX is the version)

Example: mf190a5.all

LP1005BC Mezzanine

for IBM Blade Servers

bfXXX.all (where XXX is the version)

Example: bf210a10.all

 

Each firmware file contains four files. The naming scheme of the files follows the format as shown in the example below for the LP9002 v3.92a2 firmware.


cdc392a2.dwc = contains the firmware with combination boot

cdc392a2.awc = contains the firmware with loader and combination boot

cd392a2.dwc = contains the firmware with no boot code

cd392a2.awc = contains the firmware with loader, no boot code

c.     Start the firmware update utility:

 

cd /usr/sbin/lpfc
./lputi
l

 

d.    Select Option 3 – Firmware Maintenance.

e.     Select the number of the adapter to update.

f.     Select Option 1 – Load Firmware Update.

g.    Enter the full name of the image file (as shown in the table above; for example, td190a4.all) and press Enter.

h.     Select Option 0 – Return to Main Menu.

i.      Repeat steps d through h for each additional adapter in the system.

j.      If you plan to update the firmware on the system that will allow the system to boot from the EMC storage array, then update the boot BIOS.

k.     If you do not plan to update the boot BIOS, then reboot the system.

Note: If you are using the HBA to boot from the SAN, update the boot BIOS immediately after updating the firmware as the firmware overwrites part of the boot BIOS.

 

Updating the HBA boot BIOS with lputil as follows:

 

a.     Ensure that the firmware has been updated prior to updating the boot BIOS.

b.    Download the appropriate boot BIOS file from the EMC-approved section of the Emulex website and copy it to the appropriate directory, /usr/sbin/lpfc:


HBA Model

Boot BIOS File

LP982-E

 

lbXXX.prg (where XXX is the version)

Example: lb170a3.prg

LP9002-E

 

cbXXX.prg (where XXX is the version)

Example: cb170a3.prg

LP9802-E

 

hbXXX.prg (where XXX is the version)

Example: hb170a3.prg

LP9802DC-E

 

hbXXX.prg (where XXX is the version)

Example: hb170a3.prg

LP1050-E

 

mbXXX.prg (where XXX is the version)

Example: mb170a3.prg

LP1050DC-E

 

mbXXX.prg (where XXX is the version)

Example: mb170a3.prg

LP1050EX-E

 

mbXXX.prg (where XXX is the version)

Example: mb170a3.prg

LP10000-E

 

tbvXXX.prg (where XXX is the version)

Example: tb170a3.prg

LP10000DC-E

 

tbXXX.prg (where XXX is the version)

Example: tb170a3.prg

LP10000EXDC-E

 

tbXXX.prg (where XXX is the version)

Example: tb170a3.prg

LP101-E

 

ebXXX.prg (where XXX is the version)

Example: eb170a3.prg

LPe111-E

 

ybXXX.all (where XXX is the version)

Example: yb170a3.prg

LPe1150-E

 

wbXXX.prg (where XXX is the version)

Example: wb170a3.prg

LPe11002-E

 

zbXXX.prg (where XXX is the version)

Example: zb170a3.prg

LP1150-E

 

jbXXX.prg (where XXX is the version)

Example: jb170a3.prg

LP11002-E

 

bbXXX.prg (where XXX is the version)

Example: bb170a3.prg

LP1005DC Mezzanine for

HPQ Blade Servers

 

mpXXX.prg (where XXX is the version)

Example: mp501a5.prg

LPe1105-HP Mezzanine for HPQ Blade Servers

zbXXX.prg (where XXX is the version)

Example: zb600a1.prg

LP1005DC Mezzanine for

IBM Blade Servers

mc XXX.prg (where XXX is the version)

Example: mc501a3.prg

LP1005BC Mezzanine for

IBM Blade Servers

buXXX.prg (where XXX is the version)

Example: bu502a1.prg

 

c.     Copy the file for Open Boot support from the EMC-approved section of the Emulex website to the appropriate directory, /usr/sbin/lpfc.

d.    Start the boot BIOS update utility:

 

cd /usr/sbin/lpfc
./lputil

 

e.     Select Option 3 – Firmware Maintenance.

f.     Select the adapter number to update.

g.    Select Option 1 – Load Firmware Update.

h.     Enter the full name of the image file (as shown in the table in item 1; for example, cd190a4.awc) and press Enter.

i.      Select Option 0 – Return to Main Menu.

j.      If desired, repeat steps d through h for each additional adapter in the system.

k.     Using lputil, choose the HBA that is to be used for booting from the fabric. Select Option 3 to enable the boot BIOS on the intended HBA.

l.      Reboot the system.


METHOD TWO - Booting from a DOS bootable diskette:

 

a.     Boot the computer using a DOS/WIN95/WIN98 bootable diskette.

b.    Insert the diskette containing the flash utility (LP6DUTIL.EXE).

c.     At the A:\> prompt, type lp6dutil and press Enter to start the utility.

The utility performs diagnostic tests on the installed adapter(s).  You may be required to press Enter after each test so the program can move on to the next test.  After the diagnostics are complete, the main menu appears.

d.    Type 5 and press Enter, to select Maintenance.

e.     Type 1 and press Enter, to select Upgrade Firmware.

f.     Enter the range of adapters to flash; for example: 1–4 (for four adapters).

g.    Enter the Firmware Image filename, including the path.  The firmware image file should be on the same disk as the LP6DUTIL.EXE program file.

h.     When prompted, type 1 and press Enter to proceed with the upgrade for the first controller.

i.      When prompted, type 1 and press Enter to reset the adapter after loading is complete.

j.      Repeat steps i and j for each adapter in the range entered earlier.

k.     When all adapters have been loaded, type 0 and press Enter at the Maintenance menu to return to the main menu.

l.      Type 7 and press Enter at the main menu to exit the flash utility.

 

 

2.   

Install the firmware

Follow these steps to install the firmware:

 

a.      Start the firmware update utility:

 

./lputil

 

a.      Select option 3 – Firmware Maintenance.

b.      Select the adapter number to update.

c.      Select option 1 – Load Firmware Image.

d.      Type the full file name of the image file (as shown in the table above; cd390a7.awc, for example) and press Enter.

 

Note: Select the proper release for the HBA you are configuring.

 

e.      Select option 0 – Return to Main Menu.

f.       For any other adapters, repeat these steps beginning with the step above where you select option 3 - Firmware Maintenance.

 

If the HBA driver is version 5.x or older, the host must reboot for the upgrade firmware to take effect.

 

 

7Table of Contents

 

 

·        Loading an in-kernel Emulex driver for VMware HBA

 

Overview

This procedure example for V3.x VMware ESX Server describes how to grab an appropriate Emulex driver from the VMkernel library (/usr/lib/VMware) and how to load and assign it to the specific HBA.

 

IMPORTANT:  Refer to the E-Lab Interoperability Navigator (ESM) for specific qualified kernel versions and distributions.  The support stated in the E-Lab Interoperability Navigator (ESM) supersedes versions and examples shown in this document.

 

This procedure is based on content from the following EMC manuals:

  • EMC Host Connectivity Guide for VMware ESX Server
  • EMC Support Matrix VMware ESX Server

 

You can download these guides from EMC Online Support (registration required): https://support.EMC.com

 

 

 

1.   

Engage the appropriate HBA driver

To engage an HBA driver:

Ensure that the /etc/modules.conf file references an entry for each installed Emulex HBA.

 

Fore each installed Emulex HBA, add an entry:

 

alias scsi_hostadapterN lpxxx

 

Where N is the sequential value of each Emulex HBA installed in the system, beginning with the number after the last host adapter number entry in the file. The first host bus adapter entry begins with zero and lpxxxx is the driver name for the adapter.

 

For example:

 

alias scsi_hostadapter1 lp1050

alias scsi_hostadapter1 lp10000

 

 

2.   

Run the vmkpcidiby utility:

Run the vmkpcidivy utility to create a boot configuration startup. This will automatically load the appropriate driver in the VMkernel.

 

 

3.   

Update the console configuration file:

To make the service console aware of newly installed hardware, log on to the service console as root and run the kudzu utility.  Type kudzu at the command prompt.

 

The kudzu utility detects any new hardware and adds appropriate entries to /etc/modules.conf

 

 

 

4.   

Reboot

Reboot the host if allowed.

 

 

 

7Table of Contents

 

·        Setting the FA port flags for a VMware host

 

Overview

This procedure describes how to set the appropriate port flags on the FA Fibre channel director for a V3.0 VMware ESX Server Host.

 

This procedure is based on content from the following EMC manuals:

  • EMC Host Connectivity Guide for VMware ESX Server
  • EMC Symmetrix Array Control CLI Product Guide (V6.1 or greater)
  • EMC Symmetrix Configuration Change CLI Product Guide (V6.0 only)

 

For your reference, please review Knowledge Base Article emc713378

 

You can download these guides from EMC Online Support (registration required): https://support.EMC.com

 

 

 

1.   

Look for the appropriate FA or ports :

Identify the appropriate FA ports available:

 

symcfg list –connections

 

 

2.   

Examine port flag settings:

View the port flags that are currently set. For example:

 

symcfg list –fa 03A –p 0 –v

 

The following flag-bits most likely need to be set:

 

·         Common Serial Number (C)

·         VCM State (VCM)

·         SCSI 3 (SC3) – required for older Enginuity versions: 5669 to 5670

·         SPC 2 (Decal) (SPC2)

·         Unique World Wide Name (UWWN) – not available on Gig-E adapter

·         Auto-negotiation (EAN)

 

Check E-Lab Navigator for exact settings required for your specific environment.

 

 

3.   

Build a command file to set port flags:

Create a command file, using a text editor. For example, call it PortFlags.txt with the following entries:

 

# C-Bit, if it needs setting:

set port 03A:0 Common_Serial_Number=enable;

set port 14B:0 Common_Serial_Number=enable;

# VCM-Bit, if it needs setting:

set port 03A:0 VCM_State=enable;

set port 14B:0 VCM_State=enable;

# SC3-Bit, if it needs setting,required for Enginuity 5669 to 5670:

set port 03A:0 scsi_3=enable;

set port 14B:0 scsi_3=enable;

# SP-2-Bit, if it needs setting,required for ESX Server v3.0:

set port 03A:0 SPC2_Protocol_Version=enable;

set port 14B:0 SPC2_Protocol_Version=enable;

# UWWN-Bit, if it needs setting:

# Note that the UWWN is set by default and not avail on Gig-E.

set port 03A:0 Unique_WWN=enable;

set port 14B:0 Unique_WWN=enable;

# EAN-Bit, if it needs setting

set port 03A:0 Auto_Negotiate=enable;

set port 14B:0 Auto_Negotiate=enable;

# PTOP-Bit, if it needs setting, required for FC-SW environments:

set port 03A:0 Init_Point_to_Point=enable;

set port 14B:0 Init_Point_to_Point=enable;

#End of command file

 

Check E-Lab Navigator for exact settings required for your specific environment.

 

4.   

Commit the file for execution:

Run the symconfigure command to commit the file (for example: PortFlags.txt):

 

symconfigure –sid 123 commit –f PortFlags.txt –v

 

 

 

5.   

Verify final flag settings:

Confirm the port flags were changed. For example::

 

symcfg list –fa 03A –p 0 -v

symcfg list –fa 14B –p 1 -v

 

 

 

 

7Table of Contents

 

·        Creating switch zones

 

Overview

For directions specific to Brocade switches, refer to the Brocade Fabric Manager Administrator’s Guide, which is located on Powerlink under the following location:

 

Home > Support > Documentation/White Paper Library > Hardware/Platforms Documentation > Connectrix Directors and Switches > Maintenance/Administration

 

Please refer to the section Managing Zones, which will provide the background information needed to configure and zone your fabric.

 

Note: There are multiple versions of the user guide available. Be sure to reference the version specific to your Fabric Manager version.

 

 

3.   

Create switch zones

Switch zones define paths between the host HBAs and the Symmetrix array and can be created using the switch management software (refer to the switch documentation).

 

Note:  If you are using an HP-UX server with QuickLoop zoning, then you must use port zoning.  Refer to EMC Knowledgebase article emc66355 for more information.

 

Definition -

Zoning is the process by which a single initiator is matched to a single storage array port (FA/SP) to be able to pass info to storage array device.

 

A Zone consists of 2 or more members, with only 1 initiator (HBA) per zone

A Zone is part of a zoneset .

A Zoneset is a collection of zones in a single fabric.

A Zoneset requires activation in order to be updated.

 

Important:  EMC Recommends single initiator zoning. To reduce the chance of data unavailability in the event that an HBA, switch, or FA Failure,  the host should have at least one primary path and one alternate path to each FA

 

 

4.   

Determine zoning configuration

Follow these steps to determine your zoning configuration:

a.      Determine the FA WWN by entering the following command:

symcfg –sid XXXX list –fa all

b.      Determine the HBA WWN by referencing the OS-specific commands from provisioning a host section.

c.      Determine the number of paths needed.

d.      Determine the Active Zone name.

The operations above must be performed on both fabrics for all FAs and HBAs.

 

5.   

Verify the HBA is logged in

Solutions Enabler offers a command line utility that will verify what is logged in to a specific Symmetrix FA. Use the following command:

 

symmask –sid SymmID –dir 3c –p 0 list logins

 

Where SymmID is the last four numbers of the Symmetrix serial number, 3c is the FA and 0 is the port on the FA.

 

It should also be noted that HBAs in an HP-UX host only show as logged in while there is active I/O.  However, if an entry exists in the login history table, it indicates that the HBA did log into the FA at some point.

 

After verifying that the host is logged in, move on to configuring the host.

 

 

7Table of Contents

 

 

·        Determine WWN of new HBA for VMware

 

Overview

This procedure describes how to determine the WWN of the newly installed HBA.

 

 

6.   

Determine HBA WWN:

To determine the WWN of the newly installed HBA, at the command line use the following QLogic form:

 

cat /proc/scsi/qla2300/# (instance number could be 0, 1, 2, 3,  …)

Or for Emulex:

 

cat /proc/scsi/lpfc/# (instance number could be 0, 1, 2, 3,  …)

This can also be verified by looking at the Fibre Channel Switch Port that the HBA is plugged in to.

 

 

 

7Table of Contents

 

·        Making LUNs or Devices available to VMware

 

Overview

This procedure describes how to make the devices or LUNs available or visible to a VMware host.

 

Note and Caution: If your host system cannot see the devices, it may necessary to do a disk or device scan of the I/O bus with this procedure. If you must, at an appropriate low-peak time in your production environment, apply the necessary operating system native commands, to perform a device scan (discover) to make the devices visible to the host workstation. This might take a few minutes or so to execute. Be sure you follow your operating system specific administrators guide and/or known site procedures for this operation, as scanning devices can cause pauses and crashes to other operational processes running on this host. If you can and prefer, a reboot will also accomplish the same thing (device discovery). The following steps are provided only as a general or possible guide and not meant to supersede your site preferences.

 

 

6.   

Open the VI Client on VMware server:

Using the Virtual Infostructure (VI) client on the VMware server, select the host and click the Configuration tab.

 

7.   

Rescan the specific adapter or adapters for devices:

In the Hardware panel, choose Storage Adapters, and then click Rescan above the Storage Adapters panel.

 

Or in the Hardware panel, select the individual adapter you are targeting and click Rescan to rescan just that adapter.

 

The rescan of the SAN environment can be also performed using the command line. If you have just installed a new Qlogic driver, you should first issue the following discovery command first:

 

echo “scsi_qlascan” > /proc/scsi/qla2300/<hba_id>

 

Rescan the SAN environment, using the command vmkfstools –s vmhbax. In this command, x, represents the instance number assigned by the VMkernel to the Fibre Channel HBA. For example, to rescan Fibre Channel adapter, vmhba0, type:

 

vmkfstools -s vmhba0

 

Note that rebooting will accomplish the same thing, but rescanning is less disruptive to your operational environment.

 

 

7Table of Contents