Set "interface vlanX" 'suppress_vlan_neigh' option

changelogs/fragments/448-set-suppress-vlan-neigh-option.yaml

@@ -0,0 +1,2 @@
+minor_changes:
+  - sonic-vxlan - Add 'suppress_vlan_neigh' vlan list option (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/448).

plugins/module_utils/network/sonic/argspec/vxlans/vxlans.py

@@ -1,6 +1,6 @@
 #
 # -*- coding: utf-8 -*-
-# © Copyright 2020 Dell Inc. or its subsidiaries. All Rights Reserved
+# © Copyright 2024 Dell Inc. or its subsidiaries. All Rights Reserved
 # GNU General Public License v3.0+
 # (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
@@ -61,6 +61,13 @@ def __init__(self, **kwargs):
                         'vrf': {'type': 'str'}
                     },
                     'type': 'list'
+                },
+                'suppress_vlan_neigh': {
+                    'elements': 'dict',
+                    'options': {
+                        'vlan_name': {'type': 'str'},
+                    },
+                    'type': 'list'
                 }
             },
             'type': 'list'

plugins/module_utils/network/sonic/config/vxlans/vxlans.py

@@ -1,6 +1,6 @@
 #
 # -*- coding: utf-8 -*-
-# © Copyright 2020 Dell Inc. or its subsidiaries. All Rights Reserved
+# © Copyright 2024 Dell Inc. or its subsidiaries. All Rights Reserved
 # GNU General Public License v3.0+
 # (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 """
@@ -43,11 +43,13 @@
 test_keys = [
     {'vlan_map': {'vlan': '', 'vni': ''}},
     {'vrf_map': {'vni': '', 'vrf': ''}},
+    {'suppress_vlan_neigh': {'vlan_name': ''}},
 ]
 test_keys_generate_config = [
     {'config': {'name': '', '__delete_op': __DELETE_CONFIG_IF_NO_SUBCONFIG}},
     {'vlan_map': {'vlan': '', 'vni': '', '__delete_op': __DELETE_CONFIG_IF_NO_SUBCONFIG}},
     {'vrf_map': {'vni': '', 'vrf': '', '__delete_op': __DELETE_CONFIG_IF_NO_SUBCONFIG}},
+    ['suppress_vlan_neigh', {'vlan_name': '', '__delete_op': __DELETE_CONFIG_IF_NO_SUBCONFIG}],
 ]
 
 
@@ -288,19 +290,23 @@ def get_create_vxlans_request(self, configs, have):
         tunnel_requests = self.get_create_tunnel_request(configs, have)
         vlan_map_requests = self.get_create_vlan_map_request(configs, have)
         vrf_map_requests = self.get_create_vrf_map_request(configs, have)
+        suppress_vlan_neigh_requests = self.get_create_suppress_vlan_neigh_request(configs, have)
 
         if tunnel_requests:
             requests.extend(tunnel_requests)
         if vlan_map_requests:
             requests.extend(vlan_map_requests)
         if vrf_map_requests:
             requests.extend(vrf_map_requests)
+        if suppress_vlan_neigh_requests:
+            requests.extend(suppress_vlan_neigh_requests)
 
         return requests
 
     def get_delete_all_vxlan_request(self, have):
         requests = []
 
+        suppress_vlan_neigh_requests = []
         vrf_map_requests = []
         vlan_map_requests = []
         src_ip_requests = []
@@ -314,13 +320,16 @@ def get_delete_all_vxlan_request(self, have):
         # vlan_map needs to be cleared before tunnel(source-ip)
         for conf in have:
             name = conf['name']
+            suppress_vlan_neigh_list = conf.get('suppress_vlan_neigh', [])
             vlan_map_list = conf.get('vlan_map', [])
             vrf_map_list = conf.get('vrf_map', [])
             src_ip = conf.get('source_ip', None)
             primary_ip = conf.get('primary_ip', None)
             external_ip = conf.get('external_ip', None)
             evpn_nvo = conf.get('evpn_nvo', None)
 
+            if suppress_vlan_neigh_list:
+                suppress_vlan_neigh_requests.extend(self.get_delete_suppress_vlan_neigh_request(conf, conf, name, suppress_vlan_neigh_list))
             if vrf_map_list:
                 vrf_map_requests.extend(self.get_delete_vrf_map_request(conf, conf, name, vrf_map_list))
             if vlan_map_list:
