============================
R E A D M E    N O T E S
============================
QLogic qcnic 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.  Features under Development.
6.  Known Issues
7.  Contacting Support

1.   Introduction
     =============
This file describes the qcnic Native VMware ESXi driver (storage support bridge) for
QLogic 57XXX based 10Gb PCIE Converged Network Controllers.

qcnic is a native driver intended to replace cnic.

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 qcnic-1.0.0.21-1OEM.650.0.0.4240417.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/qcnic-1.0.0.21-1OEM.650.0.0.4240417.x86_64.vib

In case you are installing using zip:
#esxcli software vib install -d /tmp/qcnic-1.0.0.21-1OEM.650.0.0.4240417.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/qcnic-1.0.0.21-1OEM.650.0.0.4240417.x86_64.vib
Or

#esxcli software vib update -d /tmp/qcnic-1.0.0.21-1OEM.650.0.0.4240417.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 qcnic


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

The qcnic driver settings can be queried using

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

esxcfg-module module information
input file: /usr/lib/vmware/vmkmod/qcnic
License: ThirdParty:QLogic Proprietary
Version: 1.0.0.21-1OEM.650.0.0.4240417
Name-space:
Required name-spaces:
com.vmware.vmkapi@v2_4_0_0
Parameters:
cnic_debug: long
Set driver debug msglevel.
Default: 0x0
Valid Range: 0x0-0x8000000
Brief description:
============
CNIC_MSG_DRV        = 0x0001,     <== basic driver logs
CNIC_MSG_INIT       = 0x0002,     <== Driver initialization logs
CNIC_MSG_SESS       = 0x0010,     <== session/connection logs
CNIC_MSG_NW         = 0x400000,   <== LL2 path logs
CNIC_MSG_EVENT      = 0x800000,   <== nic-to-cnic event notification logs
CNIC_MSG_INTR       = 0x1000000,  <== driver interrupt handler logs
CNIC_MSG_MEM        = 0x2000000,  <== driver memory tracing logs
CNIC_MSG_CTL        = 0x4000000,  <== cnic-to-nic messaging logs
CNIC_MSG_DEBUGFS    = 0x8000000,  <== high verbose logging
============
cnic_dump_kwqe_en: long
parameter to enable (1)/disable (0) kwqe (single work-queue element message) logging.
Default: 0x1
Valid Range: 0x0 (disable) - 0x1 (enable)

The qcnic driver settings can be changed using:

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

Or

#esxcfg-module -s <param>=<value> qcnic

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

1. Single Function Mode
2. iSCSI Support
3. FCoE Support
4. Multi Function storage support.
5. iSCSI OOO

5.   Features under development
     ==========================
- None.

6.   Known Issues
     ============
- None.


7.   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.
