============================
R E A D M E    N O T E S
============================
QLogic qfle3f VMware ESX Native Driver for ESXi6.5/6.7
Copyright (c) 2015-2017 QLogic Corporation
Copyright (c) 2016-2018 Cavium Inc.
All rights reserved
Table of Contents
=================
1.  Introduction
2.  Using the Driver
3.  Driver Parameters
4.  Feature support
5.  MultiQueue/NetQueue
6.  Statistics
7.  Features under Development.
8.  Known Issues
9.  Contacting Support

1.   Introduction
     =============
This file describes the qfle3f Native VMware ESXi FCoE driver for QLogic 57XXX based 10Gb
PCIE Converged Network Controllers.

qfle3f is a native driver intended to replace bnx2fc.

OS Support:

   * ESXi6.5
   * ESXi6.7

2.   Using the Driver
     =================

Installing the Driver:
---------------------
You can use the driver zip bundle .zip or .vib to update existing driver or install new driver. Unzip the driver installer zip bundle and extract .vib file from it.

   The .vib or .zip file may be installed directly on an ESX server from the command line, or through the VMware Update Manager (VUM).

COMMAND LINE INSTALLATION
-------------------------

New Installation
----------------

   For new installs, you should perform the following steps:
   1. Copy the VIB or ZIP to the ESX server.  Technically, you can place the file anywhere that is accessible to the ESX console shell, but for these instructions, we'll assume the location is in '/tmp'.

   Here's an example of using the Linux 'scp' utility to copy the file
   from a local system to an ESX server located at 10.10.10.10:

#scp qfle3f-1.0.0.2-1vmw.650.0.0.7044253.x86_64.vib root@10.10.10.10:/tmp

2. Issue the following command (full path to the VIB must be specified):
   #esxcli software vib install -v {VIBFILE}

   In the example above, this would be:

   #esxcli software vib install -v /tmp/qfle3f-1.0.0.2-1vmw.650.0.0.7044253.x86_64.vib

In case you are installing using zip:
#esxcli software vib install -d /tmp/qfle3f-1.0.0.2-1vmw.650.0.0.7044253.x86_64.zip

Note: Depending on the certificate used to sign the VIB, you may need to change the host acceptance level.  To do this, use the following command:

   #esxcli software acceptance set --level=<level>

   Also, depending on the type of VIB being installed, you may have to put ESX into maintenance mode.  This can be done through the VI Client, or by adding the '--maintenance-mode' option to the above esxcli command.

Upgrade Installation
--------------------

The upgrade process is similar to a new install, except the command that should be issued is following:

   #esxcli software vib update -v /tmp/qfle3f-1.0.0.2-1vmw.650.0.0.7044253.x86_64.vib
Or

#esxcli software vib update -d /tmp/qfle3f-1.0.0.2-1vmw.650.0.0.7044253.x86_64.zip

VUM INSTALLATION
----------------

   The VMware Update Manager (VUM) is a plugin for the Virtual Center Server (vCenter Server).  You can use the VUM UI to install a VIB by importing the associated offline bundle package (a ZIP file that contains the VIB and metadata).  You can then create an add-on baseline and remediate the host(s) with this baseline. Please refer the vCenter Server documentation for more details on VUM.

Removing the Driver:
--------------------

   Removing the driver package can be accomplished using the following command:

   #esxcli software vib remove --vibname <vib-name>

   Eg. esxcli software vib remove --vibname qfle3f


3.   Driver Parameters
     ==================

The qfle3f driver settings can be queried using

#esxcli system module parameters list -m qfle3f
Or
# esxcfg-module -i qfle3f

----------------------------
qfle3f_debug_level :
----------------------------
Description: Enable more messaging from the driver.
Defaults: 0

----------------------------
qfle3f_devloss_tmo :
----------------------------
Description: parameter to adjust dev loss timout value, default 10 sec.
Defaults: 10

----------------------------
qfle3f_max_luns :
----------------------------
Description: parameter to adjust max LUNs supported by driver.
Default:0xFFFF

----------------------------
qfle3f_queue_depth :
----------------------------
Description: parameter to adjust per LUN max Q depth, default use OS settings.
Default:64

----------------------------
qfle3f_enable_r_a_tov :
----------------------------
Description: parameter to enable/disable user defined R_A_TOV.
Default:1

----------------------------
int qfle3f_r_a_tov :
----------------------------
Description: parameter to set the user define R_A_TOV value. This parameter is only applicable when qfle3f_enable_r_a_tov is set to 1.
Default:10

----------------------------
qfle3f_create_vmkMgmt_Entry
----------------------------
Description: Create the vmkMgmt Interface.
Default:1


The qfle3f driver settings can be changed using:

#esxcli system module parameters set -m qfle3f -p Param=Value

Or

#esxcfg-module -s Param=Value qfle3f

4.   Feature Support
     ================

1. Single Function Mode
2. Fabric Discovery
3. Scatter Gather IO
4. SCSI Error Handling

6.   Statistics
     ===========

Driver supports multiple statistics that can be fetched using below command:
<Insert command>

7.   Features under development
     ==========================

1. NPIV Support.

8.   Known Issues
     ============
1. System reboot/shutdown while NPIV port active.
------------------------------------------------
	In scenario where VMs with active NPIV enabled support are powered on, the ESX host
	reboot/shutdown will cause server to wait indefinitely. This is due to the
	fact that NPIV cleanup will not be invoked and NPIV io path remains active.
	So solution is to power off VMs completely before initiating ESX host
	reboot/shutdown.

2. Multiple FCoE VLAN:
-----------------------
	In the scenario where system is configured with multiple VLANs having FCoE
	capability, it may cause PSOD during module unload and system reboot or
	shutdown.
	Workaround is to have only a single Vlan configured for FCoE.

9.   Contacting Support
     ===================

Please feel free to contact your QLogic approved reseller or QLogic
Technical Support at any phase of integration for assistance. QLogic
Technical Support can be reached by the following methods:

 Web:    http://support.qlogic.com
 E-mail: support@qlogic.com


(c) Copyright 2016. All rights reserved worldwide. QLogic, the QLogic
logo, and the Powered by QLogic logo are registered trademarks of
QLogic Corporation. All other brand and product names are trademarks
or registered trademarks of their respective owners.


