summaryrefslogtreecommitdiff
path: root/docs/interfaces
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-08-05 15:50:55 +0200
committerChristian Poessinger <christian@poessinger.com>2019-11-07 21:54:22 +0100
commit9c87432239795df17c92ed1409bf72375d003a28 (patch)
tree049d6ed586234ec43275dca7e6ac242a6f862c81 /docs/interfaces
parent0de54083437d84cb678d7d2676e6a2128e6baad4 (diff)
downloadvyos-documentation-9c87432239795df17c92ed1409bf72375d003a28.tar.gz
vyos-documentation-9c87432239795df17c92ed1409bf72375d003a28.zip
bridge: T1556: adopt to new bridge syntax
Diffstat (limited to 'docs/interfaces')
-rw-r--r--docs/interfaces/bridging.rst43
-rw-r--r--docs/interfaces/l2tpv3.rst6
-rw-r--r--docs/interfaces/vxlan.rst52
3 files changed, 54 insertions, 47 deletions
diff --git a/docs/interfaces/bridging.rst b/docs/interfaces/bridging.rst
index e42d76ad..dbd5f0db 100644
--- a/docs/interfaces/bridging.rst
+++ b/docs/interfaces/bridging.rst
@@ -5,15 +5,23 @@ 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 will be creating a bridge for VLAN 100 and assigning a VIF to the bridge.
+we create a bridge named br100 with eth1 and eth2 as the bridge member ports.
.. code-block:: sh
set interfaces bridge 'br100'
- ~~set interfaces ethernet eth1 vif 100 bridge-group bridge br100~~
- set interfaces bridge br100 member interface eth1
-
-Interfaces assigned to a bridge-group do not have address configuration. An IP
+ 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.
@@ -29,16 +37,17 @@ Example Result:
bridge br100 {
address 192.168.100.1/24
address 2001:db8:100::1/64
- }
- [...]
- ethernet eth1 {
- [...]
- vif 100 {
- bridge-group {
- bridge br100
+ 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.
@@ -46,20 +55,16 @@ 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 true` command:
+To enable spanning-tree use the `set interfaces bridge <name> stp` command:
.. code-block:: sh
- set interfaces bridge br100 stp true
+ set interfaces bridge br100 stp
STP `priority`, `forwarding-delay`, `hello-time`, and `max-age` can be
-configured for the bridge-group. The MAC aging time can also be configured
+configured for the bridge. The MAC aging time can also be configured
using the `aging` directive.
-For member interfaces, the bridge-group `priority` and `cost` can be
-configured.
-
The `show bridge` operational command can be used to display configured
bridges:
diff --git a/docs/interfaces/l2tpv3.rst b/docs/interfaces/l2tpv3.rst
index 2238c970..4cc296ca 100644
--- a/docs/interfaces/l2tpv3.rst
+++ b/docs/interfaces/l2tpv3.rst
@@ -95,14 +95,14 @@ Bridge:
# remote side in this example:
# set interfaces bridge br0 address '172.16.30.18/30'
set interfaces bridge br0 address '172.16.30.17/30'
- set interfaces ethernet eth0 bridge-group bridge 'br0'
+ set interfaces bridge br0 member interface eth0
set interfaces ethernet eth0 description 'L2 VPN Physical port'
L2TPv3:
.. code-block:: sh
- set interfaces l2tpv3 l2tpeth0 bridge-group bridge 'br0'
+ set interfaces bridge br0 member interface 'l2tpeth0'
set interfaces l2tpv3 l2tpeth0 description 'L2 VPN Tunnel'
set interfaces l2tpv3 l2tpeth0 destination-port '5000'
set interfaces l2tpv3 l2tpeth0 encapsulation 'ip'
@@ -116,4 +116,4 @@ L2TPv3:
set interfaces l2tpv3 l2tpeth0 tunnel-id '10'
.. _`Wikipedia L2TPv3`: http://en.wikipedia.org/wiki/L2TPv3
-.. _`RFC3921`: https://tools.ietf.org/html/rfc3931 \ No newline at end of file
+.. _`RFC3921`: https://tools.ietf.org/html/rfc3931
diff --git a/docs/interfaces/vxlan.rst b/docs/interfaces/vxlan.rst
index 75628953..2795fc75 100644
--- a/docs/interfaces/vxlan.rst
+++ b/docs/interfaces/vxlan.rst
@@ -49,7 +49,6 @@ Configuration commands
interfaces
vxlan <vxlan[0-16777215]>
address # IP address of the VXLAN interface
- bridge-group # Configure a L2 bridge-group
description # Description
group <ipv4> # IPv4 Multicast group address (required)
ip # IPv4 routing options
@@ -120,16 +119,18 @@ Leaf2 configuration:
! Our first vxlan interface
set interfaces bridge br241 address '172.16.241.1/24'
- set interfaces ethernet eth1 vif 241 bridge-group bridge 'br241'
- set interfaces vxlan vxlan241 bridge-group bridge 'br241'
+ set interfaces bridge br241 member interface 'eth1.241'
+ set interfaces bridge br241 member interface 'vxlan241'
+
set interfaces vxlan vxlan241 group '239.0.0.241'
set interfaces vxlan vxlan241 link 'eth0'
set interfaces vxlan vxlan241 vni '241'
! Our seconds vxlan interface
set interfaces bridge br242 address '172.16.242.1/24'
- set interfaces ethernet eth1 vif 242 bridge-group bridge 'br242'
- set interfaces vxlan vxlan242 bridge-group bridge 'br242'
+ set interfaces bridge br242 member interface 'eth1.242'
+ set interfaces bridge br242 member interface 'vxlan242'
+
set interfaces vxlan vxlan242 group '239.0.0.242'
set interfaces vxlan vxlan242 link 'eth0'
set interfaces vxlan vxlan242 vni '242'
@@ -143,16 +144,18 @@ Leaf3 configuration:
! Our first vxlan interface
set interfaces bridge br241 address '172.16.241.1/24'
- set interfaces ethernet eth1 vif 241 bridge-group bridge 'br241'
- set interfaces vxlan vxlan241 bridge-group bridge 'br241'
+ set interfaces bridge br241 member interface 'eth1.241'
+ set interfaces bridge br241 member interface 'vxlan241'
+
set interfaces vxlan vxlan241 group '239.0.0.241'
set interfaces vxlan vxlan241 link 'eth0'
set interfaces vxlan vxlan241 vni '241'
! Our seconds vxlan interface
set interfaces bridge br242 address '172.16.242.1/24'
- set interfaces ethernet eth1 vif 242 bridge-group bridge 'br242'
- set interfaces vxlan vxlan242 bridge-group bridge 'br242'
+ set interfaces bridge br242 member interface 'eth1.242'
+ set interfaces bridge br242 member interface 'vxlan242'
+
set interfaces vxlan vxlan242 group '239.0.0.242'
set interfaces vxlan vxlan242 link 'eth0'
set interfaces vxlan vxlan242 vni '242'
@@ -175,11 +178,11 @@ advertised.
.. code-block:: sh
- set interfaces ethernet eth1 vif 241 bridge-group bridge 'br241'
- set interfaces vxlan vxlan241 bridge-group bridge 'br241'
+ set interfaces bridge br241 member interface 'eth1.241'
+ set interfaces bridge br241 member interface 'vxlan241'
-Binds eth1 vif 241 and vxlan241 to each other by putting them in the same
-bridge-group. Internal VyOS requirement.
+Binds eth1.241 and vxlan241 to each other by making them both member interfaces of
+the same bridge.
.. code-block:: sh
@@ -221,6 +224,10 @@ vxlan interface as routing interface.
interfaces {
bridge br0 {
+ member {
+ interface vxlan0 {
+ }
+ }
}
ethernet eth0 {
address dhcp
@@ -228,9 +235,6 @@ vxlan interface as routing interface.
loopback lo {
}
vxlan vxlan0 {
- bridge-group {
- bridge br0
- }
group 239.0.0.1
vni 0
}
@@ -246,22 +250,23 @@ Here is a working configuration that creates a VXLAN between two routers. Each
router has a VLAN interface (26) facing the client devices and a VLAN interface
(30) that connects it to the other routers. With this configuration, traffic
can flow between both routers' VLAN 26, but can't escape since there is no L3
-gateway. You can add an IP to a bridge-group to create a gateway.
+gateway. You can add an IP to a bridge to create a gateway.
.. code-block:: sh
interfaces {
bridge br0 {
+ member {
+ interface eth0.26 {
+ }
+ interface vxlan0 {
+ }
+ }
}
ethernet eth0 {
duplex auto
smp-affinity auto
speed auto
- vif 26 {
- bridge-group {
- bridge br0
- }
- }
vif 30 {
address 10.7.50.6/24
}
@@ -269,9 +274,6 @@ gateway. You can add an IP to a bridge-group to create a gateway.
loopback lo {
}
vxlan vxlan0 {
- bridge-group {
- bridge br0
- }
group 239.0.0.241
vni 241
}