summaryrefslogtreecommitdiff
path: root/docs/vpp
diff options
context:
space:
mode:
authorAlexandr K. <o.kuchmystyi@vyos.io>2026-03-20 12:29:23 +0300
committerGitHub <noreply@github.com>2026-03-20 09:29:23 +0000
commitcc5f2e5db89617d82ece6688e9f79d51384ff4c9 (patch)
tree430bd6f8a73c98e641e0965ddd9c9157fc6d9659 /docs/vpp
parentba74f42db3fd72defd9b414897cf2a51daf2b48d (diff)
downloadvyos-documentation-cc5f2e5db89617d82ece6688e9f79d51384ff4c9.tar.gz
vyos-documentation-cc5f2e5db89617d82ece6688e9f79d51384ff4c9.zip
vpp: T8315: Update NIC requirements and add supported hardware list (#1792)
Diffstat (limited to 'docs/vpp')
-rw-r--r--docs/vpp/requirements.rst78
1 files changed, 69 insertions, 9 deletions
diff --git a/docs/vpp/requirements.rst b/docs/vpp/requirements.rst
index 77d494e1..edecc5fd 100644
--- a/docs/vpp/requirements.rst
+++ b/docs/vpp/requirements.rst
@@ -50,16 +50,76 @@ prerequisites before enabling VPP:
* **Network Interface Cards (NICs)**
- .. warning::
+ .. warning::
- VyOS supports only specific NICs for VPP Dataplane. Unsupported NICs may
- cause activation failures, initialization errors, crashes, or
- degraded performance.
+ VyOS supports only specific NICs for the VPP dataplane. Using unsupported
+ hardware may cause activation failures, initialization errors, crashes,
+ or degraded performance.
- Supported NICs:
+ When enabling VPP, VyOS checks detected network interfaces against a list
+ of validated NICs. Validation is based on the **PCI ID** of the device or
+ the **kernel driver** used by the interface.
- - IntelĀ® Ethernet Network Adapter E810-2CQDA2
- - NVIDIA/Mellanox ConnectX-5
- - VirtIO
+ Supported NICs:
- Other NICs may work but are not officially supported.
+ .. list-table::
+ :widths: 15 18 40 35
+ :header-rows: 1
+
+ * - **Filter Type**
+ - **Filter Value**
+ - **NIC Name/Description**
+ - **Platform Where NIC Can Be Found**
+ * - PCI ID
+ - 15b3:1019
+ - Mellanox Technologies MT28800 Family
+ [ConnectX-5 Ex]
+ - Bare-metal
+ * - PCI ID
+ - 15b3:101d
+ - Mellanox Technologies MT2892 Family
+ [ConnectX-6 Dx]
+ - Bare-metal
+ * - PCI ID
+ - 15b3:101e
+ - Mellanox Technologies ConnectX Family
+ mlx5Gen Virtual Function
+ - Oracle Cloud
+ * - PCI ID
+ - 8086:1592
+ - Intel Corporation Ethernet Controller
+ E810-C for QSFP
+ - Bare-metal
+ * - PCI ID
+ - 1ae0:0042
+ - Google, Inc. Compute Engine Virtual
+ Ethernet [gVNIC]
+ - Google Cloud
+ * - PCI ID
+ - 1af4:1000
+ - Red Hat, Inc. Virtio network device
+ - KVM-based hypervisors, including with
+ Open vSwitch; Google Cloud
+ * - PCI ID
+ - 1d0f:ec20
+ - Amazon.com, Inc. Elastic Network
+ Adapter (ENA)
+ - AWS
+ * - Kernel Driver
+ - hv_netvsc
+ - Microsoft Hyper-V network interface
+ card
+ - Microsoft Azure
+
+ If no supported NIC is detected, VPP activation will be rejected.
+
+ In testing or advanced deployments, unsupported hardware can be explicitly
+ allowed in the configuration:
+
+ .. cfgcmd:: set vpp settings allow-unsupported-nics
+
+ .. note::
+
+ This option bypass the hardware validation checks for the specified
+ devices. Stability and performance are not guaranteed when using
+ unsupported NICs or drivers.