fix restore task when contr_version is set and manager version is different than controller/validator (#123)

* BugFix122

* include check if contr_version exists to define new image definitions on restore task.

* Update CHANGELOG.md

---------

Co-authored-by: tzarski0 <92273798+tzarski0@users.noreply.github.com>

Author: llopezme-cisco

CHANGELOG.md

@@ -1,5 +1,6 @@
 # Catalyst SD-WAN Lab 2.1.5 [unreleased]
 
+- In restore task, fix issue where task might fail if Manager and Controller/Validator versions are not matching
 - In restore task, fix issue where the final output contains port 8443 instead of port used by PATty
 
 # Catalyst SD-WAN Lab 2.1.4 [Sep 10, 2025]

catalyst_sdwan_lab/tasks/restore.py

@@ -24,6 +24,7 @@
     DATA_DIR,
     check_manager_ip_is_free,
     configure_manager_basic_settings,
+    get_cml_sdwan_image_definition,
     get_sdwan_lab_parameters,
     load_certificate_details,
     onboard_control_components,
@@ -118,20 +119,38 @@ def main(
             )
 
     # Verify if requested software version is defined in CML
+    if contr_version:
+        manager_image = get_cml_sdwan_image_definition(
+            cml, "cat-sdwan-manager", contr_version
+        )
+        controller_image = get_cml_sdwan_image_definition(
+            cml, "cat-sdwan-controller", contr_version
+        )
+        validator_image = get_cml_sdwan_image_definition(
+            cml, "cat-sdwan-validator", contr_version
+        )
     cml_image_definitions = cml.definitions.image_definitions()
     defined_images = set(image["id"] for image in cml_image_definitions)
     missing_images = []
     for node in cml_topology_dict["nodes"]:
-        if (
-            node["node_definition"]
-            in ["cat-sdwan-controller", "cat-sdwan-manager", "cat-sdwan-validator"]
-            and contr_version
-        ):
+        if node["node_definition"] in ["cat-sdwan-manager"] and contr_version:
+            if (
+                f"{manager_image}" not in defined_images
+                and f"{manager_image}" not in missing_images
+            ):
+                missing_images.append(f"{manager_image}")
+        elif node["node_definition"] in ["cat-sdwan-controller"] and contr_version:
+            if (
+                f"{controller_image}" not in defined_images
+                and f"{controller_image}" not in missing_images
+            ):
+                missing_images.append(f"{controller_image}")
+        elif node["node_definition"] in ["cat-sdwan-validator"] and contr_version:
             if (
-                f'{node["node_definition"]}-{contr_version}' not in defined_images
-                and f'{node["node_definition"]}-{contr_version}' not in missing_images
+                f"{validator_image}" not in defined_images
+                and f"{validator_image}" not in missing_images
             ):
-                missing_images.append(f'{node["node_definition"]}-{contr_version}')
+                missing_images.append(f"{validator_image}")
         elif node["node_definition"] == "cat-sdwan-edge" and edge_version:
             if (
                 f'{node["node_definition"]}-{edge_version}' not in defined_images
@@ -246,14 +265,12 @@ def main(
         if contr_version:
             # Overwrite the image definition for control components
             for node in cml_topology_dict["nodes"]:
-                if node["node_definition"] in [
-                    "cat-sdwan-controller",
-                    "cat-sdwan-manager",
-                    "cat-sdwan-validator",
-                ]:
-                    node["image_definition"] = (
-                        f'{node["node_definition"]}-{contr_version}'
-                    )
+                if node["node_definition"] in ["cat-sdwan-manager"]:
+                    node["image_definition"] = f"{manager_image}"
+                if node["node_definition"] in ["cat-sdwan-controller"]:
+                    node["image_definition"] = f"{controller_image}"
+                if node["node_definition"] in ["cat-sdwan-validator"]:
+                    node["image_definition"] = f"{validator_image}"
         if edge_version:
             # Overwrite the image definition for control components
             for node in cml_topology_dict["nodes"]: