summaryrefslogtreecommitdiff
path: root/src/conf_mode/interfaces-bridge.py
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-10-13 12:49:47 +0200
committerChristian Poessinger <christian@poessinger.com>2019-10-13 12:49:47 +0200
commit79bc826426385e5b40fbe58137d0a2d2831cf274 (patch)
treee21c70c44c5889c3b37eabf9e7a7d6095f842a69 /src/conf_mode/interfaces-bridge.py
parent5c834feebe5e7749ec731dcf9556ae6997b0b526 (diff)
parentfe7279454c86a2947b23fb0d769483b7fe2a3cc3 (diff)
downloadvyos-1x-79bc826426385e5b40fbe58137d0a2d2831cf274.tar.gz
vyos-1x-79bc826426385e5b40fbe58137d0a2d2831cf274.zip
Merge branch 'current' of github.com:vyos/vyos-1x into equuleus
* 'current' of github.com:vyos/vyos-1x: Sync XML interface description source file pattern and conf script name Python/ifconfig: T1557: add support for DHCPv6 client options bonding: T1614: support DHCP options on VLAN interfaces Python/ifconfig: T1557: bugfix when configuring accept_ra on VLAN interfaces conf_mode: bonding/ethernet fix comments Jenkins: Docker: always pull container from Dockerhub
Diffstat (limited to 'src/conf_mode/interfaces-bridge.py')
-rwxr-xr-xsrc/conf_mode/interfaces-bridge.py307
1 files changed, 307 insertions, 0 deletions
diff --git a/src/conf_mode/interfaces-bridge.py b/src/conf_mode/interfaces-bridge.py
new file mode 100755
index 000000000..70bf4f528
--- /dev/null
+++ b/src/conf_mode/interfaces-bridge.py
@@ -0,0 +1,307 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2019 VyOS maintainers and contributors
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+import os
+
+from copy import deepcopy
+from sys import exit
+from netifaces import interfaces
+
+from vyos.ifconfig import BridgeIf, STPIf
+from vyos.configdict import list_diff
+from vyos.config import Config
+from vyos import ConfigError
+
+default_config_data = {
+ 'address': [],
+ 'address_remove': [],
+ 'aging': 300,
+ 'arp_cache_tmo': 30,
+ 'description': '',
+ 'deleted': False,
+ 'dhcp_client_id': '',
+ 'dhcp_hostname': '',
+ 'dhcp_vendor_class_id': '',
+ 'dhcpv6_prm_only': False,
+ 'dhcpv6_temporary': False,
+ 'disable': False,
+ 'disable_link_detect': 1,
+ 'forwarding_delay': 14,
+ 'hello_time': 2,
+ 'igmp_querier': 0,
+ 'intf': '',
+ 'mac' : '',
+ 'max_age': 20,
+ 'member': [],
+ 'member_remove': [],
+ 'priority': 32768,
+ 'stp': 0
+}
+
+def get_config():
+ bridge = deepcopy(default_config_data)
+ conf = Config()
+
+ # determine tagNode instance
+ try:
+ bridge['intf'] = os.environ['VYOS_TAGNODE_VALUE']
+ except KeyError as E:
+ print("Interface not specified")
+
+ # Check if bridge has been removed
+ if not conf.exists('interfaces bridge ' + bridge['intf']):
+ bridge['deleted'] = True
+ return bridge
+
+ # set new configuration level
+ conf.set_level('interfaces bridge ' + bridge['intf'])
+
+ # retrieve configured interface addresses
+ if conf.exists('address'):
+ bridge['address'] = conf.return_values('address')
+
+ # Determine interface addresses (currently effective) - to determine which
+ # address is no longer valid and needs to be removed
+ eff_addr = conf.return_effective_values('address')
+ bridge['address_remove'] = list_diff(eff_addr, bridge['address'])
+
+ # retrieve aging - how long addresses are retained
+ if conf.exists('aging'):
+ bridge['aging'] = int(conf.return_value('aging'))
+
+ # retrieve interface description
+ if conf.exists('description'):
+ bridge['description'] = conf.return_value('description')
+
+ # get DHCP client identifier
+ if conf.exists('dhcp-options client-id'):
+ bridge['dhcp_client_id'] = conf.return_value('dhcp-options client-id')
+
+ # DHCP client host name (overrides the system host name)
+ if conf.exists('dhcp-options host-name'):
+ bridge['dhcp_hostname'] = conf.return_value('dhcp-options host-name')
+
+ # DHCP client vendor identifier
+ if conf.exists('dhcp-options vendor-class-id'):
+ bridge['dhcp_vendor_class_id'] = conf.return_value('dhcp-options vendor-class-id')
+
+ # DHCPv6 only acquire config parameters, no address
+ if conf.exists('dhcpv6-options parameters-only'):
+ bridge['dhcpv6_prm_only'] = True
+
+ # DHCPv6 temporary IPv6 address
+ if conf.exists('dhcpv6-options temporary'):
+ bridge['dhcpv6_temporary'] = True
+
+ # Disable this bridge interface
+ if conf.exists('disable'):
+ bridge['disable'] = True
+
+ # Ignore link state changes
+ if conf.exists('disable-link-detect'):
+ bridge['disable_link_detect'] = 2
+
+ # Forwarding delay
+ if conf.exists('forwarding-delay'):
+ bridge['forwarding_delay'] = int(conf.return_value('forwarding-delay'))
+
+ # Hello packet advertisment interval
+ if conf.exists('hello-time'):
+ bridge['hello_time'] = int(conf.return_value('hello-time'))
+
+ # Enable Internet Group Management Protocol (IGMP) querier
+ if conf.exists('igmp querier'):
+ bridge['igmp_querier'] = 1
+
+ # ARP cache entry timeout in seconds
+ if conf.exists('ip arp-cache-timeout'):
+ bridge['arp_cache_tmo'] = int(conf.return_value('ip arp-cache-timeout'))
+
+ # Media Access Control (MAC) address
+ if conf.exists('mac'):
+ bridge['mac'] = conf.return_value('mac')
+
+ # Interval at which neighbor bridges are removed
+ if conf.exists('max-age'):
+ bridge['max_age'] = int(conf.return_value('max-age'))
+
+ # Determine bridge member interface (currently configured)
+ for intf in conf.list_nodes('member interface'):
+ # cost and priority initialized with linux defaults
+ # by reading /sys/devices/virtual/net/br0/brif/eth2/{path_cost,priority}
+ # after adding interface to bridge after reboot
+ iface = {
+ 'name': intf,
+ 'cost': 100,
+ 'priority': 32
+ }
+
+ if conf.exists('member interface {} cost'.format(intf)):
+ iface['cost'] = int(conf.return_value('member interface {} cost'.format(intf)))
+
+ if conf.exists('member interface {} priority'.format(intf)):
+ iface['priority'] = int(conf.return_value('member interface {} priority'.format(intf)))
+
+ bridge['member'].append(iface)
+
+ # Determine bridge member interface (currently effective) - to determine which
+ # interfaces is no longer assigend to the bridge and thus can be removed
+ eff_intf = conf.list_effective_nodes('member interface')
+ act_intf = conf.list_nodes('member interface')
+ bridge['member_remove'] = list_diff(eff_intf, act_intf)
+
+ # Priority for this bridge
+ if conf.exists('priority'):
+ bridge['priority'] = int(conf.return_value('priority'))
+
+ # Enable spanning tree protocol
+ if conf.exists('stp'):
+ bridge['stp'] = 1
+
+ return bridge
+
+def verify(bridge):
+ if bridge['dhcpv6_prm_only'] and bridge['dhcpv6_temporary']:
+ raise ConfigError('DHCPv6 temporary and parameters-only options are mutually exclusive!')
+
+ conf = Config()
+ for br in conf.list_nodes('interfaces bridge'):
+ # it makes no sense to verify ourself in this case
+ if br == bridge['intf']:
+ continue
+
+ for intf in bridge['member']:
+ tmp = conf.list_nodes('interfaces bridge {} member interface'.format(br))
+ if intf['name'] in tmp:
+ raise ConfigError('Interface "{}" belongs to bridge "{}" and can not be enslaved.'.format(intf['name'], bridge['intf']))
+
+ # the interface must exist prior adding it to a bridge
+ for intf in bridge['member']:
+ if intf['name'] not in interfaces():
+ raise ConfigError('Can not add non existing interface "{}" to bridge "{}"'.format(intf['name'], bridge['intf']))
+
+ # bridge members are not allowed to be bond members, too
+ for intf in bridge['member']:
+ for bond in conf.list_nodes('interfaces bonding'):
+ if conf.exists('interfaces bonding ' + bond + ' member interface'):
+ if intf['name'] in conf.return_values('interfaces bonding ' + bond + ' member interface'):
+ raise ConfigError('Interface {} belongs to bond {}, can not add it to {}'.format(intf['name'], bond, bridge['intf']))
+
+ return None
+
+def generate(bridge):
+ return None
+
+def apply(bridge):
+ br = BridgeIf(bridge['intf'])
+
+ if bridge['deleted']:
+ # delete interface
+ br.remove()
+ else:
+ # enable interface
+ br.set_state('up')
+ # set ageing time
+ br.set_ageing_time(bridge['aging'])
+ # set bridge forward delay
+ br.set_forward_delay(bridge['forwarding_delay'])
+ # set hello time
+ br.set_hello_time(bridge['hello_time'])
+ # set max message age
+ br.set_max_age(bridge['max_age'])
+ # set bridge priority
+ br.set_priority(bridge['priority'])
+ # turn stp on/off
+ br.set_stp(bridge['stp'])
+ # enable or disable IGMP querier
+ br.set_multicast_querier(bridge['igmp_querier'])
+ # update interface description used e.g. within SNMP
+ br.set_alias(bridge['description'])
+
+ # get DHCP config dictionary and update values
+ opt = br.get_dhcp_options()
+
+ if bridge['dhcp_client_id']:
+ opt['client_id'] = bridge['dhcp_client_id']
+
+ if bridge['dhcp_hostname']:
+ opt['hostname'] = bridge['dhcp_hostname']
+
+ if bridge['dhcp_vendor_class_id']:
+ opt['vendor_class_id'] = bridge['dhcp_vendor_class_id']
+
+ # store DHCPv6 config dictionary - used later on when addresses are aquired
+ br.set_dhcp_options(opt)
+
+ # get DHCPv6 config dictionary and update values
+ opt = br.get_dhcpv6_options()
+
+ if bridge['dhcpv6_prm_only']:
+ opt['dhcpv6_prm_only'] = True
+
+ if bridge['dhcpv6_temporary']:
+ opt['dhcpv6_temporary'] = True
+
+ # store DHCPv6 config dictionary - used later on when addresses are aquired
+ br.set_dhcpv6_options(opt)
+
+ # Change interface MAC address
+ if bridge['mac']:
+ br.set_mac(bridge['mac'])
+
+ # remove interface from bridge
+ for intf in bridge['member_remove']:
+ br.del_port( intf['name'] )
+
+ # add interfaces to bridge
+ for member in bridge['member']:
+ br.add_port(member['name'])
+
+ # up/down interface
+ if bridge['disable']:
+ br.set_state('down')
+
+ # Configure interface address(es)
+ # - not longer required addresses get removed first
+ # - newly addresses will be added second
+ for addr in bridge['address_remove']:
+ br.del_addr(addr)
+ for addr in bridge['address']:
+ br.add_addr(addr)
+
+ # configure additional bridge member options
+ for member in bridge['member']:
+ i = STPIf(member['name'])
+ # configure ARP cache timeout
+ i.set_arp_cache_tmo(bridge['arp_cache_tmo'])
+ # ignore link state changes
+ i.set_link_detect(bridge['disable_link_detect'])
+ # set bridge port path cost
+ i.set_path_cost(member['cost'])
+ # set bridge port path priority
+ i.set_path_priority(member['priority'])
+
+ return None
+
+if __name__ == '__main__':
+ try:
+ c = get_config()
+ verify(c)
+ generate(c)
+ apply(c)
+ except ConfigError as e:
+ print(e)
+ exit(1)