Fix issue with breakout with multiple switch (#484)

* Update dcnm_interface.py

* Update dcnm_interface.py

* Update dcnm_interface.py

* Update dcnm_interface.py

* Update dcnm_interface.py

* Update dcnm_interface.py

* Update dcnm_interface.py

* Update dcnm_interface.py

* Comment update

---------

Co-authored-by: mwiebe <[email protected]>

Author: ccoueffe

plugins/modules/dcnm_interface.py

@@ -1886,8 +1886,8 @@ def __init__(self, module):
         self.diff_replace = []
         self.diff_delete = [[], [], [], [], [], [], [], [], []]
         self.diff_delete_deploy = [[], [], [], [], [], [], [], [], []]
-        self.breakout = []
         self.want_breakout = []
+        self.have_breakout = []
         self.diff_create_breakout = []
         self.diff_delete_breakout = []
         self.diff_deploy = []
@@ -2099,11 +2099,6 @@ def __init__(self, module):
             "BREAKOUT": 8,
         }
 
-        # Build breakout list in config
-        for interface in self.config:
-            if interface.get("type") and interface["type"] == "breakout":
-                self.breakout.append(interface["name"])
-
         msg = "ENTERED DcnmIntf: "
         self.log.debug(msg)
 
@@ -2121,19 +2116,32 @@ def dcnm_intf_breakout_format(self, if_name):
         # Return False and None if the pattern does not match
         return False, None
 
-    def dcnm_intf_get_parent(self, cfg, name):
-        # Extract the parent interface ID (e.g., "1/2" from "1/2/3")
+    def dcnm_intf_get_parent(self, name, switch):
+        """
+        Given an interface name and switch serial number, determine if the parent breakout interface exists in the target config.
+
+        Args:
+            cfg (list): List of interface configuration dictionaries.
+            name (str): Interface name to check (e.g., "Ethernet1/100/1").
+            switch (str): Switch Mgmt IP Address.
+
+        Returns:
+            tuple: (True, type) if parent breakout interface exists, else (False, None).
+        """
+        # Extract the parent interface ID (e.g., "1/100" from "Ethernet1/100/1")
         match = re.search(r"(\d+/\d+)/\d+", name)
         if not match:
             return False, None  # Return early if the pattern doesn't match
 
-        parent_port_id = f"ethernet{match.group(1)}"
-
-        # Search for the parent interface in the configuration
-        for interface in cfg:
-            if interface.get("name").lower() == parent_port_id:
+        parent_intf = f"Ethernet{match.group(1)}"
+        # Check if the parent interface exists in the config for the given switch
+        for interface in self.config:
+            if (
+                interface["name"].lower() == parent_intf.lower()
+                and interface.get("type", "").lower() == "breakout"
+                and interface["switch"][0] == switch
+            ):
                 return True, interface.get("type", None)
-
         return False, None
 
     def dcnm_intf_dump_have_all(self):
@@ -3872,11 +3880,13 @@ def dcnm_intf_get_want(self):
                         # Process non-breakout_interface policies
                         if intf_payload not in self.want:
                             intf = intf_payload["interfaces"][0]["ifName"]
-                            is_valid_format, formatted_interface = self.dcnm_intf_breakout_format(intf)
-
-                            # Add to self.want only if the interface does not match invalid breakout conditions
-                            if not (is_valid_format and formatted_interface not in self.breakout):
-
+                            is_breakout_format, formatted_interface = self.dcnm_intf_breakout_format(intf)
+                            parent_breakout_found, parent_type = self.dcnm_intf_get_parent(intf, sw)
+                            # Add breakout interface to self.want only if breakout is configured in state overridden
+                            # When state is replaced, we don't check if parent is configured.
+                            if is_breakout_format is False or parent_breakout_found is True and self.params['state'] == "overridden":
+                                self.want.append(intf_payload)
+                            else:
                                 self.want.append(intf_payload)
 
     def dcnm_intf_get_intf_info(self, ifName, serialNumber, ifType):
@@ -3926,6 +3936,19 @@ def dcnm_intf_get_have_all_with_sno(self, sno):
         if resp and "DATA" in resp and resp["DATA"]:
             self.have_all.extend(resp["DATA"])
 
+    def dcnm_intf_get_have_all_breakout_interfaces(self, sno):
+        # This function will get policies for a given serial number and
+        # populate the breakout interfaces in self.have_breakout
+        path = "/appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/switches/{}".format(sno)
+        resp = dcnm_send(self.module, "GET", path)
+
+        breakout = []
+        if resp and "DATA" in resp and resp["DATA"]:
+            for elem in resp["DATA"]:
+                if elem.get('templateName', None) == "breakout_interface":
+                    breakout.append(elem['entityName'])
+            self.have_breakout.append({sno: breakout})
+
     def dcnm_intf_get_have_all(self, sw):
 
         # Check if you have already got the details for this switch
@@ -3942,6 +3965,7 @@ def dcnm_intf_get_have_all(self, sw):
 
         self.have_all_list.append(sw)
         self.dcnm_intf_get_have_all_with_sno(sno)
+        self.dcnm_intf_get_have_all_breakout_interfaces(sno)
 
     def dcnm_intf_get_have(self):
 
@@ -4242,30 +4266,34 @@ def dcnm_intf_compare_want_and_have(self, state):
         if state != "deleted":
             for want_breakout in self.want_breakout:
                 want_intf = want_breakout["interfaces"][0]["ifName"]
+                want_serialnumber = want_breakout["interfaces"][0]["serialNumber"]
                 match_create = False
-                for have_intf in self.have_all:
-                    is_valid, intf = self.dcnm_intf_breakout_format(have_intf['ifName'])
-                    if is_valid and want_intf == intf:
-                        match_create = True
-
-                # If interface in want_breakout and interface e1/x/y not present
-                # add to diff_create_breakout
+                # Search if interface is in have_breakout
+                for elem in self.have_breakout:
+                    if want_serialnumber == list(elem.keys())[0]:
+                        for interface in elem[want_serialnumber]:
+                            if interface.lower() == want_intf.lower():
+                                # If the breakout interface is already present in have,
+                                # skip adding it to diff_create_breakout
+                                match_create = True
+                                break
                 if not match_create:
-                    want_breakout["interfaces"][0].pop("fabricName")
-                    want_breakout["interfaces"][0].pop("interfaceType")
                     self.diff_create_breakout.append(want_breakout["interfaces"])
 
         if state == "deleted" or state == "overridden":
-            for have in self.have_all:
-                have_intf = have['ifName']
-                if re.search(r"\d+\/\d+\/\d+", have_intf):
-                    found, parent_type = self.dcnm_intf_get_parent(self.config, have_intf)
-                    # If have not in want breakout and if match to E1/x/1 add to dict
-                    # Else if match E1/x/2, etc. silently ignore, because we delete the breakout
-                    # with the first sub if.
-                    if re.search(r"\d+\/\d+\/1$", have_intf) and not found:
-                        payload = {'serialNumber': have['serialNo'],
-                                   'ifName': have['ifName']}
+            for have_breakout in self.have_breakout:
+                for interface in list(have_breakout.values())[0]:
+                    match_delete_interface = True
+                    for want_breakout in self.want_breakout:
+                        if list(have_breakout.keys())[0] == want_breakout["interfaces"][0]["serialNumber"]:
+                            if want_breakout["interfaces"][0]["ifName"] == interface:
+                                match_delete_interface = False
+                                break
+                    if match_delete_interface:
+                        payload = {
+                            "serialNumber": list(have_breakout.keys())[0],
+                            "ifName": interface + "/1"
+                        }
                         self.diff_delete_breakout.append(payload)
 
         for want in self.want:
@@ -4288,7 +4316,6 @@ def dcnm_intf_compare_want_and_have(self, state):
                     and (sno == d["interfaces"][0]["serialNumber"])
                 )
             ]
-
             if not match_have:
                 changed_dict = copy.deepcopy(want)
 
@@ -4447,12 +4474,11 @@ def dcnm_intf_compare_want_and_have(self, state):
             if action == "add":
                 # If E1/x/y do not create. Interface is created with breakout
                 if re.search(r"\d+\/\d+\/\d+", name):
-                    found, parent_type = self.dcnm_intf_get_parent(self.config, name)
-                    if found and parent_type == "breakout":
-                        if want.get("interfaceType", None) is not None:
-                            want.pop("interfaceType")
-                        self.diff_replace.append(want)
-                        self.changed_dict[0][state].append(changed_dict)
+                    if want.get("interfaceType", None) is not None:
+                        want.pop("interfaceType")
+                    self.dcnm_intf_merge_intf_info(want, self.diff_replace)
+                    self.changed_dict[0][state].append(changed_dict)
+                    intf_changed = True
                     continue
                 self.dcnm_intf_merge_intf_info(want, self.diff_create)
                 # Add the changed_dict to self.changed_dict
@@ -4471,7 +4497,7 @@ def dcnm_intf_compare_want_and_have(self, state):
             if str(deploy).lower() == "true":
                 # Add to diff_deploy,
                 #   1. if intf_changed is True
-                #   2. if intf_changed is Flase, then if 'complianceStatus is
+                #   2. if intf_changed is False, then if 'complianceStatus is
                 #      False then add to diff_deploy.
                 #   3. Do not add otherwise
 
@@ -4838,8 +4864,7 @@ def dcnm_intf_get_diff_overridden(self, cfg):
                     # If a match for Ethernet1/x/y is found, verify if the parent interface Ethernet1/x exists in cfg.
                     # If the parent doesn't exist or isn't of type "breakout", remove the breakout interface.
                     if re.search(r"\d+\/\d+\/\d+", name):
-                        found, parent_type = self.dcnm_intf_get_parent(cfg, name)
-
+                        found, parent_type = self.dcnm_intf_get_parent(name, have['mgmtIpAddress'])
                         if not (found and parent_type == "breakout"):
                             payload = {
                                 "serialNumber": have["serialNo"],
@@ -5047,7 +5072,7 @@ def dcnm_intf_get_diff_deleted(self):
                     for have in self.have_all:
                         have_intf = have['ifName']
                         if re.search(r"\d+\/\d+\/\d+", have_intf):
-                            found, parent_type = self.dcnm_intf_get_parent(self.config, have_intf)
+                            found, parent_type = self.dcnm_intf_get_parent(have_intf, have['mgmtIpAddress'])
                             # If have in want breakout and if match to E1/x/1 add to dict
                             # Else if match E1/x/2, etc. silently ignore, because we delete the breakout
                             # with the first sub if.
@@ -5505,7 +5530,7 @@ def dcnm_intf_send_message_to_dcnm(self):
             # index 8 is used for breakout interface
             if delete_index == 8:
                 path = "/appcenter/cisco/ndfc/api/v1/lan-fabric/rest/interface"
-
+                break
             json_payload = json.dumps(delem)
 
             resp = dcnm_send(self.module, "DELETE", path, json_payload)
@@ -5596,7 +5621,7 @@ def dcnm_intf_send_message_to_dcnm(self):
                 resp["CHANGED"] = self.changed_dict
                 self.module.fail_json(msg=resp)
             else:
-                replace = True
+                create = True
 
         # Update interfaces
         path = self.paths["INTERFACE"]
@@ -5629,7 +5654,7 @@ def dcnm_intf_send_message_to_dcnm(self):
                 resp["CHANGED"] = self.changed_dict
                 self.module.fail_json(msg=resp)
             else:
-                replace = True
+                delete = changed
 
         resp = None
         path = self.paths["GLOBAL_IF"]