EXOS quirk: Rename VLAN 1 to Default (#3257)

Author: sdargoeuves

netsim/ansible/templates/vlan/exos.j2

@@ -1,5 +1,5 @@
 {% if vlans is defined %}
-configure vlan default delete ports all
+configure vlan Default delete ports all
 {% endif %}
 {% for ifdata in interfaces if ifdata.vlan is defined and ifdata.type|default('') not in ['svi','vlan_member'] %}
 {%   if ifdata.vlan.trunk is defined %}

netsim/devices/exos.py

@@ -3,6 +3,7 @@
 from ..utils import log
 from . import _Quirks, need_ansible_collection, report_quirk
 
+EXOS_VLAN_1_NAME = 'Default'
 
 def check_vrrp_address_families(node: Box) -> None:
   for intf in node.interfaces:
@@ -17,11 +18,51 @@ def check_vrrp_address_families(node: Box) -> None:
         category=log.IncorrectType)
       return
 
+def rename_interface_vlan_references(intf: Box, old_name: str, new_name: str) -> None:
+  for kw in ('vlan.access','vlan.native','vlan.name','vlan_name','_vlan_native'):
+    if intf.get(kw,None) == old_name:
+      intf[kw] = new_name
+
+  trunk = intf.get('vlan.trunk',None)
+  if trunk and old_name in trunk:
+    trunk[new_name] = trunk.pop(old_name)
+
+def default_vlan_1(node: Box) -> None:
+  if 'vlans' not in node:
+    return
+
+  if EXOS_VLAN_1_NAME in node.vlans and node.vlans[EXOS_VLAN_1_NAME].id != 1:
+    report_quirk(
+      text=f'{EXOS_VLAN_1_NAME} VLAN must have VLAN tag 1',
+      node=node,
+      category=log.IncorrectValue)
+    return
+
+  vlan_1_name = next(
+    (vname for vname,vdata in node.vlans.items() 
+       if vdata.get('id',None) == 1 and vname != EXOS_VLAN_1_NAME),
+    None)
+  if not vlan_1_name:
+    return
+
+  node.vlans[EXOS_VLAN_1_NAME] = node.vlans.pop(vlan_1_name)
+
+  for intf in node.interfaces:
+    rename_interface_vlan_references(intf,vlan_1_name,EXOS_VLAN_1_NAME)
+
+  report_quirk(
+    text='Extreme EXOS reserves VLAN ID 1 for the built-in Default VLAN',
+    more_data=f'Renaming VLAN {vlan_1_name} to {EXOS_VLAN_1_NAME} on node {node.name}',
+    node=node,
+    quirk='vlan.default_1',
+    category=Warning)
 
 class EXOS(_Quirks):
 
   @classmethod
   def device_quirks(cls, node: Box, topology: Box) -> None:
+    if 'vlan' in node.get('module',[]):
+      default_vlan_1(node)
     if 'gateway' in node.get('module',[]):
       check_vrrp_address_families(node)