Merge pull request #326 from cisco-en-programmability/develop

Develop

Author: bvargasre

changelogs/changelog.yaml

@@ -1971,3 +1971,17 @@ releases:
       deprecated_features:
         - The cisco.dnac collection is now deprecated. Please migrate to cisco.catalystcenter, which provides the same functionality under the updated Cisco Catalyst Center branding.
         - All modules now emit a deprecation warning at runtime directing users to cisco.catalystcenter.
+
+  6.48.2:
+    release_date: "2026-03-18"
+    changes:
+      release_summary: Changes in workflow manager modules, Documentation enhancements and Ansible Galaxy build configuration updates for the cisco.dnac Ansible Collection
+      minor_changes:
+        - Changes in events_and_notifications_workflow_manager module
+        - Changes in lan_automation_workflow_manager module
+        - Changes in reports_workflow_manager module
+        - Changes in sda_extranet_policies_workflow_manager module
+        - Changes in site_workflow_manager module
+        - Changes in template_workflow_manager module
+        - Changes in wired_campus_automation_workflow_manager module
+        - Changes in wireless_design_workflow_manager module

galaxy.yml

@@ -1,7 +1,7 @@
 ---
 namespace: cisco
 name: dnac
-version: 6.48.1
+version: 6.48.2
 readme: README.md
 authors:
   - Rafael Campos <rcampos@cloverhound.com>

plugins/module_utils/dnac.py

@@ -1738,11 +1738,13 @@ def is_json(self, file_path):
             self.log("The provided file '{0}' is not in JSON format".format(file_path), "CRITICAL")
             return False
 
-    def check_task_tree_response(self, task_id):
+    def check_task_tree_response(self, task_id, all_failure_reason=None):
         """
         Returns the task tree response of the task ID.
         Args:
             task_id (string) - The unique identifier of the task for which you want to retrieve details.
+            all_failure_reason (bool) - If True, retrieves all failure reasons for the task.
+
         Returns:
             error_msg (str) - Returns the task tree error message of the task ID.
         """
@@ -1752,15 +1754,24 @@ def check_task_tree_response(self, task_id):
             function='get_task_tree',
             params={"task_id": task_id}
         )
-        self.log("Retrieving task tree details by the API 'get_task_tree' using task ID: {0}, Response: {1}"
-                 .format(task_id, response), "DEBUG")
+        self.log(f"Retrieving task tree details by the API 'get_task_tree' using task ID: {task_id}, "
+                 f"and failure reason set to '{all_failure_reason}', "
+                 f"Response: {self.pprint(response)}", "DEBUG")
+
         error_msg = ""
         if response and isinstance(response, dict):
             result = response.get('response')
             error_messages = []
-            for item in result:
-                if item.get("isError") is True:
-                    error_messages.append(item.get("progress"))
+
+            if all_failure_reason is True:
+                for item in result:
+                    if item.get("isError") is True:
+                        error_messages.append(item.get("failureReason"))
+                        error_messages = error_messages[::-1]
+            else:
+                for item in result:
+                    if item.get("isError") is True:
+                        error_messages.append(item.get("progress"))
 
             if error_messages:
                 error_msg = ". ".join(error_messages) + "."
@@ -2207,7 +2218,7 @@ def get_taskid_post_api_call(self, api_family, api_function, api_parameters):
             )
             self.fail_and_exit(self.msg)
 
-    def get_task_status_from_tasks_by_id(self, task_id, task_name, success_msg):
+    def get_task_status_from_tasks_by_id(self, task_id, task_name, success_msg, all_reasons=None):
         """
         Retrieves and monitors the status of a task by its task ID.
         This function continuously checks the status of a specified task using its task ID.
@@ -2217,6 +2228,7 @@ def get_task_status_from_tasks_by_id(self, task_id, task_name, success_msg):
             task_id (str): The unique identifier of the task to monitor.
             task_name (str): The name of the task being monitored.
             success_msg (str): The success message to set if the task completes successfully.
+            all_reasons (bool, optional): If True, retrieves all failure reasons for the task. Defaults to None.
         Returns:
             self: The instance of the class with updated status and message.
         """
@@ -2253,15 +2265,18 @@ def get_task_status_from_tasks_by_id(self, task_id, task_name, success_msg):
                 if status == "FAILURE":
                     get_task_details_response = self.get_task_details_by_id(task_id)
                     failure_reason = get_task_details_response.get("failureReason")
-                    if failure_reason:
-                        self.msg = (
-                            "Failed to execute the task {0} with Task ID: {1}."
-                            "Failure reason: {2}".format(task_name, task_id, failure_reason)
-                        )
+                    if all_reasons is True:
+                        self.msg = self.check_task_tree_response(task_id, True)
                     else:
