Python/ifconfig: T1557: refactor Interface 'ifalias' property to set_alias()

8 files changed, 20 insertions, 40 deletions

diff --git a/python/vyos/ifconfig.py b/python/vyos/ifconfig.py
index 749bc6a1a..86e2084d3 100644
--- a/python/vyos/ifconfig.py
+++ b/python/vyos/ifconfig.py
@@ -261,36 +261,17 @@ class Interface:
         else:
             raise ValueError("Value out of range")
 
-    @property
-    def ifalias(self):
-        """
-        Get/set interface alias name
-
-        Example:
-
-        >>> from vyos.ifconfig import Interface
-        >>> Interface('eth0').ifalias
-        ''
-        """
-        return self._read_sysfs('/sys/class/net/{}/ifalias'
-                                .format(self._ifname))
-
-    @ifalias.setter
-    def ifalias(self, ifalias=None):
+    def set_alias(self, ifalias=None):
         """
-        Get/set interface alias name
+        Set interface alias name used by e.g. SNMP
 
         Example:
         >>> from vyos.ifconfig import Interface
-        >>> Interface('eth0').ifalias = 'VyOS upstream interface'
-        >>> Interface('eth0').ifalias
-        'VyOS upstream interface'
+        >>> Interface('eth0').set_alias('VyOS upstream interface')
 
-        to clear interface alias e.g. delete it use:
+        to clear alias e.g. delete it use:
 
-        >>> Interface('eth0').ifalias = ''
-        >>> Interface('eth0').ifalias
-        ''
+        >>> Interface('eth0').set_ifalias('')
         """
         if not ifalias:
             # clear interface alias
diff --git a/src/conf_mode/interface-bonding.py b/src/conf_mode/interface-bonding.py
index dce4a8106..8b4c8b625 100755
--- a/src/conf_mode/interface-bonding.py
+++ b/src/conf_mode/interface-bonding.py
@@ -84,7 +84,7 @@ def apply_vlan_config(vlan, config):
         raise TypeError()
 
     # update interface description used e.g. within SNMP
-    vlan.ifalias = config['description']
+    vlan.set_alias(config['description'])
     # ignore link state changes
     vlan.set_link_detect(config['disable_link_detect'])
     # Maximum Transmission Unit (MTU)
@@ -369,7 +369,7 @@ def apply(bond):
             b.arp_ip_target = '+' + addr
 
         # update interface description used e.g. within SNMP
-        b.ifalias = bond['description']
+        b.set_alias(bond['description'])
 
         #
         # missing DHCP/DHCPv6 options go here
diff --git a/src/conf_mode/interface-bridge.py b/src/conf_mode/interface-bridge.py
index 558ec3cc6..cadd44feb 100755
--- a/src/conf_mode/interface-bridge.py
+++ b/src/conf_mode/interface-bridge.py
@@ -201,7 +201,7 @@ def apply(bridge):
         # enable or disable IGMP querier
         br.set_multicast_querier(bridge['igmp_querier'])
         # update interface description used e.g. within SNMP
-        br.ifalias = bridge['description']
+        br.set_alias(bridge['description'])
 
         # Change interface MAC address
         if bridge['mac']:
diff --git a/src/conf_mode/interface-dummy.py b/src/conf_mode/interface-dummy.py
index 1b3fbcc93..2556722fa 100755
--- a/src/conf_mode/interface-dummy.py
+++ b/src/conf_mode/interface-dummy.py
@@ -78,28 +78,28 @@ def generate(dummy):
     return None
 
 def apply(dummy):
-    du = DummyIf(dummy['intf'])
+    d = DummyIf(dummy['intf'])
 
     # Remove dummy interface
     if dummy['deleted']:
-        du.remove()
+        d.remove()
     else:
         # enable interface
-        du.state = 'up'
+        d.state = 'up'
         # update interface description used e.g. within SNMP
-        du.ifalias = dummy['description']
+        d.set_alias(dummy['description'])
 
         # Configure interface address(es)
         # - not longer required addresses get removed first
         # - newly addresses will be added second
         for addr in dummy['address_remove']:
-            du.del_addr(addr)
+            d.del_addr(addr)
         for addr in dummy['address']:
-            du.add_addr(addr)
+            d.add_addr(addr)
 
         # disable interface on demand
         if dummy['disable']:
-            du.state = 'down'
+            d.state = 'down'
 
     return None
 
diff --git a/src/conf_mode/interface-ethernet.py b/src/conf_mode/interface-ethernet.py
index f4bc53a32..5c8c76827 100755
--- a/src/conf_mode/interface-ethernet.py
+++ b/src/conf_mode/interface-ethernet.py
@@ -67,7 +67,7 @@ def apply_vlan_config(vlan, config):
         raise TypeError()
 
     # update interface description used e.g. within SNMP
-    vlan.ifalias = config['description']
+    vlan.set_alias(config['description'])
     # ignore link state changes
     vlan.set_link_detect(config['disable_link_detect'])
     # Maximum Transmission Unit (MTU)
@@ -271,7 +271,7 @@ def apply(eth):
         e.remove()
     else:
         # update interface description used e.g. within SNMP
-        e.ifalias = eth['description']
+        e.set_alias(eth['description'])
 
         #
         # missing DHCP/DHCPv6 options go here
diff --git a/src/conf_mode/interface-loopback.py b/src/conf_mode/interface-loopback.py
index aba682f31..46fc6809b 100755
--- a/src/conf_mode/interface-loopback.py
+++ b/src/conf_mode/interface-loopback.py
@@ -75,8 +75,7 @@ def apply(loopback):
     lo = LoopbackIf(loopback['intf'])
     if not loopback['deleted']:
         # update interface description used e.g. within SNMP
-        # update interface description used e.g. within SNMP
-        lo.ifalias = loopback['description']
+        lo.set_alias(loopback['description'])
 
         # Configure interface address(es)
         # - not longer required addresses get removed first
diff --git a/src/conf_mode/interface-vxlan.py b/src/conf_mode/interface-vxlan.py
index f0fa7596a..638efda31 100755
--- a/src/conf_mode/interface-vxlan.py
+++ b/src/conf_mode/interface-vxlan.py
@@ -163,7 +163,7 @@ def apply(vxlan):
         # Finally create the new interface
         v = VXLANIf(vxlan['intf'], config=conf)
         # update interface description used e.g. by SNMP
-        v.ifalias = vxlan['description']
+        v.set_alias(vxlan['description'])
         # Maximum Transfer Unit (MTU)
         v.set_mtu(vxlan['mtu'])
 
diff --git a/src/conf_mode/interface-wireguard.py b/src/conf_mode/interface-wireguard.py
index 069298265..7254e153f 100755
--- a/src/conf_mode/interface-wireguard.py
+++ b/src/conf_mode/interface-wireguard.py
@@ -210,7 +210,7 @@ def apply(c):
     # ifalias for snmp from description
     descr_eff = c_eff.return_effective_value(ifname + ' description')
     if descr_eff != c[ifname]['descr']:
-        intfc.ifalias = str(c[ifname]['descr'])
+        intfc.set_alias(str(c[ifname]['descr']))
 
     # peer deletion
     peer_eff = c_eff.list_effective_nodes(ifname + ' peer')