summaryrefslogtreecommitdiff
path: root/docs/interfaces/vxlan.rst
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-11-23 10:42:03 +0100
committerChristian Poessinger <christian@poessinger.com>2019-11-23 10:49:48 +0100
commita0a07c6ab314311909ee3c808d13a712cfba2fb2 (patch)
treeef1362161463e9bd7fd00358be53a60aa78649aa /docs/interfaces/vxlan.rst
parentcfd378949fd3ff0c755e59d9d8564e872a89adb9 (diff)
downloadvyos-documentation-a0a07c6ab314311909ee3c808d13a712cfba2fb2.tar.gz
vyos-documentation-a0a07c6ab314311909ee3c808d13a712cfba2fb2.zip
interfaces: update base interface definitions and links
Diffstat (limited to 'docs/interfaces/vxlan.rst')
-rw-r--r--docs/interfaces/vxlan.rst29
1 files changed, 27 insertions, 2 deletions
diff --git a/docs/interfaces/vxlan.rst b/docs/interfaces/vxlan.rst
index d432bdc6..ac818fcc 100644
--- a/docs/interfaces/vxlan.rst
+++ b/docs/interfaces/vxlan.rst
@@ -1,12 +1,37 @@
+.. _vxlan-interface:
+
VXLAN
-----
-VXLAN is an overlaying Ethernet over IP protocol, it's described in :rfc:`7348`.
+:abbr:`VXLAN (Virtual Extensible LAN)` is a network virtualization technology
+that attempts to address the scalability problems associated with large cloud
+computing deployments. It uses a VLAN-like encapsulation technique to
+encapsulate OSI layer 2 Ethernet frames within layer 4 UDP datagrams, using
+4789 as the default IANA-assigned destination UDP port number. VXLAN
+endpoints, which terminate VXLAN tunnels and may be either virtual or physical
+switch ports, are known as :abbr:`VTEPs (VXLAN tunnel endpoints)`.
+
+VXLAN is an evolution of efforts to standardize on an overlay encapsulation
+protocol. It increases scalability up to 16 million logical networks and
+allows for layer 2 adjacency across IP networks. Multicast or unicast with
+head-end replication (HER) is used to flood broadcast, unknown unicast,
+and multicast (BUM) traffic.
+
+The VXLAN specification was originally created by VMware, Arista Networks
+and Cisco. Other backers of the VXLAN technology include Huawei, Broadcom,
+Citrix, Pica8, Big Switch Networks, Cumulus Networks, Dell EMC, Ericsson,
+Mellanox, FreeBSD, OpenBSD, Red Hat, Joyent, and Juniper Networks.
+
+VXLAN was officially documented by the IETF in :rfc:`7348`.
If configuring VXLAN in a VyOS virtual machine, ensure that MAC spoofing
(Hyper-V) or Forged Transmits (ESX) are permitted, otherwise forwarded frames
may be blocked by the hypervisor.
+.. note:: As VyOS is based on Linux and there was no official IANA port assigned
+ for VXLAN, VyOS uses a default port of 8472. You can change the port on a
+ per VXLAN interface basis to get it working accross multiple vendors.
+
Multicast VXLAN
^^^^^^^^^^^^^^^^
@@ -297,5 +322,5 @@ Let's change the Multicast example from above:
# leaf3
set interface vxlan vxlan241 remote 10.1.2.2
-The default port udp is set to 8472.
+The default port udp is set to 8472.
It can be changed with ``set interface vxlan <vxlanN> remote-port <port>``