Sign Up for the Quarterly Newsletter

USB Network Native Driver for ESXi

USB has become one the most widely adopted connection type in the world & USB network adapters are also popular among Edge computing platforms. In some platforms, there is either limited or no PCI/PCIe slots for I/O expansion & in some cases, an Ethernet port is not even available. Another advantage of a USB-based network adapter is that it can be hot-plugged into an system without a reboot which means no impact to the workload, same is true for hot-remove.

This Fling supports the most popular USB network adapter chipsets found in the market. The ASIX USB 2.0 gigabit network ASIX88178a, ASIX USB 3.0 gigabit network ASIX88179, Realtek USB 3.0 gigabit network RTL8152/RTL8153 and Aquantia AQC111U. These are relatively inexpensive devices that many of our existing vSphere customers are already using and are familiar with.

  • VMware ESXi 6.5 or 6.7
  • USB Network Adapter with AX88178a, AX88179, RTL8152 or RTL8153 Chipset
Any adapters using the following chipsets and with the following VID/PID are supported.

VendorChipsetVendorIDProductID
ASIXAX881790x0b950x1790
ASIXAX88178a0x0b950x178a
CISCO LINKSYSRTL81530x13b10x0041
DLINKAX881790x20010x4a00
LENOVOAX881790x17ef0x304b
LENOVORTL81530x17ef0x7205
LENOVORTL81530x17ef0x3069
LENOVORTL81530x17ef0x720a
LENOVORTL81530x17ef0x3062
NVIDIARTL81530x09550x09ff
QNAPAQC111U 0x1c04 0x0015
REALTEKRTL81530x0bda0x8153
REALTEKRTL81520x0bda0x8152
SITECOMEUAX881790x0df60x0072
TP-LINKRTL81530x23570x0601

Step 1 - Download the ZIP file for the specific version of your ESXi host and upload to ESXi host using SCP or Datastore Browser

Step 2 - Place the ESXi host into Maintenance Mode using the vSphere UI or CLI (e.g. esxcli system maintenanceMode set -e true)

Step 3 - Install the Offline Bundle by running the following command on ESXi Shell:
esxcli software vib install -d /path/to/the offline bundle
Step 4 - Plug-in the USB NIC and reboot for the change to go into effect. Once the host has rebooted, ESXi should automatically pickup and claim the USB NIC (e.g. vusb0)

Note: Secure Boot can not be enabled if you decide to use the USB NIC as your primary NIC for Management Network. Since the settings do not persist, you will need to create a startup script (see Instructions for more details) and this is not allowed when Secure Boot is enabled. If USB NIC is not your primary NIC for the Management Network, then you do not have to disable Secure Boot

Persisting USB NIC Bindings

Currently there is a limitation in ESXi where USB NIC bindings are picked up much later in the boot process and to ensure settings are preserved upon a reboot, the following needs to be added to /etc/rc.local.d/local.sh based on your configurations.

Standard Virtual Switch (VSS)

Here is an example which binds the physical USB NIC (vsub0) to Standard vSwitch and the respective portgroups that are also attached on the VSS
vusb0_status=$(esxcli network nic get -n vusb0 | grep 'Link Status' | awk '{print $NF}')
count=0
while [[ $count -lt 20 && "${vusb0_status}" != "Up" ]]
do
    sleep 10
    count=$(( $count + 1 ))
    vusb0_status=$(esxcli network nic get -n vusb0 | grep 'Link Status' | awk '{print $NF}')
done

if [ "${vusb0_status}" = "Up" ]; then
    esxcfg-vswitch -L vusb0 vSwitch0
    esxcfg-vswitch -M vusb0 -p "Management Network" vSwitch0
    esxcfg-vswitch -M vusb0 -p "VM Network" vSwitch0
fi

Distributed Virtual Switch (VDS)

Here is an example which binds the physical USB NIC (vsub0) to a Distributed Virtual Switch (VDS). You will need to update both VDS_NAME and VDS_PORT_ID variable to match your enviornment
VDS_NAME=VDS
VDS_PORT_ID=8

vusb0_status=$(esxcli network nic get -n vusb0 | grep 'Link Status' | awk '{print $NF}')
count=0
while [[ $count -lt 20 && "${vusb0_status}" != "Up" ]]
do
    sleep 10
    count=$(( $count + 1 ))
    vusb0_status=$(esxcli network nic get -n vusb0 | grep 'Link Status' | awk '{print $NF}')
done

if [ "${vusb0_status}" = "Up" ]; then
    esxcfg-vswitch -P vusb0 -V ${VDS_PORT_ID} ${VDS_NAME}
fi
September 27, 2019 - v1.2
  • Added support for Aquantia Multi-Gig (1G/2.5G/5G) USB network adapter (see Requirements page for more details)
  • Added support for Auto Speed/Connection detection for RTL8153/RTL8152 chipsets
ESXi670-VMKUSB-NIC-FLING-28903484-offline_bundle-14722970.zip
ESXi650-VMKUSB-NIC-FLING-28903792-offline_bundle-14722993.zip

June 17, 2019 - v1.1
  • Added support for 9 additional USB NIC devices including USB 2.0 RTL8152 & TPLINK (see Requirements page for complete list)
  • Added support for Jumbo Frames (up to 4K) for RTL8153 & AX88179
ESXi670-VMKUSB-NIC-FLING-24524132-offline_bundle-13958648.zip
ESXi650-VMKUSB-NIC-FLING-24599816-offline_bundle-13964320.zip

February 12, 2019 - v1.0 (Initial Release)

ESXi670-VMKUSB-NIC-FLING-20124247-offline_bundle-11613968
ESXi650-VMKUSB-NIC-FLING-20123976-offline_bundle-11613344