diff options
| author | Christian Poessinger <christian@poessinger.com> | 2020-11-10 22:57:12 +0100 |
|---|---|---|
| committer | Christian Poessinger <christian@poessinger.com> | 2020-11-10 22:57:12 +0100 |
| commit | f0ed78b3ad3a7806b0443a2771cdeb6cbd13ba5a (patch) | |
| tree | c236fa50dbcb4845f85c3f1c9f8eb16120305e9f /docs/interfaces/vxlan.rst | |
| parent | f6ee81e58268ce1a666f68504f327f49c4402130 (diff) | |
| download | vyos-documentation-f0ed78b3ad3a7806b0443a2771cdeb6cbd13ba5a.tar.gz vyos-documentation-f0ed78b3ad3a7806b0443a2771cdeb6cbd13ba5a.zip | |
interfaces: consolidate vxlan, geneve, wifi, pppoe, wwan to new include command syntax
Diffstat (limited to 'docs/interfaces/vxlan.rst')
| -rw-r--r-- | docs/interfaces/vxlan.rst | 55 |
1 files changed, 27 insertions, 28 deletions
diff --git a/docs/interfaces/vxlan.rst b/docs/interfaces/vxlan.rst index 5ecfeb0a..40dc5400 100644 --- a/docs/interfaces/vxlan.rst +++ b/docs/interfaces/vxlan.rst @@ -40,55 +40,54 @@ Common interface configuration ------------------------------ .. cmdinclude:: ../_include/interface-common-without-dhcp.txt - :var0: vxlan - :var1: vxlan0 + :var0: vxlan + :var1: vxlan0 -.. cfgcmd:: set interfaces vxlan <interface> vni <number> - - Each VXLAN segment is identified through a 24-bit segment ID, termed the - :abbr:`VNI (VXLAN Network Identifier (or VXLAN Segment ID))`, This allows - up to 16M VXLAN segments to coexist within the same administrative domain. +VXLAN specific options +----------------------- -Multicast -^^^^^^^^^ +.. cfgcmd:: set interfaces vxlan <interface> vni <number> -.. cfgcmd:: set interfaces vxlan <interface> source-interface <interface> + Each VXLAN segment is identified through a 24-bit segment ID, termed the + :abbr:`VNI (VXLAN Network Identifier (or VXLAN Segment ID))`, This allows + up to 16M VXLAN segments to coexist within the same administrative domain. - Interface used for VXLAN underlay. This is mandatory when using VXLAN via - a multicast network. VXLAN traffic will always enter and exit this interface. +.. cfgcmd:: set interfaces vxlan <interface> port <port> + Configure port number of remote VXLAN endpoint. -.. cfgcmd:: set interfaces vxlan <interface> group <address> + .. note:: As VyOS is Linux based the default port used is not using 4789 + as the default IANA-assigned destination UDP port number. Instead VyOS + uses the Linux default port of 8472. - Multicast group address for VXLAN interface. VXLAN tunnels can be built - either via Multicast or via Unicast. +.. cfgcmd:: set interfaces vxlan <interface> source-address <interface> - Both IPv4 and IPv6 multicast is possible. + Source IP address used for VXLAN underlay. This is mandatory when using VXLAN + via L2VPN/EVPN. Unicast ^^^^^^^ .. cfgcmd:: set interfaces vxlan <interface> remote <address> - IPv4/IPv6 remote address of the VXLAN tunnel. Alternative to multicast, the - remote IPv4/IPv6 address can set directly. + IPv4/IPv6 remote address of the VXLAN tunnel. Alternative to multicast, the + remote IPv4/IPv6 address can set directly. +Multicast +^^^^^^^^^ -.. cfgcmd:: set interfaces vxlan <interface> port <port> +.. cfgcmd:: set interfaces vxlan <interface> source-interface <interface> - Configure port number of remote VXLAN endpoint. + Interface used for VXLAN underlay. This is mandatory when using VXLAN via + a multicast network. VXLAN traffic will always enter and exit this interface. - .. note:: As VyOS is Linux based the default port used is not using 4789 - as the default IANA-assigned destination UDP port number. Instead VyOS - uses the Linux default port of 8472. -L2VVPN / EVPN -^^^^^^^^^^^^^ +.. cfgcmd:: set interfaces vxlan <interface> group <address> -.. cfgcmd:: set interfaces vxlan <interface> source-address <interface> + Multicast group address for VXLAN interface. VXLAN tunnels can be built + either via Multicast or via Unicast. - Source IP address used for VXLAN underlay. This is mandatory when using - VXLAN via L2VPN/EVPN. + Both IPv4 and IPv6 multicast is possible. Multicast VXLAN =============== |