Solarflare ESXi ESXCLI Extension For Native Driver
==================================================
Version: 2.4.0.2016
Date: January 2021

Overview
--------
This is a feature release of the Solarflare ESXi ESXCLI Extension to be used with 
Solarflare Native VMware driver (sfvmk).

Supported ESXi Versions
-----------------------
Solarflare ESXi ESXCLI Extension supports ESXi 6.5 and 6.7.
  
Driver version
--------------

This package has been tested against the VMware ESXi 6.5/6.7 driver 
(SF-118824-LS and SF-118825-LS) version 2.4.0.1000

Installation
-------------
For installation, unzip the file and follow standard VMware process for 
installing VIB or Offline bundle. For detailed instructions please refer to the 
"Solarflare Server Adapter User's Guide" (part number SF-103837-CD) which is 
available as a PDF from <https://support.solarflare.com/>.

Please note whenever esxcli extension is installed, hostd needs to be restarted
in order to become visible to the esxcli infrastructure using the following command:

/etc/init.d/hostd restart


Usage
-----
 ~ ESXCLI extension commands can be executed locally on the host or remotely 
   using VCLI. VCLI can be installed from 
   https://code.vmware.com/tool/vsphere-cli/6.5 - similar links are available 
   for other ESXi versions also.
 ~ While using -f option of esxcli sfvmk firmware set command in VCLI mode, 
   please ensure that 
   a) the firmware file is available on the target host and 
   b) the path of the firmware file on the target host is specified in the command.

Support
-------
Please contact your local Solarflare support representative or email
<support@solarflare.com>.

Known Limitations
-----------------
  ~ esxcli framework doesn't allow incremental output from esxcli extension 
    commands. As a result the progress of firmware update can't be shown. In the 
    successful case, the firmware set command shall display the output to the 
    user when all the images have been successfully updated on (all) the NIC 
    card(s). Firmware set with -d option allows update of multiple firmware 
    images on all the NIC cards on a host. This command could take significant 
    time (order of minutes) before the results are shown.
  ~ For Bundle firmware aware cards V0, VD VPD fields display empty string 
    instead of bundle firmware version.


Changelog
---------
### v2.4.0.2016
 ~ Version number update

### v2.4.0.2012
 ~ Version number update

### v2.4.0.0022
 ~ Version number update
 ~ esxcli 64 Bit support added for ESXi 7.0

### v2.3.3.1004
 ~ Version number update.

### v2.3.0.0018 -- Update release
 ~ This release adds support for bundle firmware get and set 
 ~ Write firmware family information in the V0/ VD VPD fields

[General Fixes]
Issue 84475
 ~ sfvmk cli extension firmware set (-d option) will continue to update the next 
   firmware image even if one firmware image update fails


### v2.2.0.1004 -- Update release

 ~ This release adds following new ESXCLI extension commands
   sensor     esxcli extension to get hardware sensor information
   vib        esxcli extension to display the name of the VIB that provided this esxcli plugin

 ~ fec set command extended to take multiple FEC modes. For example to allow 
   RS->Baser fallback following command can be used
     esxcli sfvmk fec set -n vmnic -m rs,baser 
 ~ firmware set command supports update of SUC firmware type
 ~ firmware set command now provides a -d option which updates firmware from a 
   default location
   - There are two steps to use this option
      1. Install the firmware image vib (SF-121528-LS) on the host. This installs
         the firmware in a pre-defined default location.
      2 Execute esxcli firmware command with -d option to pick up the firmware 
         from the pre-defined default location and to update firmware on the NIC 
         cards on the host.
   - The following options can be specified along with -d option 
      -w    Overwrite firmware image even if firmware image version being 
            updated is same as the firmware image on the NIC card. 
      -t    Update specific firmware type images (controller/ bootrom/ uefirom/ suc)
      -n    Update images on specified adapter. 
   - All the firmware images on all the Solarflare adapters on a host can be
     updated by a single command
      esxcli sfvmk firmware set -d 
 ~ esxcli sfvmk vib get firmware set command now provides a -d option which 
   updates firmware from a default location


### v2.0.0.1010 -- First release

 ~ This is first release of ESXCLI extension
 ~ This release supports following ESXCLI extension commands
   fec        esxcli extension to get/ set FEC mode settings
   firmware   esxcli extension to get firmware version and update firmware image
   mclog      esxcli extension to get/ set the MC logging enable state
   stats      esxcli extension to get hardware queue statistics
   vpd        esxcli extension to get VPD information

   
Copyright
---------
Copyright (c) 2020-2021 Xilinx, Inc. All rights reserved.
Copyright 2017-2019 Solarflare Communications Inc.
Use is subject to license terms.