@@ -335,6 +344,8 @@ def get_delete_all_vxlan_request(self, have):
                 evpn_nvo_requests.extend(self.get_delete_evpn_request(conf, conf, evpn_nvo))
             tunnel_requests.extend(self.get_delete_tunnel_request(conf, conf, name))
 
+        if suppress_vlan_neigh_requests:
+            requests.extend(suppress_vlan_neigh_requests)
         if vrf_map_requests:
             requests.extend(vrf_map_requests)
         if vlan_map_requests:
@@ -358,6 +369,7 @@ def get_delete_vxlan_request(self, configs, have):
         if not configs:
             return requests
 
+        suppress_vlan_neigh_requests = []
         vrf_map_requests = []
         vlan_map_requests = []
         src_ip_requests = []
@@ -378,41 +390,42 @@ def get_delete_vxlan_request(self, configs, have):
             external_ip = conf.get('external_ip', None)
             vlan_map_list = conf.get('vlan_map', None)
             vrf_map_list = conf.get('vrf_map', None)
+            suppress_vlan_neigh_list = conf.get('suppress_vlan_neigh', None)
 
-            have_vlan_map_count = 0
-            have_vrf_map_count = 0
             matched = next((each_vxlan for each_vxlan in have if each_vxlan['name'] == name), None)
             if matched:
                 have_vlan_map = matched.get('vlan_map', [])
                 have_vrf_map = matched.get('vrf_map', [])
-                if have_vlan_map:
-                    have_vlan_map_count = len(have_vlan_map)
-                if have_vrf_map:
-                    have_vrf_map_count = len(have_vrf_map)
+                have_suppress_vlan_neigh = matched.get('suppress_vlan_neigh', [])
 
             is_delete_full = False
             if (name and vlan_map_list is None and vrf_map_list is None and
                     src_ip is None and evpn_nvo is None and primary_ip is None and
-                    external_ip is None):
+                    external_ip is None and suppress_vlan_neigh_list is None):
                 is_delete_full = True
                 vrf_map_list = matched.get("vrf_map", [])
                 vlan_map_list = matched.get("vlan_map", [])
+                suppress_vlan_neigh_list = matched.get("suppress_vlan_neigh", [])
 
             if vlan_map_list is not None and len(vlan_map_list) == 0 and matched:
                 vlan_map_list = matched.get("vlan_map", [])
             if vrf_map_list is not None and len(vrf_map_list) == 0 and matched:
                 vrf_map_list = matched.get("vrf_map", [])
+            if suppress_vlan_neigh_list is not None and len(suppress_vlan_neigh_list) == 0 and matched:
+                suppress_vlan_neigh_list = matched.get("suppress_vlan_neigh", [])
 
             if vrf_map_list:
                 temp_vrf_map_requests = self.get_delete_vrf_map_request(conf, matched, name, vrf_map_list)
                 if temp_vrf_map_requests:
                     vrf_map_requests.extend(temp_vrf_map_requests)
-                    have_vrf_map_count -= len(temp_vrf_map_requests)
             if vlan_map_list:
                 temp_vlan_map_requests = self.get_delete_vlan_map_request(conf, matched, name, vlan_map_list)
                 if temp_vlan_map_requests:
                     vlan_map_requests.extend(temp_vlan_map_requests)
-                    have_vlan_map_count -= len(temp_vlan_map_requests)
+            if suppress_vlan_neigh_list:
+                temp_suppress_vlan_neigh_requests = self.get_delete_suppress_vlan_neigh_request(conf, matched, name, suppress_vlan_neigh_list)
+                if temp_suppress_vlan_neigh_requests:
+                    suppress_vlan_neigh_requests.extend(temp_suppress_vlan_neigh_requests)
             if src_ip:
                 src_ip_requests.extend(self.get_delete_src_ip_request(conf, matched, name, src_ip))
             if evpn_nvo:
@@ -424,6 +437,8 @@ def get_delete_vxlan_request(self, configs, have):
             if is_delete_full:
                 tunnel_requests.extend(self.get_delete_tunnel_request(conf, matched, name))
 
+        if suppress_vlan_neigh_requests:
+            requests.extend(suppress_vlan_neigh_requests)
         if vrf_map_requests:
             requests.extend(vrf_map_requests)
         if vlan_map_requests:
@@ -562,6 +577,41 @@ def build_create_vrf_map_payload(self, conf, vrf_map):
         payload_url = dict({"sonic-vrf:vni": vrf_map['vni']})
         return payload_url
 
