summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/vpp/configuration/interfaces/bridge.rst88
-rw-r--r--docs/vpp/configuration/interfaces/gre.rst123
-rw-r--r--docs/vpp/configuration/interfaces/index.rst3
-rw-r--r--docs/vpp/configuration/interfaces/ipip.rst67
-rw-r--r--docs/vpp/configuration/interfaces/kernel.rst234
-rw-r--r--docs/vpp/configuration/interfaces/loopback.rst96
-rw-r--r--docs/vpp/configuration/interfaces/vxlan.rst102
-rw-r--r--docs/vpp/configuration/interfaces/xconnect.rst45
8 files changed, 301 insertions, 457 deletions
diff --git a/docs/vpp/configuration/interfaces/bridge.rst b/docs/vpp/configuration/interfaces/bridge.rst
index 15608433..91cd2cdb 100644
--- a/docs/vpp/configuration/interfaces/bridge.rst
+++ b/docs/vpp/configuration/interfaces/bridge.rst
@@ -30,25 +30,25 @@ Basic Configuration
Creating a Bridge Interface
^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. cfgcmd:: set vpp interfaces bridge <brN>
+.. cfgcmd:: set interfaces vpp bridge <vppbrN>
- Create a bridge interface where ``<brN>`` follows the naming convention br1, br2, etc.
+ Create a bridge interface where ``<vppbrN>`` follows the naming convention vppbr1, vppbr2, etc.
.. note::
- Bridge domain br0 is reserved by VPP and cannot be configured through VyOS. Start with br1 for your bridge configurations.
+ Bridge domain vppbr0 is reserved by VPP and cannot be configured through VyOS. Start with vppbr1 for your bridge configurations.
**Example:**
.. code-block:: none
- set vpp interfaces bridge br1
+ set interfaces vpp bridge vppbr1
Interface Description
^^^^^^^^^^^^^^^^^^^^^
-.. cfgcmd:: set vpp interfaces bridge <brN> description <description>
+.. cfgcmd:: set interfaces vpp bridge <vppbrN> description <description>
Set a descriptive name for the bridge interface.
@@ -56,14 +56,7 @@ Interface Description
.. code-block:: none
- set vpp interfaces bridge br1 description "Main campus bridge"
-
-Administrative Control
-^^^^^^^^^^^^^^^^^^^^^^
-
-.. cfgcmd:: set vpp interfaces bridge <brN> disable
-
- Administratively disable the bridge interface. By default, bridge interfaces are enabled when created.
+ set interfaces vpp bridge vppbr1 description "Main campus bridge"
Member Interface Configuration
------------------------------
@@ -71,7 +64,7 @@ Member Interface Configuration
Adding Member Interfaces
^^^^^^^^^^^^^^^^^^^^^^^^
-.. cfgcmd:: set vpp interfaces bridge <brN> member interface <interface-name>
+.. cfgcmd:: set interfaces vpp bridge <vppbrN> member interface <interface-name>
Add an interface as a member of the bridge.
@@ -80,19 +73,19 @@ Adding Member Interfaces
.. code-block:: none
# Add physical interfaces
- set vpp interfaces bridge br1 member interface eth0
- set vpp interfaces bridge br1 member interface eth1
+ set interfaces vpp bridge vppbr1 member interface eth0
+ set interfaces vpp bridge vppbr1 member interface eth1
# Add other VPP interfaces
- set vpp interfaces bridge br1 member interface bond0
- set vpp interfaces bridge br1 member interface gre1
+ set interfaces vpp bridge vppbr1 member interface vppbond0
+ set interfaces vpp bridge vppbr1 member interface vppgre1
.. important::
Bridge members can include various interface types such as:
* Physical Ethernet interfaces (eth0, eth1, etc.)
- * :doc:`bonding` - VPP bonding interfaces (bond0, bond1, etc.)
+ * :doc:`bonding` - VPP bonding interfaces (vppbond0, vppbond1, etc.)
* :doc:`gre` - GRE tunnel interfaces
* :doc:`loopback` - Loopback interfaces
* :doc:`vxlan` - VXLAN tunnel interfaces
@@ -105,7 +98,7 @@ A Bridge Virtual Interface (BVI) provides Layer 3 connectivity to a bridge domai
Configuring BVI
^^^^^^^^^^^^^^^
-.. cfgcmd:: set vpp interfaces bridge <brN> member interface <loopback-interface> bvi
+.. cfgcmd:: set interfaces vpp bridge <vppbrN> member interface <loopback-interface> bvi
Designate a loopback interface as the Bridge Virtual Interface for the bridge domain.
@@ -114,10 +107,10 @@ Configuring BVI
.. code-block:: none
# Create a loopback interface first
- set vpp interfaces loopback lo1
+ set interfaces vpp loopback vpplo1
# Add it to the bridge as BVI
- set vpp interfaces bridge br1 member interface lo1 bvi
+ set interfaces vpp bridge vppbr1 member interface vpplo1 bvi
.. important::
@@ -135,13 +128,13 @@ Basic Bridge Setup
.. code-block:: none
# Create bridge interface
- set vpp interfaces bridge br1
- set vpp interfaces bridge br1 description "Office network bridge"
+ set interfaces vpp bridge vppbr1
+ set interfaces vpp bridge vppbr1 description "Office network bridge"
# Add member interfaces
- set vpp interfaces bridge br1 member interface eth0
- set vpp interfaces bridge br1 member interface eth1
- set vpp interfaces bridge br1 member interface eth2
+ set interfaces vpp bridge vppbr1 member interface eth0
+ set interfaces vpp bridge vppbr1 member interface eth1
+ set interfaces vpp bridge vppbr1 member interface eth2
Bridge with BVI
^^^^^^^^^^^^^^^
@@ -149,14 +142,14 @@ Bridge with BVI
.. code-block:: none
# Create bridge and loopback for BVI
- set vpp interfaces bridge br2
- set vpp interfaces bridge br2 description "Server segment with gateway"
- set vpp interfaces loopback lo1
+ set interfaces vpp bridge vppbr2
+ set interfaces vpp bridge vppbr2 description "Server segment with gateway"
+ set interfaces vpp loopback vpplo1
# Configure bridge members
- set vpp interfaces bridge br2 member interface eth3
- set vpp interfaces bridge br2 member interface eth4
- set vpp interfaces bridge br2 member interface lo1 bvi
+ set interfaces vpp bridge vppbr2 member interface eth3
+ set interfaces vpp bridge vppbr2 member interface eth4
+ set interfaces vpp bridge vppbr2 member interface vpplo1 bvi
Multi-Technology Bridge
^^^^^^^^^^^^^^^^^^^^^^^
@@ -164,37 +157,34 @@ Multi-Technology Bridge
.. code-block:: none
# Create bridge combining different interface types
- set vpp interfaces bridge br3
- set vpp interfaces bridge br3 description "Hybrid network bridge"
+ set interfaces vpp bridge vppbr3
+ set interfaces vpp bridge vppbr3 description "Hybrid network bridge"
# Add various interface types
- set vpp interfaces bridge br3 member interface bond1
- set vpp interfaces bridge br3 member interface gre1
- set vpp interfaces bridge br3 member interface vxlan1
- set vpp interfaces bridge br3 member interface lo2 bvi
+ set interfaces vpp bridge vppbr3 member interface vppbond1
+ set interfaces vpp bridge vppbr3 member interface vppgre1
+ set interfaces vpp bridge vppbr3 member interface vppvxlan1
+ set interfaces vpp bridge vppbr3 member interface vpplo2 bvi
Integration with Kernel Interfaces
----------------------------------
Bridge interfaces can be integrated with kernel interfaces for management and compatibility with standard Linux networking services. This is accomplished by binding a kernel interface to the Bridge Virtual Interface (BVI).
-For detailed information about kernel interface integration, see :doc:`kernel`.
-
**Example Integration:**
.. code-block:: none
# Create VPP bridge with member interfaces
- set vpp interfaces bridge br1
- set vpp interfaces bridge br1 member interface eth1
- set vpp interfaces bridge br1 member interface eth2
+ set interfaces vpp bridge vppbr1
+ set interfaces vpp bridge vppbr1 member interface eth1
+ set interfaces vpp bridge vppbr1 member interface eth2
# Create loopback interface and configure as BVI
- set vpp interfaces loopback lo1
- set vpp interfaces bridge br1 member interface lo1 bvi
+ set interfaces vpp loopback vpplo1
+ set interfaces vpp bridge vppbr1 member interface vpplo1 bvi
- # Bind kernel interface to the BVI loopback
- set vpp interfaces loopback lo1 kernel-interface 'vpptun1'
- set vpp kernel-interfaces vpptun1 address '192.0.2.1/24'
+ # Bind LCP kernel interface to the BVI loopback
+ set interfaces vpp loopback vpplo1 address '192.0.2.1/24'
This configuration creates a kernel interface bound to the BVI, allowing standard Linux applications and routing daemons to interact with the VPP bridge. The kernel interface provides Layer 3 access to the bridge domain.
diff --git a/docs/vpp/configuration/interfaces/gre.rst b/docs/vpp/configuration/interfaces/gre.rst
index 464734b6..dbb29805 100644
--- a/docs/vpp/configuration/interfaces/gre.rst
+++ b/docs/vpp/configuration/interfaces/gre.rst
@@ -16,15 +16,15 @@ Basic Configuration
Creating a GRE Interface
^^^^^^^^^^^^^^^^^^^^^^^^^
-.. cfgcmd:: set vpp interfaces gre <greN>
+.. cfgcmd:: set interfaces vpp gre <vppgreN>
- Create a GRE interface where ``<greN>`` follows the naming convention gre1, gre2, etc.
+ Create a GRE interface where ``<vppgreN>`` follows the naming convention vppgre1, vppgre2, etc.
-.. cfgcmd:: set vpp interfaces gre <greN> remote <address>
+.. cfgcmd:: set interfaces vpp gre <vppgreN> remote <address>
Set the tunnel remote endpoint address. Supports both IPv4 and IPv6 addresses.
-.. cfgcmd:: set vpp interfaces gre <greN> source-address <address>
+.. cfgcmd:: set interfaces vpp gre <vppgreN> source-address <address>
Set the tunnel source address. Must match an address configured on the local system.
@@ -32,9 +32,9 @@ Creating a GRE Interface
.. code-block:: none
- set vpp interfaces gre gre1
- set vpp interfaces gre gre1 remote 203.0.113.2
- set vpp interfaces gre gre1 source-address 192.168.1.1
+ set interfaces vpp gre vppgre1
+ set interfaces vpp gre vppgre1 remote 203.0.113.2
+ set interfaces vpp gre vppgre1 source-address 192.168.1.1
Interface Configuration
-----------------------
@@ -42,28 +42,18 @@ Interface Configuration
Description and Administrative Control
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. cfgcmd:: set vpp interfaces gre <greN> description <description>
+.. cfgcmd:: set interfaces vpp gre <vppgreN> description <description>
Set a descriptive name for the GRE interface.
-.. cfgcmd:: set vpp interfaces gre <greN> disable
+.. cfgcmd:: set interfaces vpp gre <vppgreN> disable
Administratively disable the GRE interface.
-Tunnel Mode
-^^^^^^^^^^^
-
-.. cfgcmd:: set vpp interfaces gre <greN> mode <mode>
-
- Configure the GRE tunnel operating mode:
-
- * ``point-to-point`` - Default mode for direct tunnel between two endpoints
- * ``point-to-multipoint`` - Allows multiple remote endpoints
-
Tunnel Type
^^^^^^^^^^^
-.. cfgcmd:: set vpp interfaces gre <greN> tunnel-type <type>
+.. cfgcmd:: set interfaces vpp gre <vppgreN> tunnel-type <type>
Set the GRE tunnel encapsulation type:
@@ -74,11 +64,42 @@ Tunnel Type
Kernel Interface Integration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. cfgcmd:: set vpp interfaces gre <greN> kernel-interface <interface-name>
+LCP kernel pair interface bound to the VPP GRE interface is created automatically. This allows standard Linux networking tools and services to interact with the VPP GRE.
+
+IP Address Configuration
+------------------------
+
+.. cfgcmd:: set interfaces vpp gre <vppgreN> address <ip-address/prefix>
+
+ Configure IPv4 or IPv6 addresses on the kernel interface. Multiple addresses can be assigned.
+
+**Examples:**
+
+.. code-block:: none
+
+ # IPv4 address
+ set interfaces vpp gre vppgre0 address 192.168.1.10/24
+
+ # IPv6 address
+ set interfaces vpp gre vppgre0 address 2001:db8::10/64
+
+MTU Configuration
+-----------------
+
+.. cfgcmd:: set interfaces vpp gre <vppgreN> mtu <size>
- Bind a kernel interface to the GRE tunnel for management and application compatibility.
+ Set the Maximum Transmission Unit (MTU) for the kernel interface. The MTU must be compatible with the connected VPP interface.
+
+**Example:**
+
+.. code-block:: none
+
+ set interfaces vpp gre vppgre0 mtu 9000
+
+.. note::
+
+ Ensure the MTU setting matches or is smaller than the MTU supported by the associated VPP interface to avoid issues.
-For detailed information about kernel interface integration, see :doc:`kernel`.
Configuration Examples
----------------------
@@ -89,11 +110,11 @@ Layer 3 GRE Tunnel
.. code-block:: none
# IPv4 GRE tunnel
- set vpp interfaces gre gre1
- set vpp interfaces gre gre1 description "Site-to-site tunnel"
- set vpp interfaces gre gre1 remote 203.0.113.10
- set vpp interfaces gre gre1 source-address 192.168.1.1
- set vpp interfaces gre gre1 tunnel-type l3
+ set interfaces vpp gre vppgre1
+ set interfaces vpp gre vppgre1 description "Site-to-site tunnel"
+ set interfaces vpp gre vppgre1 remote 203.0.113.10
+ set interfaces vpp gre vppgre1 source-address 192.168.1.1
+ set interfaces vpp gre vppgre1 tunnel-type l3
Layer 2 GRE Tunnel (TEB)
^^^^^^^^^^^^^^^^^^^^^^^^
@@ -101,11 +122,11 @@ Layer 2 GRE Tunnel (TEB)
.. code-block:: none
# Transparent Ethernet Bridge
- set vpp interfaces gre gre2
- set vpp interfaces gre gre2 description "L2 extension tunnel"
- set vpp interfaces gre gre2 remote 203.0.113.20
- set vpp interfaces gre gre2 source-address 192.168.1.1
- set vpp interfaces gre gre2 tunnel-type teb
+ set interfaces vpp gre vppgre2
+ set interfaces vpp gre vppgre2 description "L2 extension tunnel"
+ set interfaces vpp gre vppgre2 remote 203.0.113.20
+ set interfaces vpp gre vppgre2 source-address 192.168.1.1
+ set interfaces vpp gre vppgre2 tunnel-type teb
IPv6 GRE Tunnel
^^^^^^^^^^^^^^^
@@ -113,24 +134,9 @@ IPv6 GRE Tunnel
.. code-block:: none
# IPv6 endpoints
- set vpp interfaces gre gre3
- set vpp interfaces gre gre3 remote 2001:db8::2
- set vpp interfaces gre gre3 source-address 2001:db8::1
-
-Point-to-Multipoint Configuration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. code-block:: none
-
- # Hub configuration for multiple spokes
- set vpp interfaces gre gre4
- set vpp interfaces gre gre4 mode point-to-multipoint
- set vpp interfaces gre gre4 remote 0.0.0.0
- set vpp interfaces gre gre4 source-address 192.168.1.1
-
-.. note::
-
- For point-to-multipoint mode, the remote address must be set to 0.0.0.0 to allow multiple remote endpoints.
+ set interfaces vpp gre vppgre3
+ set interfaces vpp gre vppgre3 remote 2001:db8::2
+ set interfaces vpp gre vppgre3 source-address 2001:db8::1
GRE with Kernel Interface
^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -138,11 +144,10 @@ GRE with Kernel Interface
.. code-block:: none
# GRE tunnel with management interface
- set vpp interfaces gre gre5
- set vpp interfaces gre gre5 remote 203.0.113.30
- set vpp interfaces gre gre5 source-address 192.168.1.1
- set vpp interfaces gre gre5 kernel-interface vpptun5
- set vpp kernel-interfaces vpptun5 address 10.0.1.1/30
+ set interfaces vpp gre vppgre4
+ set interfaces vpp gre vppgre4 remote 203.0.113.30
+ set interfaces vpp gre vppgre4 source-address 192.168.1.1
+ set interfaces vpp gre vppgre4 address 10.0.1.1/30
Bridge Integration
------------------
@@ -152,6 +157,6 @@ GRE interfaces can be added as members to VPP bridges for Layer 2 switching. See
.. code-block:: none
# Add TEB GRE tunnel to bridge
- set vpp interfaces bridge br1
- set vpp interfaces bridge br1 member interface gre2
- set vpp interfaces bridge br1 member interface eth1
+ set interfaces vpp bridge vppbr1
+ set interfaces vpp bridge vppbr1 member interface vppgre2
+ set interfaces vpp bridge vppbr1 member interface eth1
diff --git a/docs/vpp/configuration/interfaces/index.rst b/docs/vpp/configuration/interfaces/index.rst
index ebbf577e..b9739ed2 100644
--- a/docs/vpp/configuration/interfaces/index.rst
+++ b/docs/vpp/configuration/interfaces/index.rst
@@ -16,7 +16,6 @@ VPP Interfaces Configuration
bridge
gre
ipip
- kernel
loopback
vxlan
xconnect
@@ -35,6 +34,6 @@ VPP interfaces offer several advantages:
Integration with Kernel
^^^^^^^^^^^^^^^^^^^^^^^
-However, if needed, VyOS provides seamless integration between VPP and kernel networking. For detailed information about kernel interface integration, see :doc:`kernel`.
+However, VyOS provides seamless integration between VPP and kernel networking.
This allows you to leverage the strengths of both approaches - create interfaces inside VPP, but still have them accessible from the Linux kernel and other services side.
diff --git a/docs/vpp/configuration/interfaces/ipip.rst b/docs/vpp/configuration/interfaces/ipip.rst
index 92ceba91..f56add85 100644
--- a/docs/vpp/configuration/interfaces/ipip.rst
+++ b/docs/vpp/configuration/interfaces/ipip.rst
@@ -16,15 +16,15 @@ Basic Configuration
Creating an IPIP Interface
^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. cfgcmd:: set vpp interfaces ipip <ipipN>
+.. cfgcmd:: set interfaces vpp ipip <vppipipN>
- Create an IPIP interface where ``<ipipN>`` follows the naming convention ipip1, ipip2, etc.
+ Create an IPIP interface where ``<vppipipN>`` follows the naming convention vppipip1, vppipip2, etc.
-.. cfgcmd:: set vpp interfaces ipip <ipipN> remote <address>
+.. cfgcmd:: set interfaces vpp ipip <vppipipN> remote <address>
Set the tunnel remote endpoint address. Supports both IPv4 and IPv6 addresses.
-.. cfgcmd:: set vpp interfaces ipip <ipipN> source-address <address>
+.. cfgcmd:: set interfaces vpp ipip <vppipipN> source-address <address>
Set the tunnel source address. Must match an address configured on the local system.
@@ -32,9 +32,9 @@ Creating an IPIP Interface
.. code-block:: none
- set vpp interfaces ipip ipip1
- set vpp interfaces ipip ipip1 remote 203.0.113.2
- set vpp interfaces ipip ipip1 source-address 192.168.1.1
+ set interfaces vpp ipip vppipip1
+ set interfaces vpp ipip vppipip1 remote 203.0.113.2
+ set interfaces vpp ipip vppipip1 source-address 192.168.1.1
Interface Configuration
-----------------------
@@ -42,22 +42,42 @@ Interface Configuration
Description and Administrative Control
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. cfgcmd:: set vpp interfaces ipip <ipipN> description <description>
+.. cfgcmd:: set interfaces vpp ipip <vppipipN> description <description>
Set a descriptive name for the IPIP interface.
-.. cfgcmd:: set vpp interfaces ipip <ipipN> disable
+.. cfgcmd:: set interfaces vpp ipip <vppipipN> disable
Administratively disable the IPIP interface.
Kernel Interface Integration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. cfgcmd:: set vpp interfaces ipip <ipipN> kernel-interface <interface-name>
+Kernel interface is bounded to the VPP IPIP interface for management and application compatibility.
- Bind a kernel interface to the IPIP tunnel for management and application compatibility.
+IP Address Configuration
+------------------------
-For detailed information about kernel interface integration, see :doc:`kernel`.
+.. cfgcmd:: set interfaces vpp ipip <vppipipN> address <ip-address/prefix>
+
+ Configure IPv4 or IPv6 addresses on the kernel interface. Multiple addresses can be assigned.
+
+**Examples:**
+
+.. code-block:: none
+
+ # IPv4 address
+ set interfaces vpp ipip vppipip0 address 192.168.1.10/24
+
+ # IPv6 address
+ set interfaces vpp ipip vppipip0 address 2001:db8::10/64
+
+MTU Configuration
+-----------------
+
+.. cfgcmd:: set interfaces vpp ipip <vppipipN> mtu <size>
+
+ Set the Maximum Transmission Unit (MTU) for the kernel interface. The MTU must be compatible with the connected VPP interface.
Configuration Examples
----------------------
@@ -68,10 +88,10 @@ IPv4 IPIP Tunnel
.. code-block:: none
# Basic IPv4 IPIP tunnel
- set vpp interfaces ipip ipip1
- set vpp interfaces ipip ipip1 description "Site-to-site IPIP tunnel"
- set vpp interfaces ipip ipip1 remote 203.0.113.10
- set vpp interfaces ipip ipip1 source-address 192.168.1.1
+ set interfaces vpp ipip vppipip1
+ set interfaces vpp ipip vppipip1 description "Site-to-site IPIP tunnel"
+ set interfaces vpp ipip vppipip1 remote 203.0.113.10
+ set interfaces vpp ipip vppipip1 source-address 192.168.1.1
IPv6 IPIP Tunnel
^^^^^^^^^^^^^^^^
@@ -79,9 +99,9 @@ IPv6 IPIP Tunnel
.. code-block:: none
# IPv6 endpoints
- set vpp interfaces ipip ipip2
- set vpp interfaces ipip ipip2 remote 2001:db8::2
- set vpp interfaces ipip ipip2 source-address 2001:db8::1
+ set interfaces vpp ipip vppipip2
+ set interfaces vpp ipip vppipip2 remote 2001:db8::2
+ set interfaces vpp ipip vppipip2 source-address 2001:db8::1
IPIP with Kernel Interface
^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -89,8 +109,7 @@ IPIP with Kernel Interface
.. code-block:: none
# IPIP tunnel with management interface
- set vpp interfaces ipip ipip3
- set vpp interfaces ipip ipip3 remote 203.0.113.30
- set vpp interfaces ipip ipip3 source-address 192.168.1.1
- set vpp interfaces ipip ipip3 kernel-interface vpptun3
- set vpp kernel-interfaces vpptun3 address 10.0.2.1/30
+ set interfaces vpp ipip vppipip3
+ set interfaces vpp ipip vppipip3 remote 203.0.113.30
+ set interfaces vpp ipip vppipip3 source-address 192.168.1.1
+ set interfaces vpp ipip vppipip3 address 10.0.2.1/30
diff --git a/docs/vpp/configuration/interfaces/kernel.rst b/docs/vpp/configuration/interfaces/kernel.rst
deleted file mode 100644
index 29d4bb4d..00000000
--- a/docs/vpp/configuration/interfaces/kernel.rst
+++ /dev/null
@@ -1,234 +0,0 @@
-:lastproofread: 2025-09-04
-
-.. _vpp_config_interfaces_kernel:
-
-.. include:: /_include/need_improvement.txt
-
-###################################
-VPP Kernel Interfaces Configuration
-###################################
-
-VPP kernel interfaces provide a bridge between the high-performance VPP data plane and the Linux kernel networking stack. These interfaces appear as standard network interfaces in the kernel while being transparently connected to VPP interfaces, enabling seamless integration between VPP processing and kernel-based applications.
-
-**How Kernel Interfaces Work:**
-
-* Traffic sent to the kernel interface by any application or kernel is forwarded to the connected VPP interface
-* Traffic processed within VPP is sent to the kernel interface only if VPP cannot handle it (e.g., no matching route)
-* Standard Linux networking tools and daemons can interact with VPP interfaces
-
-**Use Cases:**
-
-* Integrating VPP interfaces with routing daemons (FRR, BIRD)
-* Providing management access to VPP-processed networks
-* Running standard network services on VPP interfaces
-
-Interface Types: TUN vs TAP
----------------------------
-
-VPP kernel interfaces support two types of virtual network interfaces that differ in how they handle network traffic.
-
-**TAP Interfaces (vpptapN)**
-
-TAP interfaces operate at Layer 2 (Data Link Layer) and work with complete Ethernet frames. They process full Ethernet packets including MAC addresses and headers, making them suitable for scenarios where you need complete Layer 2 functionality. TAP interfaces can participate in bridging and switching operations, and they provide native support for VLAN tagging and sub-interfaces. This makes them ideal for Layer 2 connectivity, bridging setups, and VLAN segmentation.
-
-**TUN Interfaces (vpptunN)**
-
-TUN interfaces operate at Layer 3 (Network Layer) and handle raw IP packets without Ethernet headers. They are optimized for Layer 3 routing operations and have lower processing overhead due to their simpler packet structure. TUN interfaces are typically used for VPN tunnels, point-to-point links, and routing applications where Layer 2 functionality is not required.
-
-**Choosing the Right Interface Type**
-
-The choice between TUN and TAP depends on your specific networking requirements. Use TAP interfaces when you need Layer 2 functionality such as bridging, VLANs, or full Ethernet compatibility. Choose TUN interfaces when you only need Layer 3 functionality for routing or VPN scenarios. While TAP interfaces are more versatile, they have slightly higher overhead compared to TUN interfaces, which are more efficient for pure routing scenarios.
-
-.. note::
-
- The interface type is determined by the naming convention: ``vpptapN`` creates TAP interfaces, while ``vpptunN`` creates TUN interfaces. Both support the same configuration commands but behave differently at the packet processing level.
-
-Basic Configuration
--------------------
-
-Creating a Kernel Interface
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. cfgcmd:: set vpp kernel-interfaces <interface-name>
-
- Create a kernel interface. The interface name follows the convention ``vpptapN`` or ``vpptunN``.
-
-**Example:**
-
-.. code-block:: none
-
- set vpp kernel-interfaces vpptap1
-
-Interface Description
-^^^^^^^^^^^^^^^^^^^^^
-
-.. cfgcmd:: set vpp kernel-interfaces <interface-name> description <description>
-
- Set a descriptive name for the kernel interface.
-
-**Example:**
-
-.. code-block:: none
-
- set vpp kernel-interfaces vpptap1 description "Management interface for VPP bond"
-
-Administrative Control
-^^^^^^^^^^^^^^^^^^^^^^
-
-.. cfgcmd:: set vpp kernel-interfaces <interface-name> disable
-
- Administratively disable the kernel interface. By default, interfaces are enabled.
-
-IP Address Configuration
-------------------------
-
-.. cfgcmd:: set vpp kernel-interfaces <interface-name> address <ip-address/prefix>
-
- Configure IPv4 or IPv6 addresses on the kernel interface. Multiple addresses can be assigned.
-
-**Examples:**
-
-.. code-block:: none
-
- # IPv4 address
- set vpp kernel-interfaces vpptap1 address 192.168.1.10/24
-
- # IPv6 address
- set vpp kernel-interfaces vpptap1 address 2001:db8::10/64
-
- # Multiple addresses
- set vpp kernel-interfaces vpptap1 address 192.168.1.10/24
- set vpp kernel-interfaces vpptap1 address 10.0.0.10/8
-
-MTU Configuration
------------------
-
-.. cfgcmd:: set vpp kernel-interfaces <interface-name> mtu <size>
-
- Set the Maximum Transmission Unit (MTU) for the kernel interface. The MTU must be compatible with the connected VPP interface.
-
-**Example:**
-
-.. code-block:: none
-
- set vpp kernel-interfaces vpptap1 mtu 9000
-
-.. note::
-
- Ensure the MTU setting matches or is smaller than the MTU supported by the associated VPP interface to avoid issues.
-
-VLAN Configuration
-------------------
-
-VPP kernel interfaces support VLAN (Virtual LAN) sub-interfaces for network segmentation.
-
-Creating VLAN Sub-interfaces
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. cfgcmd:: set vpp kernel-interfaces <interface-name> vif <vlan-id>
-
- Create a VLAN sub-interface with the specified VLAN ID (0-4094).
-
-**Example:**
-
-.. code-block:: none
-
- set vpp kernel-interfaces vpptap1 vif 100
-
-VLAN Sub-interface Configuration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-VLAN sub-interfaces support the same configuration options as the parent interface:
-
-.. cfgcmd:: set vpp kernel-interfaces <interface-name> vif <vlan-id> address <ip-address/prefix>
-
-.. cfgcmd:: set vpp kernel-interfaces <interface-name> vif <vlan-id> description <description>
-
-.. cfgcmd:: set vpp kernel-interfaces <interface-name> vif <vlan-id> disable
-
-.. cfgcmd:: set vpp kernel-interfaces <interface-name> vif <vlan-id> mtu <size>
-
-**Examples:**
-
-.. code-block:: none
-
- # Configure VLAN 100
- set vpp kernel-interfaces vpptap1 vif 100 address 192.168.100.1/24
- set vpp kernel-interfaces vpptap1 vif 100 description "Management VLAN"
- set vpp kernel-interfaces vpptap1 vif 100 mtu 1500
-
- # Configure VLAN 200
- set vpp kernel-interfaces vpptap1 vif 200 address 192.168.200.1/24
- set vpp kernel-interfaces vpptap1 vif 200 description "Guest VLAN"
-
-Configuration Examples
-----------------------
-
-Basic Kernel Interface
-^^^^^^^^^^^^^^^^^^^^^^
-
-.. code-block:: none
-
- # Create basic kernel interface
- set vpp kernel-interfaces vpptap1
- set vpp kernel-interfaces vpptap1 description "VPP-Kernel bridge"
- set vpp kernel-interfaces vpptap1 address 192.168.1.10/24
- set vpp kernel-interfaces vpptap1 mtu 1500
- set vpp settings interface-rx-mode adaptive
-
-High-Performance Interface
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. code-block:: none
-
- # High-throughput configuration
- set vpp kernel-interfaces vpptap2
- set vpp kernel-interfaces vpptap2 description "High-performance bridge"
- set vpp kernel-interfaces vpptap2 address 10.0.0.10/8
- set vpp kernel-interfaces vpptap2 mtu 9000
- set vpp settings interface-rx-mode polling
-
-Multi-VLAN Setup
-^^^^^^^^^^^^^^^^
-
-.. code-block:: none
-
- # Parent interface
- set vpp kernel-interfaces vpptap3
- set vpp kernel-interfaces vpptap3 description "Multi-VLAN trunk"
-
- # Management VLAN
- set vpp kernel-interfaces vpptap3 vif 10
- set vpp kernel-interfaces vpptap3 vif 10 address 192.168.10.1/24
- set vpp kernel-interfaces vpptap3 vif 10 description "Management network"
-
- # Production VLAN
- set vpp kernel-interfaces vpptap3 vif 20
- set vpp kernel-interfaces vpptap3 vif 20 address 192.168.20.1/24
- set vpp kernel-interfaces vpptap3 vif 20 description "Production network"
-
- # Guest VLAN
- set vpp kernel-interfaces vpptap3 vif 30
- set vpp kernel-interfaces vpptap3 vif 30 address 192.168.30.1/24
- set vpp kernel-interfaces vpptap3 vif 30 description "Guest network"
-
-Bonding Integration
-^^^^^^^^^^^^^^^^^^^
-
-.. code-block:: none
-
- # Create VPP bonding interface
- set vpp interfaces bonding bond0
- set vpp interfaces bonding bond0 member interface eth0
- set vpp interfaces bonding bond0 member interface eth1
- set vpp interfaces bonding bond0 kernel-interface vpptap1
-
- # Configure the kernel interface for the bond
- set vpp kernel-interfaces vpptap1 address 192.168.1.10/24
- set vpp kernel-interfaces vpptap1 description "Bond management interface"
-
-Best Practices
---------------
-
-* Use kernel interfaces selectively - not every VPP interface needs kernel exposure and also not all VPP interface types support kernel interfaces
-* Consider the performance impact of copying traffic between VPP and kernel
diff --git a/docs/vpp/configuration/interfaces/loopback.rst b/docs/vpp/configuration/interfaces/loopback.rst
index 082124d2..1fd66899 100644
--- a/docs/vpp/configuration/interfaces/loopback.rst
+++ b/docs/vpp/configuration/interfaces/loopback.rst
@@ -16,15 +16,15 @@ Basic Configuration
Creating a Loopback Interface
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. cfgcmd:: set vpp interfaces loopback <loN>
+.. cfgcmd:: set interfaces vpp loopback <vpploN>
- Create a loopback interface where ``<loN>`` follows the naming convention lo1, lo2, etc.
+ Create a loopback interface where ``<vpploN>`` follows the naming convention vpplo1, vpplo2, etc.
**Basic Example:**
.. code-block:: none
- set vpp interfaces loopback lo1
+ set interfaces vpp loopback vpplo1
Interface Configuration
-----------------------
@@ -32,22 +32,80 @@ Interface Configuration
Description and Administrative Control
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. cfgcmd:: set vpp interfaces loopback <loN> description <description>
+.. cfgcmd:: set interfaces vpp loopback <vpploN> description <description>
Set a descriptive name for the loopback interface.
-.. cfgcmd:: set vpp interfaces loopback <loN> disable
+.. cfgcmd:: set interfaces vpp loopback <vpploN> disable
Administratively disable the loopback interface.
Kernel Interface Integration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. cfgcmd:: set vpp interfaces loopback <loN> kernel-interface <interface-name>
+Kernel interface is bounded to the VPP loopback interface for management and application compatibility.
- Bind a kernel interface to the loopback interface for management and application compatibility.
+IP Address Configuration
+------------------------
-For detailed information about kernel interface integration, see :doc:`kernel`.
+.. cfgcmd:: set interfaces vpp loopback <vpploN> address <ip-address/prefix>
+
+ Configure IPv4 or IPv6 addresses on the kernel interface. Multiple addresses can be assigned.
+
+**Examples:**
+
+.. code-block:: none
+
+ # IPv4 address
+ set interfaces vpp loopback vpplo1 address 192.168.1.10/24
+
+ # IPv6 address
+ set interfaces vpp loopback vpplo1 address 2001:db8::10/64
+
+MTU Configuration
+-----------------
+
+.. cfgcmd:: set interfaces vpp loopback <vpploN> mtu <size>
+
+ Set the Maximum Transmission Unit (MTU) for the kernel interface. The MTU must be compatible with the connected VPP interface.
+
+VLAN Configuration
+------------------
+
+VPP kernel interfaces support VLAN (Virtual LAN) sub-interfaces for network segmentation.
+
+Creating VLAN Sub-interfaces
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. cfgcmd:: set interfaces vpp loopback <vpploN> vif <vlan-id>
+
+ Create a VLAN sub-interface with the specified VLAN ID (0-4094).
+
+VLAN Sub-interface Configuration
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+VLAN sub-interfaces support the same configuration options as the parent interface:
+
+.. cfgcmd:: set interfaces vpp loopback <vpploN> vif <vlan-id> address <ip-address/prefix>
+
+.. cfgcmd:: set interfaces vpp loopback <vpploN> vif <vlan-id> description <description>
+
+.. cfgcmd:: set interfaces vpp loopback <vpploN> vif <vlan-id> disable
+
+.. cfgcmd:: set interfaces vpp loopback <vpploN> vif <vlan-id> mtu <size>
+
+**Examples:**
+
+.. code-block:: none
+
+ # Configure VLAN 100
+ set interfaces vpp loopback vpplo1 vif 100 address 192.168.100.1/24
+ set interfaces vpp loopback vpplo1 vif 100 description "Management VLAN"
+ set interfaces vpp loopback vpplo1 vif 100 mtu 1500
+
+ # Configure VLAN 200
+ set interfaces vpp loopback vpplo1 vif 200 address 192.168.200.1/24
+ set interfaces vpp loopback vpplo1 vif 200 description "Guest VLAN"
Configuration Examples
----------------------
@@ -58,8 +116,8 @@ Basic Loopback Interface
.. code-block:: none
# Create simple loopback
- set vpp interfaces loopback lo1
- set vpp interfaces loopback lo1 description "Router ID interface"
+ set interfaces vpp loopback vpplo1
+ set interfaces vpp loopback vpplo1 description "Router ID interface"
Loopback with Kernel Interface
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -67,10 +125,9 @@ Loopback with Kernel Interface
.. code-block:: none
# Loopback with management access
- set vpp interfaces loopback lo2
- set vpp interfaces loopback lo2 description "Management loopback"
- set vpp interfaces loopback lo2 kernel-interface vpptun2
- set vpp kernel-interfaces vpptun2 address 10.255.255.1/32
+ set interfaces vpp loopback vpplo2
+ set interfaces vpp loopback vpplo2 description "Management loopback"
+ set interfaces vpp loopback vpplo2 address 10.255.255.1/32
Bridge Virtual Interface (BVI)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -78,9 +135,8 @@ Bridge Virtual Interface (BVI)
.. code-block:: none
# Loopback as BVI for bridge
- set vpp interfaces loopback lo3
- set vpp interfaces loopback lo3 description "Bridge gateway interface"
- set vpp interfaces bridge br1
- set vpp interfaces bridge br1 member interface lo3 bvi
- set vpp interfaces loopback lo3 kernel-interface vpptun3
- set vpp kernel-interfaces vpptun3 address 192.168.100.1/24
+ set interfaces vpp loopback vpplo3
+ set interfaces vpp loopback vpplo3 description "Bridge gateway interface"
+ set interfaces vpp bridge vppbr1
+ set interfaces vpp bridge vppbr1 member interface vpplo3 bvi
+ set interfaces vpp loopback vpplo3 address 192.168.100.1/24
diff --git a/docs/vpp/configuration/interfaces/vxlan.rst b/docs/vpp/configuration/interfaces/vxlan.rst
index af48bc2d..08765fa4 100644
--- a/docs/vpp/configuration/interfaces/vxlan.rst
+++ b/docs/vpp/configuration/interfaces/vxlan.rst
@@ -16,19 +16,19 @@ Basic Configuration
Creating a VXLAN Interface
^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. cfgcmd:: set vpp interfaces vxlan <vxlanN>
+.. cfgcmd:: set interfaces vpp vxlan <vppvxlanN>
- Create a VXLAN interface where ``<vxlanN>`` follows the naming convention vxlan1, vxlan2, etc.
+ Create a VXLAN interface where ``<vppvxlanN>`` follows the naming convention vppvxlan1, vppvxlan2, etc.
-.. cfgcmd:: set vpp interfaces vxlan <vxlanN> vni <vni>
+.. cfgcmd:: set interfaces vpp vxlan <vppvxlanN> vni <vni>
Set the Virtual Network Identifier (VNI) for the VXLAN tunnel. Valid range is 0-16777214.
-.. cfgcmd:: set vpp interfaces vxlan <vxlanN> remote <address>
+.. cfgcmd:: set interfaces vpp vxlan <vppvxlanN> remote <address>
Set the tunnel remote endpoint address. Supports both IPv4 and IPv6 addresses.
-.. cfgcmd:: set vpp interfaces vxlan <vxlanN> source-address <address>
+.. cfgcmd:: set interfaces vpp vxlan <vppvxlanN> source-address <address>
Set the tunnel source address. Must match an address configured on the local system.
@@ -36,10 +36,10 @@ Creating a VXLAN Interface
.. code-block:: none
- set vpp interfaces vxlan vxlan1
- set vpp interfaces vxlan vxlan1 vni 100
- set vpp interfaces vxlan vxlan1 remote 203.0.113.2
- set vpp interfaces vxlan vxlan1 source-address 192.168.1.1
+ set interfaces vpp vxlan vppvxlan1
+ set interfaces vpp vxlan vppvxlan1 vni 100
+ set interfaces vpp vxlan vppvxlan1 remote 203.0.113.2
+ set interfaces vpp vxlan vppvxlan1 source-address 192.168.1.1
Interface Configuration
-----------------------
@@ -47,22 +47,39 @@ Interface Configuration
Description and Administrative Control
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. cfgcmd:: set vpp interfaces vxlan <vxlanN> description <description>
+.. cfgcmd:: set interfaces vpp vxlan <vppvxlanN> description <description>
Set a descriptive name for the VXLAN interface.
-.. cfgcmd:: set vpp interfaces vxlan <vxlanN> disable
+.. cfgcmd:: set interfaces vpp vxlan <vppvxlanN> disable
Administratively disable the VXLAN interface.
Kernel Interface Integration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. cfgcmd:: set vpp interfaces vxlan <vxlanN> kernel-interface <interface-name>
+Kernel interface is bounded to the VXLAN tunnel for management and application compatibility.
- Bind a kernel interface to the VXLAN tunnel for management and application compatibility.
+IP Address Configuration
+------------------------
-For detailed information about kernel interface integration, see :doc:`kernel`.
+.. cfgcmd:: set interfaces vpp vxlan <vppvxlanN> address <ip-address/prefix>
+
+ Configure IPv4 or IPv6 addresses on the kernel interface. Multiple addresses can be assigned.
+
+**Examples:**
+
+.. code-block:: none
+
+ set interfaces vpp vxlan vppvxlan1 address 192.168.1.10/24
+ set interfaces vpp vxlan vppvxlan1 address 2001:db8::10/64
+
+MTU Configuration
+-----------------
+
+.. cfgcmd:: set interfaces vpp vxlan <vppvxlanN> mtu <size>
+
+ Set the Maximum Transmission Unit (MTU) for the kernel interface. The MTU must be compatible with the connected VPP interface.
Configuration Examples
----------------------
@@ -73,11 +90,11 @@ Basic VXLAN Tunnel
.. code-block:: none
# IPv4 VXLAN tunnel
- set vpp interfaces vxlan vxlan1
- set vpp interfaces vxlan vxlan1 description "Tenant A network extension"
- set vpp interfaces vxlan vxlan1 vni 1000
- set vpp interfaces vxlan vxlan1 remote 203.0.113.10
- set vpp interfaces vxlan vxlan1 source-address 192.168.1.1
+ set interfaces vpp vxlan vppvxlan1
+ set interfaces vpp vxlan vppvxlan1 description "Tenant A network extension"
+ set interfaces vpp vxlan vppvxlan1 vni 1000
+ set interfaces vpp vxlan vppvxlan1 remote 203.0.113.10
+ set interfaces vpp vxlan vppvxlan1 source-address 192.168.1.1
IPv6 VXLAN Tunnel
^^^^^^^^^^^^^^^^^
@@ -85,10 +102,10 @@ IPv6 VXLAN Tunnel
.. code-block:: none
# IPv6 endpoints
- set vpp interfaces vxlan vxlan2
- set vpp interfaces vxlan vxlan2 vni 2000
- set vpp interfaces vxlan vxlan2 remote 2001:db8::2
- set vpp interfaces vxlan vxlan2 source-address 2001:db8::1
+ set interfaces vpp vxlan vppvxlan2
+ set interfaces vpp vxlan vppvxlan2 vni 2000
+ set interfaces vpp vxlan vppvxlan2 remote 2001:db8::2
+ set interfaces vpp vxlan vppvxlan2 source-address 2001:db8::1
VXLAN with Kernel Interface
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -96,12 +113,11 @@ VXLAN with Kernel Interface
.. code-block:: none
# VXLAN tunnel with management interface
- set vpp interfaces vxlan vxlan3
- set vpp interfaces vxlan vxlan3 vni 3000
- set vpp interfaces vxlan vxlan3 remote 203.0.113.30
- set vpp interfaces vxlan vxlan3 source-address 192.168.1.1
- set vpp interfaces vxlan vxlan3 kernel-interface vpptap3
- set vpp kernel-interfaces vpptap3 address 10.0.3.1/24
+ set interfaces vpp vxlan vppvxlan3
+ set interfaces vpp vxlan vppvxlan3 vni 3000
+ set interfaces vpp vxlan vppvxlan3 remote 203.0.113.30
+ set interfaces vpp vxlan vppvxlan3 source-address 192.168.1.1
+ set interfaces vpp vxlan vppvxlan3 address 10.0.3.1/24
Bridge Integration
------------------
@@ -111,10 +127,10 @@ VXLAN interfaces are commonly used as members in VPP bridges for Layer 2 extensi
.. code-block:: none
# Add VXLAN tunnel to bridge
- set vpp interfaces bridge br1
- set vpp interfaces bridge br1 member interface vxlan1
- set vpp interfaces bridge br1 member interface eth1
- set vpp interfaces bridge br1 member interface lo1 bvi
+ set interfaces vpp bridge vppbr1
+ set interfaces vpp bridge vppbr1 member interface vppvxlan1
+ set interfaces vpp bridge vppbr1 member interface eth1
+ set interfaces vpp bridge vppbr1 member interface vpplo1 bvi
Multi-Tenant Configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -122,14 +138,14 @@ Multi-Tenant Configuration
.. code-block:: none
# Multiple VNIs for tenant separation
- set vpp interfaces vxlan vxlan10
- set vpp interfaces vxlan vxlan10 description "Tenant A - Production"
- set vpp interfaces vxlan vxlan10 vni 1001
- set vpp interfaces vxlan vxlan10 remote 203.0.113.20
- set vpp interfaces vxlan vxlan10 source-address 192.168.1.1
+ set interfaces vpp vxlan vppvxlan10
+ set interfaces vpp vxlan vppvxlan10 description "Tenant A - Production"
+ set interfaces vpp vxlan vppvxlan10 vni 1001
+ set interfaces vpp vxlan vppvxlan10 remote 203.0.113.20
+ set interfaces vpp vxlan vppvxlan10 source-address 192.168.1.1
- set vpp interfaces vxlan vxlan11
- set vpp interfaces vxlan vxlan11 description "Tenant A - Development"
- set vpp interfaces vxlan vxlan11 vni 1002
- set vpp interfaces vxlan vxlan11 remote 203.0.113.21
- set vpp interfaces vxlan vxlan11 source-address 192.168.1.1
+ set interfaces vpp vxlan vppvxlan11
+ set interfaces vpp vxlan vppvxlan11 description "Tenant A - Development"
+ set interfaces vpp vxlan vppvxlan11 vni 1002
+ set interfaces vpp vxlan vppvxlan11 remote 203.0.113.21
+ set interfaces vpp vxlan vppvxlan11 source-address 192.168.1.1
diff --git a/docs/vpp/configuration/interfaces/xconnect.rst b/docs/vpp/configuration/interfaces/xconnect.rst
index 822a6536..3144734f 100644
--- a/docs/vpp/configuration/interfaces/xconnect.rst
+++ b/docs/vpp/configuration/interfaces/xconnect.rst
@@ -26,11 +26,11 @@ Basic Configuration
Creating an XConnect Interface
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. cfgcmd:: set vpp interfaces xconnect <xconN>
+.. cfgcmd:: set interfaces vpp xconnect <vppxconN>
- Create an XConnect interface where ``<xconN>`` follows the naming convention xcon1, xcon2, etc.
+ Create an XConnect interface where ``<vppxconN>`` follows the naming convention vppxcon1, vppxcon2, etc.
-.. cfgcmd:: set vpp interfaces xconnect <xconN> member interface <interface-name>
+.. cfgcmd:: set interfaces vpp xconnect <vppxconN> member interface <interface-name>
Add an interface as a member of the XConnect. Exactly two member interfaces must be configured to create bidirectional forwarding.
@@ -38,26 +38,19 @@ Creating an XConnect Interface
.. code-block:: none
- set vpp interfaces xconnect xcon1
- set vpp interfaces xconnect xcon1 member interface eth0
- set vpp interfaces xconnect xcon1 member interface eth1
+ set interfaces vpp xconnect vppxcon1
+ set interfaces vpp xconnect vppxcon1 member interface eth0
+ set interfaces vpp xconnect vppxcon1 member interface eth1
This configuration creates transparent forwarding between eth0 and eth1, where any packet received on either interface is immediately forwarded to the other without any processing.
Interface Configuration
-----------------------
-Description and Administrative Control
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. cfgcmd:: set vpp interfaces xconnect <xconN> description <description>
+.. cfgcmd:: set interfaces vpp xconnect <vppxconN> description <description>
Set a descriptive name for the XConnect interface.
-.. cfgcmd:: set vpp interfaces xconnect <xconN> disable
-
- Administratively disable the XConnect interface.
-
Configuration Examples
----------------------
@@ -67,10 +60,10 @@ Physical Interface XConnect
.. code-block:: none
# Connect two physical interfaces
- set vpp interfaces xconnect xcon1
- set vpp interfaces xconnect xcon1 description "Transparent wire between ports"
- set vpp interfaces xconnect xcon1 member interface eth0
- set vpp interfaces xconnect xcon1 member interface eth1
+ set interfaces vpp xconnect vppxcon1
+ set interfaces vpp xconnect vppxcon1 description "Transparent wire between ports"
+ set interfaces vpp xconnect vppxcon1 member interface eth0
+ set interfaces vpp xconnect vppxcon1 member interface eth1
This creates a transparent wire between two physical ports, effectively making them function as a single cable.
@@ -80,10 +73,10 @@ Tunnel to Physical XConnect
.. code-block:: none
# Connect tunnel to physical interface
- set vpp interfaces xconnect xcon2
- set vpp interfaces xconnect xcon2 description "GRE tunnel to physical bridge"
- set vpp interfaces xconnect xcon2 member interface gre1
- set vpp interfaces xconnect xcon2 member interface eth2
+ set interfaces vpp xconnect vppxcon2
+ set interfaces vpp xconnect vppxcon2 description "GRE tunnel to physical bridge"
+ set interfaces vpp xconnect vppxcon2 member interface vppgre1
+ set interfaces vpp xconnect vppxcon2 member interface eth2
This forwards all traffic from a GRE tunnel directly to a physical interface and vice versa.
@@ -93,9 +86,9 @@ Mixed Interface Types
.. code-block:: none
# Connect different interface types
- set vpp interfaces xconnect xcon3
- set vpp interfaces xconnect xcon3 description "VXLAN to bonding bridge"
- set vpp interfaces xconnect xcon3 member interface vxlan1
- set vpp interfaces xconnect xcon3 member interface bond0
+ set interfaces vpp xconnect vppxcon3
+ set interfaces vpp xconnect vppxcon3 description "VXLAN to bonding bridge"
+ set interfaces vpp xconnect vppxcon3 member interface vppvxlan1
+ set interfaces vpp xconnect vppxcon3 member interface vppbond0
This demonstrates XConnect's flexibility in connecting various VPP interface types.