VRFs should never deploy when deploy flag is False (#491)

* Initial work on this issue

* Updated dcnm_vrf to honor deploy flag

* Fixed whitespace sanity issue

---------

Co-authored-by: Neil John <[email protected]>

Author: mikewiebe

plugins/modules/dcnm_vrf.py

@@ -584,7 +584,8 @@
 from ansible_collections.cisco.dcnm.plugins.module_utils.network.dcnm.dcnm import (
     dcnm_get_ip_addr_info, dcnm_get_url, dcnm_send, dcnm_version_supported,
     get_fabric_details, get_fabric_inventory_details, get_ip_sn_dict,
-    get_sn_fabric_dict, validate_list_of_dicts, search_nested_json)
+    get_sn_fabric_dict, validate_list_of_dicts, search_nested_json,
+    find_dict_in_list_by_key_value)
 
 from ..module_utils.common.log_v2 import Log
 
@@ -1675,10 +1676,10 @@ def get_have(self):
             attach_list = vrf_attach["lanAttachList"]
             deploy_vrf = ""
             for attach in attach_list:
-                attach_state = not attach["lanAttachState"] == "NA"
-                deploy = attach["isLanAttached"]
+                attach_state = bool(attach.get("isLanAttached", False))
+                deploy = attach_state
                 deployed = False
-                if deploy and (
+                if attach_state and (
                     attach["lanAttachState"] == "OUT-OF-SYNC"
                     or attach["lanAttachState"] == "PENDING"
                 ):
@@ -2083,11 +2084,19 @@ def get_diff_replace(self):
             self.diff_deploy = diff_deploy
             return
 
-        if not self.diff_deploy:
-            diff_deploy.update({"vrfNames": ",".join(all_vrfs)})
-        else:
-            vrfs = self.diff_deploy["vrfNames"] + "," + ",".join(all_vrfs)
-            diff_deploy.update({"vrfNames": vrfs})
+        modified_all_vrfs = copy.deepcopy(all_vrfs)
+        for vrf in all_vrfs:
+            # If the playbook sets the deploy key to False, then we need to remove the vrf from the deploy list.
+            want_vrf_data = find_dict_in_list_by_key_value(search=self.config, key="vrf_name", value=vrf)
+            if want_vrf_data.get('deploy', True) is False:
+                modified_all_vrfs.remove(vrf)
+
+        if modified_all_vrfs:
+            if not diff_deploy:
+                diff_deploy.update({"vrfNames": ",".join(modified_all_vrfs)})
+            else:
+                vrfs = self.diff_deploy["vrfNames"] + "," + ",".join(modified_all_vrfs)
+                diff_deploy.update({"vrfNames": vrfs})
 
         self.diff_attach = copy.deepcopy(diff_attach)
         self.diff_deploy = copy.deepcopy(diff_deploy)
@@ -2388,8 +2397,19 @@ def diff_merge_attach(self, replace=False):
             if deploy_vrf:
                 all_vrfs.append(deploy_vrf)
 
-        if len(all_vrfs) != 0:
-            diff_deploy.update({"vrfNames": ",".join(all_vrfs)})
+        modified_all_vrfs = copy.deepcopy(all_vrfs)
+        for vrf in all_vrfs:
+            # If the playbook sets the deploy key to False, then we need to remove the vrf from the deploy list.
+            want_vrf_data = find_dict_in_list_by_key_value(search=self.config, key="vrf_name", value=vrf)
+            if want_vrf_data.get("deploy", True) is False:
+                modified_all_vrfs.remove(vrf)
+
+        if modified_all_vrfs:
+            if not diff_deploy:
+                diff_deploy.update({"vrfNames": ",".join(modified_all_vrfs)})
+            else:
+                vrfs = self.diff_deploy["vrfNames"] + "," + ",".join(modified_all_vrfs)
+                diff_deploy.update({"vrfNames": vrfs})
 
         self.diff_attach = diff_attach
         self.diff_deploy = diff_deploy