+    def get_create_suppress_vlan_neigh_request(self, configs, have):
+        # Create URL and payload
+        requests = []
+        payload = dict()
+        vlan_list = []
+        is_change_needed = False
+
+        for conf in configs:
+            name = conf['name']
+            new_suppress_vlan_neigh_list = conf.get('suppress_vlan_neigh', [])
+            if new_suppress_vlan_neigh_list:
+                is_change_needed = True
+                for each_suppress_vlan_neigh in new_suppress_vlan_neigh_list:
+                    vlan_name = each_suppress_vlan_neigh.get('vlan_name')
+                    vlan_list.append(vlan_name)
+
+                payload.update(self.build_create_suppress_vlan_neigh_payload(vlan_list))
+                url = "data/sonic-vxlan:sonic-vxlan/SUPPRESS_VLAN_NEIGH"
+                request = {"path": url, "method": PATCH, "data": payload}
+                requests.append(request)
+
+        return requests
+
+    def build_create_suppress_vlan_neigh_payload(self, vlan_list):
+        payload_url = dict()
+
+        vlans = []
+        for vlan in vlan_list:
+            suppress_vlan_neigh_dict = dict()
+            suppress_vlan_neigh_dict['name'] = vlan
+            suppress_vlan_neigh_dict['suppress'] = 'on'
+            vlans.append(suppress_vlan_neigh_dict)
+        payload_url['sonic-vxlan:SUPPRESS_VLAN_NEIGH'] = {'SUPPRESS_VLAN_NEIGH_LIST': vlans}
+        return payload_url
+
     def get_delete_evpn_request(self, conf, matched, del_evpn_nvo):
         # Create URL and payload
         requests = []
@@ -686,6 +736,29 @@ def get_delete_vrf_map_request(self, conf, matched, name, del_vrf_map_list):
 
         return requests
 
+    def get_delete_suppress_vlan_neigh_request(self, conf, matched, name, del_suppress_vlan_neigh_list):
+        # Create URL and payload
+        requests = []
+
+        for each_suppress_vlan_neigh in del_suppress_vlan_neigh_list:
+            vlan_name = each_suppress_vlan_neigh.get('vlan_name')
+
+            is_change_needed = False
+            if matched:
+                matched_suppress_vlan_neigh_list = matched.get('suppress_vlan_neigh', None)
+                if matched_suppress_vlan_neigh_list:
+                    matched_suppress_vlan_neigh = next(
+                        (e_svn for e_svn in matched_suppress_vlan_neigh_list if e_svn['vlan_name'] == vlan_name), None)
+                    if matched_suppress_vlan_neigh:
+                        is_change_needed = True
+
+            if is_change_needed:
+                url = "data/sonic-vxlan:sonic-vxlan/SUPPRESS_VLAN_NEIGH/SUPPRESS_VLAN_NEIGH_LIST={vlan_name}".format(vlan_name=vlan_name)
+                request = {"path": url, "method": DELETE}
+                requests.append(request)
+
+        return requests
+
     def sort_lists_in_config(self, config):
         if config:
             config.sort(key=lambda x: x['name'])
@@ -694,13 +767,16 @@ def sort_lists_in_config(self, config):
                     cfg['vlan_map'].sort(key=lambda x: x['vni'])
                 if 'vrf_map' in cfg and cfg['vrf_map']:
                     cfg['vrf_map'].sort(key=lambda x: x['vni'])
+                if 'suppress_vlan_neigh' in cfg and cfg['suppress_vlan_neigh']:
+                    cfg['suppress_vlan_neigh'].sort(key=lambda x: x['vlan_name'])
 
     def post_process_generated_config(self, configs):
         confs = remove_empties_from_list(configs)
         if confs:
             for conf in confs[:]:
                 vlan_map = conf.get('vlan_map', None)
                 vrf_map = conf.get('vrf_map', None)
-                if not vlan_map and not vrf_map:
+                suppress_vlan_neigh = conf.get('suppress_vlan_neigh', None)
+                if not vlan_map and not vrf_map and not suppress_vlan_neigh:
                     confs.remove(conf)
         return confs

plugins/module_utils/network/sonic/facts/vxlans/vxlans.py

@@ -1,6 +1,6 @@
 #
 # -*- coding: utf-8 -*-
-# © Copyright 2020 Dell Inc. or its subsidiaries. All Rights Reserved
+# © Copyright 2024 Dell Inc. or its subsidiaries. All Rights Reserved
 # GNU General Public License v3.0+
 # (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 """
@@ -97,6 +97,7 @@ def get_all_vxlans(self):
         vxlans = []
         vxlan_tunnels = []
         vxlan_vlan_map = []
