Python/ifconfig: T1557: vxlan: initial support via VXLANIf

2 files changed, 155 insertions, 3 deletions

diff --git a/interface-definitions/interfaces-vxlan.xml b/interface-definitions/interfaces-vxlan.xml
new file mode 100644
index 000000000..35a43f92c
--- /dev/null
+++ b/interface-definitions/interfaces-vxlan.xml
@@ -0,0 +1,102 @@
+<?xml version="1.0"?>
+<interfaceDefinition>
+  <node name="interfaces">
+    <children>
+      <tagNode name="vxlan" owner="${vyos_conf_scripts_dir}/interface-vxlan.py">
+        <properties>
+          <help>Virtual extensible LAN interface (VXLAN)</help>
+          <priority>460</priority>
+          <constraint>
+            <regex>vxlan[0-9]+$</regex>
+          </constraint>
+          <constraintErrorMessage>VXLAN interface must be named vxlanN</constraintErrorMessage>
+          <valueHelp>
+            <format>vxlanN</format>
+            <description>VXLAN interface name</description>
+          </valueHelp>
+        </properties>
+        <children>
+          <leafNode name="address">
+            <properties>
+              <help>IP address</help>
+              <valueHelp>
+                <format>ipv4net</format>
+                <description>IPv4 address and prefix length</description>
+              </valueHelp>
+              <valueHelp>
+                <format>ipv6net</format>
+                <description>IPv6 address and prefix length</description>
+              </valueHelp>
+              <multi/>
+              <constraint>
+                <validator name="ip-cidr"/>
+              </constraint>
+            </properties>
+          </leafNode>
+          <leafNode name="description">
+            <properties>
+              <help>Interface description</help>
+              <constraint>
+                <regex>^.{1,256}$</regex>
+              </constraint>
+              <constraintErrorMessage>Interface description too long (limit 256 characters)</constraintErrorMessage>
+            </properties>
+          </leafNode>
+          <leafNode name="disable">
+            <properties>
+              <help>Disable interface</help>
+              <valueless/>
+            </properties>
+          </leafNode>
+          <leafNode name="group">
+            <properties>
+              <help>Multicast group address for VXLAN interface</help>
+              <valueHelp>
+                <format>ipv4</format>
+                <description>Multicast group address</description>
+              </valueHelp>
+              <constraint>
+                <validator name="ipv4-address"/>
+              </constraint>
+            </properties>
+          </leafNode>
+          <node name="ip">
+            <children>
+              <leafNode name="arp-cache-timeout">
+                <properties>
+                  <help>ARP cache entry timeout in seconds</help>
+                  <valueHelp>
+                    <format>1-86400</format>
+                    <description>ARP cache entry timout in seconds (default 30)</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="numeric" argument="--range 1-86400"/>
+                  </constraint>
+                  <constraintErrorMessage>ARP cache entry timeout must be between 1 and 86400 seconds</constraintErrorMessage>
+                </properties>
+              </leafNode>
+              <leafNode name="enable-proxy-arp">
+                <properties>
+                  <help>Enable proxy-arp on this interface</help>
+                  <valueless/>
+                </properties>
+              </leafNode>
+            </children>
+          </node>
+          <leafNode name="link">
+            <properties>
+              <help>Underlay device of VXLAN interface</help>
+              <valueHelp>
+                <format>interface</format>
+                <description>Interface used for VXLAN underlay</description>
+              </valueHelp>
+              <completionHelp>
+                <script>${vyos_completion_dir}/list_interfaces.py</script>
+              </completionHelp>
+            </properties>
+          </leafNode>
+        </children>
+      </tagNode>
+    </children>
+  </node>
+</interfaceDefinition>
diff --git a/python/vyos/ifconfig.py b/python/vyos/ifconfig.py
index 7593f2c91..bc22478a6 100644
--- a/python/vyos/ifconfig.py
+++ b/python/vyos/ifconfig.py
@@ -66,9 +66,6 @@ class Interface:
         if not os.path.exists('/sys/class/net/{}'.format(ifname)) and not type:
             raise Exception('interface "{}" not found'.format(self._ifname))
 
-        if os.path.isfile('/tmp/vyos.ifconfig.debug'):
-            self._debug = True
-
         if not os.path.exists('/sys/class/net/{}'.format(self._ifname)):
             cmd = 'ip link add dev {} type {}'.format(self._ifname, type)
             self._cmd(cmd)
@@ -1386,3 +1383,56 @@ class WireGuardIf(Interface):
         cmd = "sudo wg set {0} peer {1} remove".format(
             self._ifname, str(peerkey))
         self._cmd(cmd)
+
+
+class VXLANIf(Interface, ):
+    """
+    The VXLAN protocol is a tunnelling protocol designed to solve the
+    problem of limited VLAN IDs (4096) in IEEE 802.1q.  With VXLAN the
+    size of the identifier is expanded to 24 bits (16777216).
+
+    VXLAN is described by IETF RFC 7348, and has been implemented by a
+    number of vendors.  The protocol runs over UDP using a single
+    destination port.  This document describes the Linux kernel tunnel
+    device, there is also a separate implementation of VXLAN for
+    Openvswitch.
+
+    Unlike most tunnels, a VXLAN is a 1 to N network, not just point to
+    point. A VXLAN device can learn the IP address of the other endpoint
+    either dynamically in a manner similar to a learning bridge, or make
+    use of statically-configured forwarding entries.
+
+    For more information please refer to:
+    https://www.kernel.org/doc/Documentation/networking/vxlan.txt
+    """
+    def __init__(self, ifname, config=''):
+        if config:
+            if not os.path.exists('/sys/class/net/{}'.format(self._ifname)):
+                # we assume that by default a multicast interface is created
+                group = 'group {}'.format(config['group'])
+                # if remote host is specified we ignore the multicast address
+                if config['remote']:
+                    group = 'remote {}'.format(config['remote'])
+                # an underlay device is not always specified
+                dev = ''
+                if config['dev']:
+                    dev = 'dev'.format(config['dev'])
+
+                cmd = 'ip link add dev {intf} type vxlan id {vni} {group} {dev} {port}'
+                    .format(intf=self._ifname, config['vni'], group=group, dev=dev, port=config['port'])
+                self._cmd(cmd)
+
+        super().__init__(ifname, type='vxlan')
+
+
+     @staticmethod
+     def get_config():
+         config = {
+             'vni': 0,
+             'dev': '',
+             'group': '',
+             'port': 8472 # The Linux implementation of VXLAN pre-dates
+                          # the IANA's selection of a standard destination port
+             'remote': '',
+             'ttl': 16
+         }