diff options
Diffstat (limited to 'docs/interfaces/bridge.rst')
| -rw-r--r-- | docs/interfaces/bridge.rst | 112 |
1 files changed, 112 insertions, 0 deletions
diff --git a/docs/interfaces/bridge.rst b/docs/interfaces/bridge.rst new file mode 100644 index 00000000..6c8510b5 --- /dev/null +++ b/docs/interfaces/bridge.rst @@ -0,0 +1,112 @@ +.. _bridge-interface: + +Bridge +------ + +Interfaces in VyOS can be bridged together to provide software switching of +Layer-2 traffic. + +A bridge is created when a bridge interface is defined. In the example below +we create a bridge named br100 with eth1 and eth2 as the bridge member ports. + +.. code-block:: sh + + set interfaces bridge 'br100' + set interfaces bridge br100 member interface eth1 + set interfaces bridge br100 member interface eth2 + +Each bridge member can be assiged a port cost and priority using the following +commands: + +.. code-block:: sh + + set interfaces bridge br100 member interface eth1 cost 10 + set interfaces bridge br100 member interface eth1 priority 1024 + +Interfaces assigned to a bridge do not have address configuration. An IP +address can be assigned to the bridge interface itself, however, like any +normal interface. + +.. code-block:: sh + + set interfaces bridge br100 address '192.168.100.1/24' + set interfaces bridge br100 address '2001:db8:100::1/64' + +Example Result: + +.. code-block:: sh + + bridge br100 { + address 192.168.100.1/24 + address 2001:db8:100::1/64 + member { + interface eth1 { + cost 10 + priority 1024 + } + interface eth2 { + } + } + + } + [...] + +In addition to normal IP interface configuration, bridge interfaces support +Spanning-Tree Protocol. STP is disabled by default. + +.. note:: Please use caution when introducing spanning-tree protocol on a + network as it may result in topology changes. + +To enable spanning-tree use the `set interfaces bridge <name> stp` command: + +.. code-block:: sh + + set interfaces bridge br100 stp + +STP `priority`, `forwarding-delay`, `hello-time`, and `max-age` can be +configured for the bridge. The MAC aging time can also be configured +using the `aging` directive. + +The `show bridge` operational command can be used to display configured +bridges: + +.. code-block:: sh + + vyos@vyos:~$ show bridge + bridge name bridge id STP enabled interfaces + br100 0000.000c29443b19 yes eth1.100 + +If spanning-tree is enabled, the `show bridge <name> spanning-tree` command +can be used to show STP configuration: + +.. code-block:: sh + + vyos@vyos:~$ show bridge br100 spanning-tree + br100 + bridge id 0000.000c29443b19 + designated root 0000.000c29443b19 + root port 0 path cost 0 + max age 20.00 bridge max age 20.00 + hello time 2.00 bridge hello time 2.00 + forward delay 15.00 bridge forward delay 15.00 + ageing time 300.00 + hello timer 0.47 tcn timer 0.00 + topology change timer 0.00 gc timer 64.63 + flags + + eth1.100 (1) + port id 8001 state forwarding + designated root 0000.000c29443b19 path cost 4 + designated bridge 0000.000c29443b19 message age timer 0.00 + designated port 8001 forward delay timer 0.00 + designated cost 0 hold timer 0.00 + flags + +The MAC address-table for a bridge can be displayed using the +`show bridge <name> macs` command: + +.. code-block:: sh + + vyos@vyos:~$ show bridge br100 macs + port no mac addr is local? ageing timer + 1 00:0c:29:44:3b:19 yes 0.00 |