All about the hardware supported by XCP-ng
Hardware Compatibility List (HCL)
Devices listed on Citrix Hypervisor's Hardware Compatibility List are supported.
For other hardware, see Unlisted Hardware.
Many devices outside the HCL in fact work very well with XCP-ng. Being outside the HCL means that there have been not tests to ensure that they work. Most of the hardware support depends on the Linux kernel and thus support for hardware outside the HCL depends on on how well the drivers are supported by the Linux kernel included in XCP-ng.
This section is a community-enriched list of pieces of hardware that do not belong to the HCL, along with information about how well they work (or not), workarounds, etc.
Supermicro / AMD EPYC CPU
EPYC CPUs are working well on XCP-ng, but people with SuperMicro motherboard saw random reboot sometimes. Turning off the C-state control solved the issue:
- Advanced -> CPU Configuration -> Global C-state Control: Disabled
- Advanced -> North Bridge -> Determinism Slider: Performance
Emulex Corporation OneConnect NIC (Skyhawk) (rev 10) - 10Gbps NIC "OCe14102-NT"
Current State: Works, but sporadic card/port lockups - avoid in production!
- PCI-Vendor-ID: 10df (Emulex Corporation)
- PCI-Device-ID: 0720
- Downloads (long loading times, wait a bit!): https://www.broadcom.com/support/download-search/?pg=Legacy+Products&pf=Legacy+Products&pn=OCe14102-NT+Ethernet+Network+Adapter&pa=All&po=&dk=
Known to work (relatively stable) with latest Firmware 11.2.1153.23 on XCP-ng 7.5
- Bootable Upgrade ISO: https://docs.broadcom.com/docs/12378839update procedure twice to ensure that the flash regions are properly configured, and you must reboot the system after each firmware update." (from Release Notes)
* If you are coming from firmware below 10.0.803.37 -> "You must perform the firmware
- Firmware Release Notes: https://docs.broadcom.com/docs/12378898
- Linux Driver Release Notes: https://docs.broadcom.com/docs/1211170215974
Known Issues (with old firmware; also on XenServer 7.2 with current firmware)
- Card Lockup
- pulling the network cable puts the card in a locked state, LED's keeps flashing; putting the cable back does nothing; network connection stays lost
- Short Term: power off the host and pull power cords (the card needs to be completely powerless!, just switching the host OFF is not enough)
- Mid Term: Upgrade Firmware to match XCP-ng Driver version (for XCP-ng 7.5 -> 11.2.XXXXX)
- Long Term: Avoid Emulex cards!
Broadcom Netxtreme II BCM57711E
(or BCM5709 or ...)
On XCP-ng <= 8.0, using default
bnx2x driver triggers a kernel Oops on XCP-ng (no ping and freezing the host):
Fixed drivers have been released as official updates.
There are several USB 5Gbps NICs based on this chipset available on the market. A dedicated kernel module driver is available to add support to XCP-ng for (supposedly) all NICs based on Marvell (originally Aquantia) AQC111U over USB3. The driver should not be confused with the generic AQC111 that supports the whole family of NICs based on the AQC111 chipset, but NOT the ones connected over USB3. The kernel module provides support only for AQC111U-based NICs.
The kernel module is just a repackage for XCP-ng of the AQC111U drivers avaialble for Linux Kernel 3.10 on the Marvell website.
The kernel module has been tested in a homelab environment with XCP-ng version
To install the driver follow the instructions provided in the Alternate drivers section below and use
module-name would be
Known compatible NICs are1:
Despite the AQC111U-based adapters support the IEEE 802.3bz standard (AKA 5BASE-T) and will correctly negotiate with compatible peripherals the communication at 5Gbps, the actual bandwidth will not exceed 3.5Gbps due to the overhead of the incapsulation of the ethernet protocol over the 5Gbps connection via USB 3.0 (AKA USB 3.1 Gen 1).
XCP-ng occasionally provides alternate drivers for users who have issues with the main drivers installed with XCP-ng.
Those driver packages can be installed alongside the main packages and will take precedence gracefully.
Note: there is another way, albeit more experimental, to use alternate drivers: use our experimental alternate kernel (see dedicated section below).
In this section we provide instructions that are common to all the provided drivers.
package-name with the actual package name.
yum install package-name
The simplest way is to
Else, if you know the module name, you can unload it from the kernel and reload it.
modprobe -r module-name
modprobe -v module-name
If the driver does not work as intended, just remove the package from the system and follow the "Activation" steps above.
yum remove package-name
The alternate drivers may get updated to newer versions when the system is updated or upgraded. If that causes regressions, please open a bug report.
Upgrades using the installation ISO will not retain the alternate driver package, so remember to re-install it after the upgrade if it's still needed (the main driver may have been updated too and make the alternate driver useless in your case).
Upgrades using the
yum method will retain the alternate driver package, unless we stop providing it (usually, because the main driver will have been updated too). If the alternate driver is retained, it may have changed versions, so you may still need to consider going back to the main driver. If after an upgrade no driver works correctly for your system anymore, open a bug report.
Network drivers list
A list is maintained at https://github.com/xcp-ng/xcp/wiki/Drivers
Check the "XCP-ng X.Y alternate driver" column, which provides packages names and versions for every available alternate driver.
Additional kernel modules
Additional kernel modules are a lot like alternate drivers (most of the above section applies to them) except that they don't replace an existing driver from the system. They add a new one that didn't exist at all.
Their list is maintained at https://github.com/xcp-ng/xcp/wiki/Drivers, in a table named "Other kernel modules available in XCP-ng X.Y".
We provide an "alternate Linux kernel" on XCP-ng 8.0 and above, named
kernel-alt. It is kernel 4.19, as the main kernel, but with all updates from the Linux 4.19 branch applied. By construction, it should thus be stable. However it receives less testing so we cannot fully guarantee against regressions (any detected regression we'd work on a fix quickly, of course). We also backport security fixes from the main kernel to the alternate kernel when needed.
This kernel is mainly targeted at:
- Testing whether kernel.org fixes situations where the main kernel and drivers have issues on specific hardware.
- Allowing a system to work temporarily when the main kernel has an issue regarding your specific hardware, until we can fix the main kernel. For this to happen, you need to tell us if you are in a situation where the main kernel doesn't work whereas the alternate kernel does!
Report issues here.
During system installation
- In BIOS mode, press F2 at early boot stage when offered the choice then type
- In UEFI mode, select the boot option mentioning the alternate kernel from the grub menu.
This will boot the installer with the alternate kernel and also install the alternate kernel on the system in addition to the main one (but will not make the alternate kernel the default boot option for the installed system).
Installation on an existing system
You can install it using
yum install kernel-alt
This will install the kernel and add a grub boot menu entry to boot from it. It will not default to it unless you change the default in
/boot/efi/EFI/xenserver/grub.cfg depending on whether you are in BIOS mode or UEFI mode).
There may also be a newer release of kernel-alt in testing repositories:
yum install kernel-alt --enablerepo=xcp-ng-testing
Boot the main kernel, then:
yum remove kernel-alt
This will remove the added grub entry automatically too and set default boot to main kernel if needed.
Notes:1: There might be other NICs compatible as long as they are based on the Marvell AQC111U chip. [↩](#nt1)