-                        self.msg = (
-                            "Failed to execute the task {0} with Task ID: {1}.".format(task_name, task_id)
-                        ).format(task_name, task_id)
+                        if failure_reason:
+                            self.msg = (
+                                "Failed to execute the task {0} with Task ID: {1}."
+                                "Failure reason: {2}".format(task_name, task_id, failure_reason)
+                            )
+                        else:
+                            self.msg = (
+                                "Failed to execute the task {0} with Task ID: {1}.".format(task_name, task_id)
+                            ).format(task_name, task_id)
                     self.set_operation_result("failed", False, self.msg, "ERROR")
                     break
                 elif status == "SUCCESS":

plugins/modules/events_and_notifications_workflow_manager.py

@@ -2352,11 +2352,32 @@ def collect_webhook_playbook_params(self, webhook_details):
 
         if webhook_details.get("headers") == []:
             playbook_params["headers"] = []
+            self.log(
+                "Webhook headers explicitly set to empty list in playbook - "
+                "existing headers will be removed during update.",
+                "DEBUG",
+            )
         elif webhook_details.get("headers"):
             custom_header = webhook_details["headers"]
             playbook_params["headers"] = []
             for header in custom_header:
                 playbook_params["headers"].append(header)
+            self.log(
+                "Webhook headers collected from playbook: {0}".format(
+                    playbook_params["headers"]
+                ),
+                "DEBUG",
+            )
+        else:
+            # Headers not specified in playbook — set to empty list so that
+            # any existing headers on the destination are detected as a change
+            # and removed during update.
+            playbook_params["headers"] = []
+            self.log(
+                "No webhook headers specified in playbook - defaulting to empty list. "
+                "Any existing headers on the destination will be removed during update.",
+                "DEBUG",
+            )
 
         return playbook_params
 

plugins/modules/lan_automation_workflow_manager.py

@@ -72,10 +72,12 @@
         type: dict
         suboptions:
           discovered_device_site_name_hierarchy:
-            description: Site hierarchy where the discovered
-              devices will be placed.
+            description: |
+              - Site hierarchy where the discovered
+                devices will be placed.
+              - Required only in merged state.
             type: str
-            required: true
+            required: false
           primary_device_management_ip_address:
             description: Management IP address of the
               primary or seed device in the LAN Automation
@@ -88,18 +90,22 @@
             type: str
             required: false
           primary_device_interface_names:
-            description: A list of interface names on
-              the primary device to be used for LAN
-              automation.
+            description: |
+              - A list of interface names on
+                the primary device to be used for LAN
+                automation.
+              - Required only in merged state.
             type: list
             elements: str
-            required: true
+            required: false
           ip_pools:
-            description: A list of IP pools used during
-              the LAN Automation session.
+            description: |
+              - A list of IP pools used during
+                the LAN Automation session.
+              - Required only in merged state.
             type: list
             elements: dict
-            required: true
+            required: false
             suboptions:
               ip_pool_name:
                 description: Name of the IP pool.
@@ -1041,15 +1047,15 @@ def validate_input(self):
                 "elements": "dict",
                 "discovered_device_site_name_hierarchy": {
                     "type": "str",
-                    "required": True,
+                    "required": False,
                 },
                 "primary_device_management_ip_address": {
                     "type": "str",
                     "required": True,
                 },
                 "primary_device_interface_names": {
                     "type": "list",
-                    "required": True,
+                    "required": False,
                     "elements": "str",
                 },
                 "peer_device_management_ip_address": {
@@ -1058,7 +1064,7 @@ def validate_input(self):
                 },
                 "ip_pools": {
                     "type": "list",
-                    "required": True,
+                    "required": False,
                     "elements": "dict",
                     "ip_pool_name": {"type": "str", "required": True},
                     "ip_pool_role": {
@@ -5115,10 +5121,10 @@ def get_lan_auto_task_status(self, task_id):
         pnp_authorization = lan_automation.get("pnpAuthorization", False)
         device_serials = [
             serial.upper()
-            for serial in lan_automation.get("deviceSerialNumberAuthorization", [])
+            for serial in (lan_automation.get("deviceSerialNumberAuthorization") or [])
         ] or [
             device.get("deviceSerialNumber", "").upper()
-            for device in lan_automation.get("discoveryDevices", [])
+            for device in (lan_automation.get("discoveryDevices") or [])
         ]
 
         self.log("LAN Automation Config: {}".format(lan_automation), "DEBUG")