Fix setting hostname if host_11_1 template policy not found (#642)

mtarking · web-flow · commit bd8c0855b38a · 2025-10-21T15:00:22.000-04:00
* set hostname if host_11_1 template policy not found

* start refactor of action plugin

* refactor setting hostname

* refactor setting hostname

* default plugin defaults

* fix encoding

* remove epdb
diff --git a/plugins/action/dtc/update_switch_hostname_policy.py b/plugins/action/dtc/update_switch_hostname_policy.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2024 Cisco Systems, Inc. and its affiliates
+# Copyright (c) 2025 Cisco Systems, Inc. and its affiliates
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of
 # this software and associated documentation files (the "Software"), to deal in
@@ -24,47 +24,164 @@
 
 __metaclass__ = type
 
+import json
+
 from ansible.plugins.action import ActionBase
 from ansible_collections.cisco.nac_dc_vxlan.plugins.plugin_utils.helper_functions import ndfc_get_switch_policy_using_template
 
 
 class ActionModule(ActionBase):
+    """
+    Action plugin to manage switch hostname policy, host_11_1,
+    in Nexus Dashboard (ND) through comparison with the desired
+    switch name in the data model to switch hostname policy in ND
+    if it exists, or create it if it does not exist.
+    """
+    def __init__(self, *args, **kwargs):
+        super(ActionModule, self).__init__(*args, **kwargs)
+        self.tmp = None
+        self.task_vars = None
+        self.results = {}
+        self.results['failed'] = False
+        self.results['changed'] = False
+        # self.policy_add = {}
+        self.policy_update = {}
+
+    def _get_switch_policy(self, switch_serial_number, template_name):
+        """
+        Get switch hostname policy from Nexus Dashboard using
+        template name (host_11_1) and switch serial number.
+        """
+        return ndfc_get_switch_policy_using_template(
+            self=self,
+            task_vars=self.task_vars,
+            tmp=self.tmp,
+            switch_serial_number=switch_serial_number,
+            template_name=template_name
+        )
+
+    def nd_policy_add(self, switch_name, switch_serial_number):
+        """
+        Add switch hostname policy in Nexus Dashboard.
+        """
+        policy = {
+            "nvPairs": {
+                "SWITCH_NAME": switch_name
+            },
+            "entityName": "SWITCH",
+            "entityType": "SWITCH",
+            "source": "",
+            "priority": "100",
+            "description": "",
+            "templateName": "host_11_1",
+            "serialNumber": switch_serial_number
+        }
+
+        nd_policy_add = self._execute_module(
+            module_name="cisco.dcnm.dcnm_rest",
+            module_args={
+                "method": "POST",
+                "path": "/appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies",
+                "data": json.dumps(policy)
+            },
+            task_vars=self.task_vars,
+            tmp=self.tmp
+        )
+
+        if nd_policy_add.get('response'):
+            if nd_policy_add['response']['RETURN_CODE'] == 200:
+                self.results['changed'] = True
+
+        if nd_policy_add.get('msg'):
+            if nd_policy_add['msg']['RETURN_CODE'] != 200:
+                self.results['failed'] = True
+                self.results['msg'] = f"For switch {switch_name} addition; {nd_policy_add['msg']['DATA']['message']}"
+
+    def build_policy_update(self, policy, switch_name, switch_serial_number):
+        """
+        Build switch hostname policy update data structure.
+        """
+        policy["nvPairs"]["SWITCH_NAME"] = switch_name
+        self.policy_update.update({switch_serial_number: policy})
+
+    def nd_policy_update(self):
+        """
+        Bulk update switch hostname policy in Nexus Dashboard.
+        """
+        policy_ids = ",".join([str(value["policyId"]) for key, value in self.policy_update.items()])
+
+        nd_policy_update = self._execute_module(
+            module_name="cisco.dcnm.dcnm_rest",
+            module_args={
+                "method": "PUT",
+                "path": f"/appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/{policy_ids}/bulk",
+                "data": json.dumps(list(self.policy_update.values()))
+            },
+            task_vars=self.task_vars,
+            tmp=self.tmp
+        )
+
+        if nd_policy_update.get('response'):
+            if nd_policy_update['response']['RETURN_CODE'] == 200:
+                self.results['changed'] = True
+
+        if nd_policy_update.get('msg'):
+            if nd_policy_update['msg']['RETURN_CODE'] != 200:
+                self.results['failed'] = True
+                self.results['msg'] = f"Bulk update failed; {nd_policy_update['msg']['DATA']['message']}"
 
     def run(self, tmp=None, task_vars=None):
         results = super(ActionModule, self).run(tmp, task_vars)
         results['changed'] = False
 
+        self.task_vars = task_vars
+        self.tmp = tmp
+
         model_data = self._task.args["model_data"]
-        switch_serial_numbers = self._task.args["switch_serial_numbers"]
         template_name = self._task.args["template_name"]
 
-        policy_update = {}
+        dm_switches = []
+        switch_serial_numbers = []
+        if model_data["vxlan"]["fabric"]["type"] in ('VXLAN_EVPN', 'eBGP_VXLAN', 'ISN', 'External'):
+            dm_switches = model_data["vxlan"]["topology"]["switches"]
+            switch_serial_numbers = [dm_switch['serial_number'] for dm_switch in dm_switches]
 
         for switch_serial_number in switch_serial_numbers:
-            policy_match = ndfc_get_switch_policy_using_template(
-                self=self,
-                task_vars=task_vars,
-                tmp=tmp,
-                switch_serial_number=switch_serial_number,
-                template_name=template_name
-            )
-
-            dm_switches = []
-            if model_data["vxlan"]["fabric"]["type"] in ('VXLAN_EVPN', 'eBGP_VXLAN', 'ISN', 'External'):
-                dm_switches = model_data["vxlan"]["topology"]["switches"]
-            # elif model_data["vxlan"]["fabric"]["type"] in ('ISN'):
-            #     dm_switches = model_data["vxlan"]["multisite"]["isn"]["topology"]["switches"]
+            policy_match = self._get_switch_policy(switch_serial_number, template_name)
 
             switch_match = next((item for item in dm_switches if item["serial_number"] == switch_serial_number))
 
-            if policy_match["nvPairs"]["SWITCH_NAME"] != switch_match["name"]:
-                results['changed'] = True
-                policy_match["nvPairs"]["SWITCH_NAME"] = switch_match["name"]
-                policy_update.update({switch_serial_number: policy_match})
-
-        if policy_update:
-            results['changed'] = True
-
-        results['policy_update'] = policy_update
+            if not policy_match:
+                self.nd_policy_add(
+                    switch_name=switch_match['name'],
+                    switch_serial_number=switch_serial_number
+                )
+
+                if self.results['failed']:
+                    results['failed'] = self.results['failed']
+                    results['msg'] = self.results['msg']
+                    return results
+
+                if self.results['changed']:
+                    results['changed'] = self.results['changed']
+
+            if policy_match:
+                if policy_match["nvPairs"]["SWITCH_NAME"] != switch_match['name']:
+                    self.build_policy_update(
+                        policy=policy_match,
+                        switch_name=switch_match['name'],
+                        switch_serial_number=switch_serial_number
+                    )
+
+        if self.policy_update:
+            self.nd_policy_update()
+
+            if self.results['failed']:
+                results['failed'] = self.results['failed']
+                results['msg'] = self.results['msg']
+                return results
+
+            if self.results['changed']:
+                results['changed'] = self.results['changed']
 
         return results
diff --git a/plugins/plugin_utils/helper_functions.py b/plugins/plugin_utils/helper_functions.py
@@ -133,9 +133,12 @@ def ndfc_get_switch_policy_using_template(self, task_vars, tmp, switch_serial_nu
             (item for item in policy_data["response"]["DATA"] if item["templateName"] == template_name and item['serialNumber'] == switch_serial_number)
         )
     except StopIteration:
-        err_msg = f"Policy for template {template_name} and switch {switch_serial_number} not found!"
-        err_msg += f" Please ensure switch with serial number {switch_serial_number} is part of the fabric."
-        raise Exception(err_msg)
+        if template_name == "host_11_1":
+            policy_match = None
+        else:
+            err_msg = f"Policy for template {template_name} and switch {switch_serial_number} not found!"
+            err_msg += f" Please ensure switch with serial number {switch_serial_number} is part of the fabric."
+            raise Exception(err_msg)
 
     return policy_match
 
diff --git a/roles/dtc/create/tasks/common/devices_discovery.yml b/roles/dtc/create/tasks/common/devices_discovery.yml
@@ -115,31 +115,14 @@
     ansible_connect_timeout: 3000
   when:
     - MD_Extended.vxlan.topology.switches | length > 0
+    - MD_Extended.vxlan.underlay.general.manual_underlay_allocation is defined
+    - MD_Extended.vxlan.underlay.general.manual_underlay_allocation
     - change_flags.changes_detected_inventory or
       (change_flags.changes_detected_underlay_ip_address is defined and change_flags.changes_detected_underlay_ip_address)
 
-- name: Create List of Switch Serial Numbers from Data Model
-  ansible.builtin.set_fact:
-    md_serial_numbers: "{{ MD_Extended.vxlan.topology.switches | map(attribute='serial_number') | list }}"
-  delegate_to: localhost
-
 - name: Build Switch Hostname Policy Payload from Data Model Update
   cisco.nac_dc_vxlan.dtc.update_switch_hostname_policy:
     model_data: "{{ MD_Extended }}"
-    switch_serial_numbers: "{{ md_serial_numbers }}"
     template_name: host_11_1
-  register: results
+  when: MD_Extended.vxlan.topology.switches | length > 0
 # do not delegate_to: localhost as this action plugin uses Python to execute cisco.dcnm.dcnm_rest
-
-- name: Join List of Switch Hostname Policy IDs from Nexus Dashboard
-  ansible.builtin.set_fact:
-    policy_ids: "{{ results.policy_update.values() | map(attribute='policyId') | list | join('%2C') }}"
-  when: results.policy_update | length > 0
-  delegate_to: localhost
-
-- name: Update Switch Hostname Policy in Nexus Dashboard
-  cisco.dcnm.dcnm_rest:
-    method: PUT
-    path: "/appcenter/cisco/ndfc/api/v1/lan-fabric/rest/control/policies/{{ policy_ids }}/bulk"
-    json_data: "{{ results.policy_update.values() | list | to_json }}"
-  when: results.policy_update | length > 0