+        suppress_vlans = []
 
         vxlans_tunnels_vlan_map = self.get_all_vxlans_tunnels_vlan_map()
         vxlans_evpn_nvo_list = self.get_all_vxlans_evpn_nvo_list()
@@ -109,12 +110,18 @@ def get_all_vxlans(self):
             if vxlans_tunnels_vlan_map['VXLAN_TUNNEL_MAP'].get('VXLAN_TUNNEL_MAP_LIST'):
                 vxlan_vlan_map.extend(vxlans_tunnels_vlan_map['VXLAN_TUNNEL_MAP']['VXLAN_TUNNEL_MAP_LIST'])
 
+        if vxlans_tunnels_vlan_map.get('SUPPRESS_VLAN_NEIGH'):
+            if vxlans_tunnels_vlan_map['SUPPRESS_VLAN_NEIGH'].get('SUPPRESS_VLAN_NEIGH_LIST'):
+                suppress_vlans.extend(vxlans_tunnels_vlan_map['SUPPRESS_VLAN_NEIGH']['SUPPRESS_VLAN_NEIGH_LIST'])
+
         self.fill_tunnel_source_ip(vxlans, vxlan_tunnels, vxlans_evpn_nvo_list)
         self.fill_vlan_map(vxlans, vxlan_vlan_map)
 
         vxlan_vrf_list = self.get_all_vxlans_vrf_list()
         self.fill_vrf_map(vxlans, vxlan_vrf_list)
 
+        self.fill_suppress_vlan_neigh(vxlans, suppress_vlans)
+
         return vxlans
 
     def get_all_vxlans_vrf_list(self):
@@ -204,3 +211,21 @@ def fill_vrf_map(self, vxlans, vxlan_vrf_list):
                     vrf_map.append(dict({'vni': vni, 'vrf': vrf}))
                 else:
                     matched_vtep['vrf_map'] = [dict({'vni': vni, 'vrf': vrf})]
+
+    def fill_suppress_vlan_neigh(self, vxlans, suppress_vlans):
+        suppress_vlan_neigh = dict()
+        suppress_vlan_neigh_list = []
+        for each_suppress_vlan_neigh in suppress_vlans:
+            name = each_suppress_vlan_neigh.get('name', None)
+            if name is None:
+                continue
+            matched_suppress_vn = None
+            if vxlans:
+                matched_suppress_vn = vxlans[0]
+
+            if matched_suppress_vn:
+                suppress_vlan_neigh = matched_suppress_vn.get('suppress_vlan_neigh')
+                if suppress_vlan_neigh:
+                    suppress_vlan_neigh.append(dict({'vlan_name': name}))
+                else:
+                    matched_suppress_vn['suppress_vlan_neigh'] = [dict({'vlan_name': name})]

plugins/modules/sonic_vxlans.py

@@ -87,6 +87,15 @@
           vrf:
             type: str
             description: 'VRF name for VNI VRF map.'
+      suppress_vlan_neigh:
+        description: 'list map of VLAN names with suppress on'
+        version_added: 3.1.0
+        type: list
+        elements: dict
+        suboptions:
+          vlan_name:
+            type: str
+            description: 'name of VLAN'
   state:
     description: 'The state of the configuration after module completion.'
     type: str
@@ -112,6 +121,8 @@
 # map vni 102 vlan 12
 # map vni 101 vrf Vrfcheck1
 # map vni 102 vrf Vrfcheck2
+# suppress vlan-neigh vlan_name Vlan11
+# suppress vlan-neigh vlan_name Vlan12
 #!
 #
 - name: "Test vxlans deleted state 01"
@@ -125,6 +136,9 @@
         vrf_map:
           - vni: 101
             vrf: Vrfcheck1
+        suppress_vlan_neigh:
+          - vlan_name: Vlan11
+          - vlan_name: Vlan12
     state: deleted
 #
 # After state:
@@ -189,6 +203,9 @@
             vrf: Vrfcheck1
           - vni: 102
             vrf: Vrfcheck2
+        suppress_vlan_neigh:
+          - vlan_name: Vlan11
+          - vlan_name: Vlan12
     state: merged
 #
 # After state:
@@ -203,6 +220,8 @@
 # map vni 102 vlan 12
 # map vni 101 vrf Vrfcheck1
 # map vni 102 vrf Vrfcheck2
+# suppress vlan-neigh vlan-name Vlan11
+# suppress vlan-neigh vlan-name Vlan12
 #!
 #
 # Using overridden