Copyright(c) 2018 Intel Corporation

December 11, 2018
Version: 1.0.2

===============================================================================

Contents:
========
- Overview
- Supported Features
- Important Notes
- Installation
- Command Line Parameters
- Additional Notes

===============================================================================


Overview:
---------
Intel esxcli plug-in for managing Intel(r) Ethernet Network Adapters.
Intel esxcli plug-in supports configuring advanced features for Intel Ethernet 700 Series
Network adapters supported by i40en driver on ESXi 6.5 and ESXi 6.7.

The extended esxcli tool allows to set/get a Virtual Function (VF) with the following command line format


esxcli intnet sriovnic vf set [cmd options]

Cmd options:
  -t|--trusted         Set trusted mode to true or false (required).
  -s|--spoofchk        Set mac/vlan spoof check to true or false (optional).
  -v|--vfid=<long>     Specifies the VF id for the virtual function.
                       This must be one of the VF IDs listed by the sriovNic vf list command (required).
  -n|--vmnic=<str>     Specifies the name for the SRIOV NIC.
                       This must be one of the devices listed by the sriovNic list command (required).

The extended esxcli tool shall add command line support to list the current settings for a VF or for all VFs. The
supported command line will be


esxcli intnet sriovnic vf get [cmd options]

-v|--vfid=<long>      Specifies VF id of the virtual function that is the subject of the information query (optional).
-n|--vmnic=<str>      pecifies the name of the SRIOV NIC that is the subject of the information query.
                      This must be one of the devices listed by the sriovNic list command (required).

If -v or --vf-id is not provided, the output will list existing settings for all VFs


Supported Features:
-------------------
- Enable/Disable VF trust mode
- Enable/Sisable VF spoof-check
- Query current settings for VFs


Important Notes:
----------------

- Setting a VF is non-persistent
   It is required to set a VF to the desired operation every time after rebooting a VM or host since
   ESXi kernel may assign a different VF to the VM after reboot.


Installation:
-------------
1. Install the vib file
   esxcli software vib install -v <full path>/vib
2. Restart the ESXi host daemon
   /etc/init.d/hostd restart

"intnet" namespace in esxcli will be accessible to configure aforementioned features
if the plug-in install is successful.



Command Line Parameters:
------------------------
- Set VF 1 of vmnic0 as trusted
  esxcli intnet sriovnic vf set -t on -v 1 -n vmnic0

- Disable VF spoof-check for VF 1
  esxcli intnet sriovnic vf -v 1 -n vmnic0 -s off

- Get current settings for VF 1
  esxcli intnet sriovnic vf get -n vmnic0 -v 1

- Get current settings for all VFs
  esxcli intnet sriovnic vf get -n vmnic0


Additional Notes
----------------
- Trusted and spoof-check are boolean type. Therefore, the following parameter values are supported
  0, 1, n[o], y[es], f[alse], t[rue], off, on
- Trust and spoof-check features are independent, i.e. spoof-check can be disabled without enabling trusted mode
- Listing VFs and their VF ids is supported by the inbox esxcli command, i.e
     esxcli network sriovnic vf list -n vmnic5
- Find VMX Cartel ID displayed by esxcli network sriovnic vf list -n vmnicX
     esxcli vm process list