Changes to rest module to choose from the OS using utils and action plugin

Author: sivakasi-cisco

plugins/action/dtc/fabric_check_sync.py

@@ -26,6 +26,7 @@
 
 from ansible.utils.display import Display
 from ansible.plugins.action import ActionBase
+from .rest_module_utils import get_rest_module
 
 
 display = Display()
@@ -40,8 +41,15 @@ def run(self, tmp=None, task_vars=None):
 
         fabric = self._task.args["fabric"]
 
+        network_os = task_vars['ansible_network_os']
+        rest_module = get_rest_module(network_os)
+        if not rest_module:
+            results['failed'] = True
+            results['msg'] = f"Unsupported network_os: {network_os}"
+            return results
+
         ndfc_response = self._execute_module(
-            module_name=task_vars['ansible_network_os_rest'],
+            module_name=rest_module,
             module_args={
                 "method": "GET",
                 "path": f"/appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabric}/inventory/switchesByFabric",

plugins/action/dtc/fabrics_config_save.py

@@ -24,8 +24,10 @@
 
 __metaclass__ = type
 
+
 from ansible.utils.display import Display
 from ansible.plugins.action import ActionBase
+from .rest_module_utils import get_rest_module
 
 
 display = Display()
@@ -42,8 +44,14 @@ def run(self, tmp=None, task_vars=None):
 
         for fabric in fabrics:
             display.display(f"Executing config-save on Fabric: {fabric}")
+            network_os = task_vars['ansible_network_os']
+            rest_module = get_rest_module(network_os)
+            if not rest_module:
+                results['failed'] = True
+                results['msg'] = f"Unsupported network_os: {network_os}"
+                return results
             ndfc_config_save = self._execute_module(
-                module_name=task_vars['ansible_network_os_rest'],
+                module_name=rest_module,
                 module_args={
                     "method": "POST",
                     "path": f"/appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabric}/config-save",

plugins/action/dtc/fabrics_deploy.py

@@ -24,8 +24,10 @@
 
 __metaclass__ = type
 
+
 from ansible.utils.display import Display
 from ansible.plugins.action import ActionBase
+from .rest_module_utils import get_rest_module
 
 
 display = Display()
@@ -39,11 +41,17 @@ def run(self, tmp=None, task_vars=None):
         results['failed'] = False
 
         fabrics = self._task.args["fabrics"]
-
         for fabric in fabrics:
             display.display(f"Executing config-deploy on Fabric: {fabric}")
+            network_os = task_vars['ansible_network_os']
+            rest_module = get_rest_module(network_os)
+            if not rest_module:
+                results['failed'] = True
+                results['msg'] = f"Unsupported network_os: {network_os}"
+                return results
+
             ndfc_deploy = self._execute_module(
-                module_name=task_vars['ansible_network_os_rest'],
+                module_name=rest_module,
                 module_args={
                     "method": "POST",
                     "path": f"/appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/fabrics/{fabric}/config-deploy?forceShowRun=false",

plugins/action/dtc/get_poap_data.py

@@ -139,17 +139,23 @@ def _get_discovered(self, ip, role, hostname):
 
         return discovered
 
+
     def refresh(self) -> None:
         """
         ### Summary
         Refresh POAP data from NDFC
-
         """
         self.refresh_succeeded = False
         self.refresh_message = None
 
+        from .rest_module_utils import get_rest_module
+        network_os = self.task_vars['ansible_network_os']
+        rest_module = get_rest_module(network_os)
+        if not rest_module:
+            self.refresh_message = f"Unsupported network_os: {network_os}"
+            return
         data = self.execute_module(
-            module_name=task_vars['ansible_network_os_rest'],
+            module_name=rest_module,
             module_args={
                 "method": self.poap_get_method,
                 "path": self.poap_get_path

plugins/action/dtc/manage_child_fabric_networks.py

@@ -24,10 +24,12 @@
 
 __metaclass__ = type
 
+
 from ansible.utils.display import Display
 from ansible.plugins.action import ActionBase
 from ansible.template import Templar
 from ansible.errors import AnsibleFileNotFound
+from .rest_module_utils import get_rest_module
 
 
 import json
@@ -53,6 +55,13 @@ def run(self, tmp=None, task_vars=None):
 
         child_fabrics = msite_data['child_fabrics_data']
 
+        network_os = task_vars['ansible_network_os']
+        rest_module = get_rest_module(network_os)
+        if not rest_module:
+            results['failed'] = True
+            results['msg'] = f"Unsupported network_os: {network_os}"
+            return results
+
         for network in networks:
             network_attach_group_switches = [
                 network_attach_groups_dict['switches']
@@ -130,7 +139,7 @@ def run(self, tmp=None, task_vars=None):
                         #         return results
 
                         ndfc_net = self._execute_module(
-                            module_name=task_vars['ansible_network_os_rest'],
+                            module_name=rest_module,
                             module_args={
                                 "method": "GET",
                                 "path": f"/appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{child_fabric}/networks/{network['name']}",
@@ -184,7 +193,7 @@ def run(self, tmp=None, task_vars=None):
                             rendered_to_nice_json = templar.environment.filters['to_nice_json'](rendered_content)
 
                             ndfc_net_update = self._execute_module(
-                                module_name=task_vars['ansible_network_os_rest'],
+                                module_name=rest_module,
                                 module_args={
                                     "method": "PUT",
                                     "path": f"/appcenter/cisco/ndfc/api/v1/lan-fabric/rest/top-down/fabrics/{child_fabric}/networks/{network['name']}",

plugins/action/dtc/manage_child_fabric_vrfs.py

@@ -24,10 +24,12 @@
 
 __metaclass__ = type
 
+
 from ansible.utils.display import Display
 from ansible.plugins.action import ActionBase
 from ansible.template import Templar
 from ansible.errors import AnsibleFileNotFound
+from .rest_module_utils import get_rest_module
 
 
 import json

plugins/action/dtc/manage_child_fabrics.py

@@ -24,8 +24,10 @@
 
 __metaclass__ = type
 
+
 from ansible.utils.display import Display
 from ansible.plugins.action import ActionBase
+from .rest_module_utils import get_rest_module
 
 display = Display()
 

plugins/action/dtc/prepare_msite_child_fabrics_data.py

@@ -24,8 +24,10 @@
 
 __metaclass__ = type
 
+
 from ansible.utils.display import Display
 from ansible.plugins.action import ActionBase
+from .rest_module_utils import get_rest_module
 
 display = Display()
 

plugins/action/dtc/prepare_msite_data.py

@@ -26,8 +26,9 @@
 
 from ansible.utils.display import Display
 from ansible.plugins.action import ActionBase
-from ...plugin_utils.helper_functions import ndfc_get_fabric_attributes
-from ...plugin_utils.helper_functions import ndfc_get_fabric_switches
+from .rest_module_utils import get_rest_module
+from ...plugin_utils/helper_functions import ndfc_get_fabric_attributes
+from ...plugin_utils/helper_functions import ndfc_get_fabric_switches
 import re
 
 display = Display()

plugins/action/dtc/rest_selector.py plugins/action/dtc/rest.pyplugins/action/dtc/rest_selector.py renamed to plugins/action/dtc/rest.py

@@ -35,9 +35,21 @@
 
 class ActionModule(ActionBase):
     """
-    Action plugin to dynamically select between cisco.nac_dc_vxlan.dtc.rest_selector and cisco.dcnm.dcnm_rest
+    Action plugin to dynamically select between cisco.nd.nd_rest and cisco.dcnm.dcnm_rest
     based on the ansible_network_os variable.
     """
+    REST_MODULES = {
+        'cisco.nd.nd': 'cisco.nd.nd_rest',
+        'cisco.dcnm.dcnm': 'cisco.dcnm.dcnm_rest'
+    }
+
+    def get_rest_module(self, network_os):
+        if not network_os:
+            results['failed'] = True
+            results['msg'] = "ansible_network_os is not defined in task_vars"
+        else:
+            results = self.REST_MODULES.get(network_os)
+        return results
 
     def run(self, tmp=None, task_vars=None):
         """
@@ -59,14 +71,12 @@ def run(self, tmp=None, task_vars=None):
         module_args = self._task.args.copy()
 
         # Get the network OS from task variables or module arguments
-        network_os = task_vars.get('ansible_network_os') \
-            or module_args.pop('ansible_network_os', None)
+        network_os = task_vars.get('ansible_network_os')
+        display.vvvv(f"Using OS module: {network_os}")
 
         # Determine which module to use based on network_os
-        if network_os == 'cisco.nd.nd':
-            rest_module = 'cisco.nac_dc_vxlan.dtc.rest_selector'
-        elif network_os == 'cisco.dcnm.dcnm':
-            rest_module = 'cisco.dcnm.dcnm_rest'
+        if network_os in self.REST_MODULES:
+            rest_module = self.get_rest_module(network_os)
         else:
             results['failed'] = True
             results['msg'] = (
@@ -75,27 +85,40 @@ def run(self, tmp=None, task_vars=None):
             )
             return results
 
-        display.vvvv(f"Using REST module: {rest_module}")
+        display.vvvv(f"Using ----------REST------------- module: {rest_module}")
 
         try:
+            display.vvvv(f"Executing module: {rest_module} with args: {module_args}")
+
+            self._task.vars['ansible_rest_os_module'] = rest_module
+
+            # Set the connection to httpapi
+            if 'connection' not in task_vars:
+                task_vars['connection'] = 'httpapi'
+                
             # Execute the appropriate REST module
             result = self._execute_module(
                 module_name=rest_module,
                 module_args=module_args,
                 task_vars=task_vars,
-                tmp=tmp
+                tmp=tmp,
+                wrap_async=False
             )
 
             # Update results with the module's results
             if result.get('failed'):
                 results.update(result)
+                display.error(f"Module execution failed: {result.get('msg')}")
             else:
                 results['changed'] = result.get('changed', False)
                 results.update(result)
+                display.vvvv(f"Module execution successful: {result}")
 
         except Exception as e:
+            import traceback
+            error_trace = traceback.format_exc()
             results['failed'] = True
-            results['msg'] = f"Failed to execute {rest_module}: {str(e)}"
+            results['msg'] = f"Failed to execute {rest_module}: {str(e)}\n{error_trace}"
             display.error(results['msg'], wrap_text=False)
 
         return results