Solarflare diagnostics (sfreport) for VMware ESXi Native Driver
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Version:  2.4.0.1000


Overview
--------
Solarflare diagnostics (sfreport) utility for VMware ESXi Native Driver
extracts system and driver specific information that is useful for debugging
purposes.


Supported ESXi Versions
-----------------------
sfreport utility supports ESXi 6.5, 6.7 and 7.0.


Compatibility
--------------
sfreport utility works with Python 2.6.9 and above. 


Installation
------------
Extract sfreport.py from tar file and copy it to a directory on the host server 
(if executing locally) or remote server (if executing remotely using vCLI). 


USAGE
-----
sfreport can be executed on the ESXi host where the "sfvmk" driver is loaded or 
from a remote server using "vCLI"

1. Run the sfreport from local Esxi host command-line using
"python sfreport.py" command and return the generated sfreport tarball to
support@solarflare.com.

2. sfreport can also be executed from a remote server meeting the following 
requirements:

• A server running the vSphere Management Assistant (VMA) which has vCLI and is 
compatible with ESXi version running on the host against which sfreport needs
to be executed. The target ESXi host must be reachable from the VMA host.

• A server with vCLI installed and able to reach the target ESXi host.
For complete instructions for vCLI installation, refer to the vSphere
Documentation Center (Category:Installing vCLI)

3. When sfreport is executed on a remote machine then some fields in the
sfreport are not available. It is then requested to execute vm-support
(https://kb.vmware.com/s/article/1010705)on the remote machine and provide
output of vm-support along with sfreport's output.

Known Issues
------------
N/A

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


Changelog
---------
### v2.4.0.1000 -- Feature release
  ~ The following bug fixes were incorporated:
    ~ Fix sfreport system summary for esxi mode [ESX7.0]
    ~ Fix vcli mode no-communication exit condition for sfreport
    ~ Fix Rx/Tx queue info table for vcli mode in sfreport
    ~ Fix GENEVE vib timeout and vib name in sfreport
    ~ Ignore vicfg-hostops error while running sfreport in vcli mode
	
	
### v2.3.3.1004 -- Feature release
  ~ The following diagnostics information has been added to sfreport:
    ~ SR-IOV information
    ~ Collapsible sections 
  ~ Bug fix to display SUC version heading in Firmware Version Table
  

### v2.3.0.0018 -- Feature release
  ~ Added support of text file reporting in ESXi sfreport
  ~ sfreport is now a tar file which has both the HTML file and text file
  ~ Bug fixes
   

### v2.2.0.1002 -- Feature release
 ~ The following diagnostics information has been added to sfreport:
   ~ Hardware sensor information
   ~ CIM debug logs
 ~ Bug fixes to error case handling


### v2.0.0.1010 -- First release
[Features supported]
 ~ The following ESXi host information is reported by sfreport:
   ~ System Summary
   ~ Software Versions
   ~ VPD Information
   ~ Driver Bindings
   ~ Sfvmk Parameters
   ~ Ethernet Settings
   ~ Network Configuration
   ~ SF PCI Devices
   ~ File Properties
   ~ ARP Cache
   ~ Virtual Machine
   ~ vSwitch
   ~ LACP
   ~ Portgroup Information
   ~ GENEVE
   ~ VXLAN
   ~ Interface Statistics
   ~ HW Statistics
   ~ NetQueue Summary
   ~ SF Module File Names
   ~ Known Kernel Modules
   ~ NUMA Information
   ~ VMkernel Logs
   ~ PCI Configuration 
   
NOTE: Some of the information is not available when sfreport is executed on a 
remote machine.


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