Merge pull request #747 from c-po/vxlan-tunnel-parameters

vyos.ifconfig: cleanup and tunnel refactoring

1 files changed, 29 insertions, 46 deletions

diff --git a/python/vyos/ifconfig/vxlan.py b/python/vyos/ifconfig/vxlan.py
index ad1f605ed..291332a77 100644
--- a/python/vyos/ifconfig/vxlan.py
+++ b/python/vyos/ifconfig/vxlan.py
@@ -1,4 +1,4 @@
-# Copyright 2019 VyOS maintainers and contributors <maintainers@vyos.io>
+# Copyright 2019-2021 VyOS maintainers and contributors <maintainers@vyos.io>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -15,6 +15,7 @@
 
 from vyos import ConfigError
 from vyos.ifconfig.interface import Interface
+from vyos.util import dict_search
 
 @Interface.register
 class VXLANIf(Interface):
@@ -38,16 +39,7 @@ class VXLANIf(Interface):
     https://www.kernel.org/doc/Documentation/networking/vxlan.txt
     """
 
-    default = {
-        'type': 'vxlan',
-        'group': '',
-        'port': 8472,   # The Linux implementation of VXLAN pre-dates
-                        # the IANA's selection of a standard destination port
-        'remote': '',
-        'source_address': '',
-        'source_interface': '',
-        'vni': 0
-    }
+    iftype = 'vxlan'
     definition = {
         **Interface.definition,
         **{
@@ -56,44 +48,35 @@ class VXLANIf(Interface):
             'bridgeable': True,
         }
     }
-    options = Interface.options + \
-        ['group', 'remote', 'source_interface', 'port', 'vni', 'source_address']
-
-    mapping = {
-        'ifname': 'add',
-        'vni':    'id',
-        'port':   'dstport',
-        'source_address': 'local',
-        'source_interface': 'dev',
-    }
 
     def _create(self):
-        cmdline = ['ifname', 'type', 'vni', 'port']
-
-        if self.config['source_address']:
-            cmdline.append('source_address')
-
-        if self.config['remote']:
-            cmdline.append('remote')
-
-        if self.config['group'] or self.config['source_interface']:
-            if self.config['group'] and self.config['source_interface']:
-                cmdline.append('group')
-                cmdline.append('source_interface')
-            else:
-                ifname = self.config['ifname']
-                raise ConfigError(
-                    f'VXLAN "{ifname}" is missing mandatory underlay multicast'
-                     'group or source interface for a multicast network.')
-
-        cmd = 'ip link'
-        for key in cmdline:
-            value = self.config.get(key, '')
-            if not value:
-                continue
-            cmd += ' {} {}'.format(self.mapping.get(key, key), value)
+        # This table represents a mapping from VyOS internal config dict to
+        # arguments used by iproute2. For more information please refer to:
+        # - https://man7.org/linux/man-pages/man8/ip-link.8.html
+        mapping = {
+            'source_address'            : 'local',
+            'source_interface'          : 'dev',
+            'remote'                    : 'remote',
+            'group'                     : 'group',
+            'parameters.ip.tos'         : 'tos',
+            'parameters.ip.ttl'         : 'ttl',
+            'parameters.ipv6.flowlabel' : 'flowlabel',
+            'parameters.nolearning'     : 'nolearning',
+        }
 
-        self._cmd(cmd)
+        cmd = 'ip link add {ifname} type {type} id {vni} dstport {port}'
+        for vyos_key, iproute2_key in mapping.items():
+            # dict_search will return an empty dict "{}" for valueless nodes like
+            # "parameters.nolearning" - thus we need to test the nodes existence
+            # by using isinstance()
+            tmp = dict_search(vyos_key, self.config)
+            if isinstance(tmp, dict):
+                cmd += f' {iproute2_key}'
+            elif tmp != None:
+                cmd += f' {iproute2_key} {tmp}'
+
+        self._cmd(cmd.format(**self.config))
+        self.set_admin_state('down')
 
     def update(self, config):
         """ General helper function which works on a dictionary retrived by