From 3481dc487abe29d5f09e72f6bbdaaf1e3321056f Mon Sep 17 00:00:00 2001 From: LiudmylaNad Date: Tue, 23 Dec 2025 14:30:23 +0100 Subject: DOC: Proofreading bridge.rst (#1727) --- docs/configuration/interfaces/bridge.rst | 291 +++++++++++++++++++------------ 1 file changed, 183 insertions(+), 108 deletions(-) diff --git a/docs/configuration/interfaces/bridge.rst b/docs/configuration/interfaces/bridge.rst index 5e79107b..7f4d3e43 100644 --- a/docs/configuration/interfaces/bridge.rst +++ b/docs/configuration/interfaces/bridge.rst @@ -1,4 +1,4 @@ -:lastproofread: 2024-07-04 +:lastproofread: 2025-12-22 .. _bridge-interface: @@ -6,15 +6,19 @@ Bridge ###### -A Bridge is a way to connect two Ethernet segments together in a -protocol independent way. Packets are forwarded based on Ethernet -address, rather than IP address (like a router). Since forwarding is -done at Layer 2, all protocols can go transparently through a bridge. -The Linux bridge code implements a subset of the ANSI/IEEE 802.1d -standard. +VyOS bridges connect Ethernet segments by grouping multiple interfaces into a +single bridge interface, which acts as a virtual software switch. Unlike +routers, which forward traffic based on Layer 3 IP addresses, bridges operate +at Layer 2 and forward traffic based on MAC addresses. Operating at Layer 2, +bridges are protocol-agnostic and transparently forward all Ethernet- +encapsulated traffic, whether it is IPv4, IPv6, or specialized industrial +protocols. -.. note:: Spanning Tree Protocol is not enabled by default in VyOS. - :ref:`stp` can be easily enabled if needed. +This implementation utilizes the Linux bridge subsystem to support a subset of +the ANSI/IEEE 802.1d standard for transparent bridging and MAC address learning. + +.. note:: :abbr:`STP (Spanning Tree Protocol)` is disabled by default in VyOS + and must be explicitly enabled if required. See :ref:`stp` for details. ************* Configuration @@ -27,125 +31,175 @@ Common interface configuration :var0: bridge :var1: br0 -Member Interfaces +Member interfaces ================= .. cfgcmd:: set interfaces bridge member interface - Assign `` interface to bridge ``. A completion - helper will help you with all allowed interfaces which can be - bridged. This includes :ref:`ethernet-interface`, - :ref:`bond-interface`, :ref:`l2tpv3-interface`, :ref:`openvpn`, - :ref:`vxlan-interface`, :ref:`wireless-interface`, - :ref:`tunnel-interface` and :ref:`geneve-interface`. + **Configure an interface as a bridge member.** + + Valid interface types are: :ref:`ethernet-interface`, :ref:`bond-interface`, + :ref:`l2tpv3-interface`, :ref:`openvpn`, :ref:`vxlan-interface`, + :ref:`wireless-interface`, :ref:`tunnel-interface`, and + :ref:`geneve-interface`. + Use tab completion to list interfaces that can be bridged. .. cfgcmd:: set interfaces bridge member interface priority - Configure individual bridge port ``. + **Configure the** :abbr:`STP (Spanning Tree Protocol)` **port priority + for a specific member interface within a bridge.** + + Within the :abbr:`STP (Spanning Tree Protocol)` topology, each member interface + in a bridge operates as a port with an assigned **priority** and **path cost**. + :abbr:`STP (Spanning Tree Protocol)` uses these values to determine the + **lowest-cost path** to the root bridge, maintaining a loop-free topology. + Traffic flows through the path with the lowest path cost, while alternate + paths remain in standby. - Each bridge has a relative priority and cost. Each interface is - associated with a port (number) in the STP code. Each has a priority - and a cost, that is used to decide which is the shortest path to - forward a packet. The lowest cost path is always used unless the - other path is down. If you have multiple bridges and interfaces then - you may need to adjust the priorities to achieve optimum - performance. + A **lower** priority value means **higher** precedence in path selection. + + :abbr:`STP (Spanning Tree Protocol)` considers the port priority only if + multiple member interfaces have the same path costs. .. cfgcmd:: set interfaces bridge member interface cost - Path `` value for Spanning Tree Protocol. Each interface in a - bridge could have a different speed and this value is used when - deciding which link to use. Faster interfaces should have lower - costs. + **Configure the** :abbr:`STP (Spanning Tree Protocol)` **path cost for a + specific member interface within the bridge.** + + Path cost is the primary metric :abbr:`STP (Spanning Tree Protocol)` uses to + determine the path to the root bridge. This value is based on interface + bandwidth; faster interfaces receive lower costs. + + By assigning a lower cost, you give the interface higher precedence during + path selection. -Bridge Options +Bridge options ============== +Configure how bridge interfaces maintain their :abbr:`FDB (Forwarding Database)` +, react to topology changes, and optimize multicast data streams. + .. cfgcmd:: set interfaces bridge aging