Rework MultiSite DiffRun (#519)

* fix and rework msd diffrun

* Fix remove with diff_run enabled and disabled

* Fix ansible sanity issue

* Fix typos

* Add display message for msd vrf and network removal

* adjust booleans

* adjust c date to single year

---------

Co-authored-by: mwiebe <mwiebe@cisco.com>

Author: mtarking

plugins/action/common/read_run_map.py

@@ -40,6 +40,7 @@ def run(self, tmp=None, task_vars=None):
         results['diff_run'] = True
 
         model_data = self._task.args.get('model_data')
+        play_tags = self._task.args.get('play_tags')
         fabric_name = model_data['vxlan']['fabric']['name']
 
         if 'dtc' in task_vars['role_path']:
@@ -60,9 +61,22 @@ def run(self, tmp=None, task_vars=None):
 
         # Check run map flags and if any of then is false set diff_run to false
         # to force all sections to run.
+        # Set diff_run to false for any of the following conditions:
+        #   - Any of the runmap flags is false
+        #   - play_tags (ansible_run_tags) is something other then 'all'
+        #
         for role in ['role_validate_completed', 'role_create_completed', 'role_deploy_completed', 'role_remove_completed']:
             if not previous_run_map.get(role):
                 results['diff_run'] = False
                 break
+        if play_tags and 'all' not in play_tags:
+            results['diff_run'] = False
+
+        # If diff_run is false display an ansible warning message
+        if not results['diff_run']:
+            display.warning(
+                f"Diff Run Feature is Disabled on this run for Fabric {fabric_name} "
+                f"as one or more run map flags are `false` or `ansible_run_tags` is not 'all'."
+            )
 
         return results

plugins/action/dtc/fabrics_deploy.py

@@ -103,8 +103,16 @@ def run(self, tmp=None, task_vars=None):
             #     "_ansible_parsed": true
             # }
             if ndfc_deploy.get('msg'):
-                if ndfc_deploy['msg']['RETURN_CODE'] != 200:
+                # Handle case where msg is a string (simple error message)
+                if isinstance(ndfc_deploy['msg'], str):
                     results['failed'] = True
-                    results['msg'] = f"For fabric {fabric}; {ndfc_deploy['msg']['DATA']['message']}"
+                    results['msg'] = f"For fabric {fabric}; {ndfc_deploy['msg']}"
+                # Handle case where msg is a dict with structured error info
+                elif isinstance(ndfc_deploy['msg'], dict):
+                    if ndfc_deploy['msg'].get('RETURN_CODE', 0) != 200:
+                        results['failed'] = True
+                        # Safely access nested message
+                        error_message = ndfc_deploy['msg'].get('DATA', {}).get('message', 'Unknown error')
+                        results['msg'] = f"For fabric {fabric}; {error_message}"
 
         return results

plugins/action/dtc/unmanaged_child_fabric_networks.py

@@ -157,6 +157,7 @@ def run(self, tmp=None, task_vars=None):
             # If the network is in NDFC but not in the data model, delete it
             diff_ndfc_network_names = [ndfc_network_name for ndfc_network_name in ndfc_network_names if ndfc_network_name not in network_names]
 
+        display.warning(f"Removing network_names: {diff_ndfc_network_names} from fabric: {fabric}")
         if diff_ndfc_network_names:
             config = []
             for ndfc_network_name in diff_ndfc_network_names:

plugins/action/dtc/unmanaged_child_fabric_vrfs.py

@@ -154,6 +154,7 @@ def run(self, tmp=None, task_vars=None):
             # If the vrf is in NDFC but not in the data model, delete it
             diff_ndfc_vrf_names = [ndfc_vrf_name for ndfc_vrf_name in ndfc_vrf_names if ndfc_vrf_name not in vrf_names]
 
+        display.warning(f"Removing vrf_names: {diff_ndfc_vrf_names} from fabric: {fabric}")
         if diff_ndfc_vrf_names:
             config = []
             for ndfc_vrf_name in diff_ndfc_vrf_names:

roles/dtc/common/tasks/sub_main_msd.yml

@@ -83,8 +83,13 @@
     vars_common_msd:
       changes_detected_fabric: "{{ changes_detected_fabric }}"
       changes_detected_bgw_anycast_vip: "{{ changes_detected_bgw_anycast_vip }}"
-      # changes_detected_vrfs: "{{ changes_detected_vrfs }}"
-      # changes_detected_networks: "{{ changes_detected_networks }}"
+      # changes_detected_vrfs and changes_detected_networks must be defaulted back to false
+      # because ansible.builtin.set_fact copmletely rewrites vars_common_msd and we need
+      # to keep alignment with the initialzed false state in common/main.yml.
+      # The proper state will update in create/sub_main_msd.yml as that is where vrfs and networks
+      # data is processed as we must process the vrfs and networks data only after multsite data is prepared.
+      changes_detected_vrfs: false
+      changes_detected_networks: false
       fabric_config: "{{ fabric_config }}"
       bgw_anycast_vip: "{{ bgw_anycast_vip }}"
       # vrf_config: "{{ vrf_config }}"
@@ -98,8 +103,10 @@
       - "----------------------------------------------------------------"
       - "+     Fabric Changes Detected -               [ {{ vars_common_msd.changes_detected_fabric }} ]"
       - "+     BGW Anycast VIP Changes Detected -      [ {{ vars_common_msd.changes_detected_bgw_anycast_vip }} ]"
-      # - "+     VRFs Changes Detected -                 [ {{ vars_common_msd.changes_detected_vrfs }} ]"
-      # - "+     Networks Changes Detected -             [ {{ vars_common_msd.changes_detected_networks }} ]"
+      - "+     VRFs Changes Detected -                 [ {{ vars_common_msd.changes_detected_vrfs }} ]"
+      - "+     VRFs Changes Detected -                 [ Known Later, Initialized to False for MSD ]"
+      - "+     Networks Changes Detected -             [ {{ vars_common_msd.changes_detected_networks }} ]"
+      - "+     Networks Changes Detected -             [ Known Later, Initialized to False for MSD ]"
       - "+     ----- Run Map -----"
       - "+     Run Map Diff Run -                      [ {{ run_map_read_result.diff_run }} ]"
       - "+     Force Run Flag  -                       [ {{ force_run_all }} ]"

roles/dtc/create/tasks/main.yml

@@ -52,11 +52,7 @@
 - name: Import MSD Fabric Role Tasks
   ansible.builtin.import_tasks: sub_main_msd.yml
   when: >
-    (MD_Extended.vxlan.fabric.type == 'MSD') and
-    (vars_common_msd.changes_detected_fabric) or
-    (vars_common_msd.changes_detected_bgw_anycast_vip) or
-    (vars_common_msd.changes_detected_vrfs) or
-    (vars_common_msd.changes_detected_networks)
+    (MD_Extended.vxlan.fabric.type == 'MSD')
 
 # Check with Matt and Pete on External Fabrics
 - name: Import External Fabric Role Tasks

roles/dtc/create/tasks/msd/vrfs_networks.yml

@@ -51,6 +51,11 @@
 #     name: dtc.common
 #     tasks_from: msd/ndfc_networks.yml
 
+- name: Set path_name Var
+  ansible.builtin.set_fact:
+    path_name: "{{ role_path }}/../common/files/msd/{{ MD_Extended.vxlan.fabric.name }}/"
+  delegate_to: localhost
+
 - name: Run dtc.common.tasks.msd.ndfc_vrfs.yml
   ansible.builtin.import_tasks: "{{ role_path }}/../common/tasks/msd/ndfc_vrfs.yml"
 
@@ -65,6 +70,8 @@
     vars_common_msd: "{{ vars_common_msd | ansible.builtin.combine(update_data) }}"
   vars:
     update_data:
+      # changes_detected_vrfs and changes_detected_networks are set in the
+      # dtc.common.tasks.msd.ndfc_vrfs.yml and dtc.common.tasks.msd.ndfc_networks.yml tasks
       changes_detected_vrfs: "{{ changes_detected_vrfs }}"
       changes_detected_networks: "{{ changes_detected_networks }}"
       vrf_config: "{{ vrf_config }}"

roles/dtc/create/tasks/sub_main_msd.yml

@@ -59,21 +59,21 @@
     state: merged
     fabric: "{{ MD_Extended.vxlan.fabric.name }}"
     config: "{{ vars_common_msd.bgw_anycast_vip }}"
-  when: >
-      (MD_Multisite.child_fabrics_data
-      | dict2items
-      | selectattr('value.attributes', 'defined')
-      | selectattr('value.attributes.STATIC_UNDERLAY_IP_ALLOC', 'defined')
-      | selectattr('value.attributes.STATIC_UNDERLAY_IP_ALLOC', 'in', ["true", true])
-      | map(attribute='key')
-      | list
-      | length > 0) and
-      (vars_common_msd.bgw_anycast_vip | length > 0)
+  when:
+    - (MD_Multisite.child_fabrics_data
+       | dict2items
+       | selectattr('value.attributes', 'defined')
+       | selectattr('value.attributes.STATIC_UNDERLAY_IP_ALLOC', 'defined')
+       | selectattr('value.attributes.STATIC_UNDERLAY_IP_ALLOC', 'in', ["true", true])
+       | map(attribute='key')
+       | list
+       | length > 0)
+    - vars_common_msd.bgw_anycast_vip | length > 0
+    - vars_common_msd.changes_detected_bgw_anycast_vip
 
 - name: Manage MSD Fabric VRFs and Networks in Nexus Dashboard
   ansible.builtin.import_tasks: msd/vrfs_networks.yml
   when:
     - MD_Extended.vxlan.multisite.overlay is defined
     - MD_Extended.vxlan.multisite.overlay
-    # - (vars_common_msd.changes_detected_vrfs or vars_common_msd.changes_detected_networks)
   tags: "{{ nac_tags.create_vrfs_networks }}"

roles/dtc/deploy/tasks/main.yml

@@ -52,7 +52,8 @@
     (MD_Extended.vxlan.fabric.type == 'MSD') and
     (vars_common_msd.changes_detected_fabric or
     vars_common_msd.changes_detected_vrfs or
-    vars_common_msd.changes_detected_networks)
+    vars_common_msd.changes_detected_networks or
+    vars_common_msd.changes_detected_bgw_anycast_vip)
 
 - name: Import ISN Fabric Role Tasks
   ansible.builtin.import_tasks: sub_main_isn.yml

roles/dtc/deploy/tasks/sub_main_msd.yml

@@ -69,6 +69,9 @@
 - name: Deploy For MSD Child Fabrics
   cisco.nac_dc_vxlan.dtc.fabrics_deploy:
     fabrics: "{{ child_fabrics_vrfs_networks_changed }}"
+  vars:
+    ansible_command_timeout: 3000
+    ansible_connect_timeout: 3000
   when: >
     MD_Extended.vxlan.fabric.type == 'MSD' and
     (child_fabrics_vrfs_networks_changed is defined and child_fabrics_vrfs_networks_changed | length > 0)