ifconfig: T1557: refactor apply_vlan_config() function

instead of providing three copies of the same method in bonding, ethernet and
wireless, make a common function in vyos.ifconfig_vlan.apply_vlan_config().

1 files changed, 77 insertions, 0 deletions

diff --git a/python/vyos/ifconfig_vlan.py b/python/vyos/ifconfig_vlan.py
new file mode 100644
index 000000000..1299aa380
--- /dev/null
+++ b/python/vyos/ifconfig_vlan.py
@@ -0,0 +1,77 @@
+# Copyright 2019-2020 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
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library.  If not, see <http://www.gnu.org/licenses/>.
+
+from vyos.ifconfig import VLANIf
+
+def apply_vlan_config(vlan, config):
+    """
+    Generic function to apply a VLAN configuration from a dictionary
+    to a VLAN interface
+    """
+
+    if type(vlan) != type(VLANIf("lo")):
+        raise TypeError()
+
+    # get DHCP config dictionary and update values
+    opt = vlan.get_dhcp_options()
+
+    if config['dhcp_client_id']:
+        opt['client_id'] = config['dhcp_client_id']
+
+    if config['dhcp_hostname']:
+        opt['hostname'] = config['dhcp_hostname']
+
+    if config['dhcp_vendor_class_id']:
+        opt['vendor_class_id'] = config['dhcp_vendor_class_id']
+
+    # store DHCP config dictionary - used later on when addresses are aquired
+    vlan.set_dhcp_options(opt)
+
+    # get DHCPv6 config dictionary and update values
+    opt = vlan.get_dhcpv6_options()
+
+    if config['dhcpv6_prm_only']:
+        opt['dhcpv6_prm_only'] = True
+
+    if config['dhcpv6_temporary']:
+        opt['dhcpv6_temporary'] = True
+
+    # store DHCPv6 config dictionary - used later on when addresses are aquired
+    vlan.set_dhcpv6_options(opt)
+
+    # update interface description used e.g. within SNMP
+    vlan.set_alias(config['description'])
+    # ignore link state changes
+    vlan.set_link_detect(config['disable_link_detect'])
+    # Maximum Transmission Unit (MTU)
+    vlan.set_mtu(config['mtu'])
+    # Change VLAN interface MAC address
+    if config['mac']:
+        vlan.set_mac(config['mac'])
+
+    # enable/disable VLAN interface
+    if config['disable']:
+        vlan.set_state('down')
+    else:
+        vlan.set_state('up')
+
+    # Configure interface address(es)
+    # - not longer required addresses get removed first
+    # - newly addresses will be added second
+    for addr in config['address_remove']:
+        vlan.del_addr(addr)
+    for addr in config['address']:
+        vlan.add_addr(addr)
+