Merge pull request #436 from netascode/0.4.3

Release 0.4.3

Author: mtarking

CHANGELOG.rst

@@ -8,6 +8,41 @@ This project adheres to `Semantic Versioning <http://semver.org/>`_.
 
 .. contents:: ``Release Versions``
 
+`0.4.3`_
+=====================
+
+**Release Date:** ``2025-07-02``
+
+Added
+-----
+
+* Added support for manual underlay IP address allocation
+* Added support for manually allocating vPC domain IDs
+* Added support for breakout interfaces
+* Added support for dot1q interface type
+* Added support for orphan ports, duplex, and native VLAN for interface types access, access port-channel, trunk, and trunk port-channel
+
+Modified
+--------
+
+* Updated defaults to include ``domain_id`` and ``lb_id`` defaults for PTP
+* Removed the requirement to have ports defined for ``vxlan.overlay.networks.network_attach_groups`` in VXLAN fabrics
+* Updated POAP and pre-provision workflow
+    * This update allows devices to be discovered using discovery mode, poap and pre-provision workflows. Previously the solution did not allow both poap and pre-provision in the same datafile.
+    * Note: The poap.boostrap setting under the device is only used for POAP mode without pre-provision first. It is not used by a pre-provision or pre-provision + POAP workflow.
+
+Fixed
+-----
+* https://github.com/netascode/ansible-dc-vxlan/issues/32
+* https://github.com/netascode/ansible-dc-vxlan/issues/388
+* https://github.com/netascode/ansible-dc-vxlan/issues/391
+* https://github.com/netascode/ansible-dc-vxlan/issues/400
+* https://github.com/netascode/ansible-dc-vxlan/issues/405
+* https://github.com/netascode/ansible-dc-vxlan/issues/409
+* https://github.com/netascode/ansible-dc-vxlan/issues/411
+* https://github.com/netascode/ansible-dc-vxlan/issues/421
+* https://github.com/netascode/ansible-dc-vxlan/issues/424
+
 `0.4.2`_
 =====================
 
@@ -46,15 +81,15 @@ Modified
 
 Fixed
 -----
-https://github.com/netascode/ansible-dc-vxlan/issues/239
-https://github.com/netascode/ansible-dc-vxlan/issues/262
-https://github.com/netascode/ansible-dc-vxlan/issues/349
-https://github.com/netascode/ansible-dc-vxlan/issues/350
-https://github.com/netascode/ansible-dc-vxlan/issues/352
-https://github.com/netascode/ansible-dc-vxlan/issues/371
-https://github.com/netascode/ansible-dc-vxlan/issues/373
-https://github.com/netascode/ansible-dc-vxlan/issues/380
-https://github.com/netascode/ansible-dc-vxlan/issues/386
+* https://github.com/netascode/ansible-dc-vxlan/issues/239
+* https://github.com/netascode/ansible-dc-vxlan/issues/262
+* https://github.com/netascode/ansible-dc-vxlan/issues/349
+* https://github.com/netascode/ansible-dc-vxlan/issues/350
+* https://github.com/netascode/ansible-dc-vxlan/issues/352
+* https://github.com/netascode/ansible-dc-vxlan/issues/371
+* https://github.com/netascode/ansible-dc-vxlan/issues/373
+* https://github.com/netascode/ansible-dc-vxlan/issues/380
+* https://github.com/netascode/ansible-dc-vxlan/issues/386
 
 `0.4.1`_
 =====================
@@ -251,6 +286,7 @@ The following roles have been added to the collection:
 
 This version of the collection includes support for an IPv4 Underlay only.  Support for IPv6 Underlay will be available in the next release.
 
+.. _0.4.3: https://github.com/netascode/ansible-dc-vxlan/compare/0.4.2...0.4.3
 .. _0.4.2: https://github.com/netascode/ansible-dc-vxlan/compare/0.4.1...0.4.2
 .. _0.4.1: https://github.com/netascode/ansible-dc-vxlan/compare/0.4.0...0.4.1
 .. _0.4.0: https://github.com/netascode/ansible-dc-vxlan/compare/0.3.0...0.4.0

README.md

@@ -2,7 +2,7 @@
 
 ![Actions Status](https://github.com/netascode/ansible-dc-vxlan/actions/workflows/main.yml/badge.svg?branch=develop)
 
-NetAsCode DC VXLAN (nac_dc_vxlan) Ansible Collection for configuring Cisco VXLAN EVPN fabrics using the Cisco Nexus Dashboard Fabric Controller (NDFC). This collection simplifies the configuration of VXLAN fabrics by abstracting the automation using a data model that represents the desired state of the fabric. With this collection, an operator only needs to modify the configuration state in the data model instead of creating custom playbooks with modules and the associated parameters.
+NetAsCode DC VXLAN (nac_dc_vxlan) Ansible Collection for configuring Cisco VXLAN EVPN fabrics using the Cisco Nexus Dashboard Fabric Controller (NDFC). This collection simplifies the configuration of VXLAN fabrics by abstracting the automation using a [data model](https://netascode.cisco.com/docs/data_models/vxlan/overview/) that represents the desired state of the fabric. With this collection, an operator only needs to modify the configuration state in the data model instead of creating custom playbooks with modules and the associated parameters.
 
 This approach allows for consistent and repeatable configuration of VXLAN fabrics and aligns with Infrastructure as Code (IaC) methodology, where the configuration state of NDFC is saved in a version control system and managed as code.
 
@@ -86,9 +86,9 @@ The following control variables are available in this collection.
 | `interface_delete_mode` | Remove interface state as part of the remove role | `false` |
 | `inventory_delete_mode` | Remove inventory state as part of the remove role | `false` |
 | `link_vpc_delete_mode` | Remove vpc link state as part of the remove role | `false` |
-| `multisite_child_fabric_delete_mode` | Remove child fabric from MSD/MFD fabric as part of the remove role | `false` |
-| `multisite_network_delete_mode` | Remove network state as part of the remove role for multisite (MSD and MFD) fabrics | `false` |
-| `multisite_vrf_delete_mode` | Remove vrf state as part of the remove role for multisite (MSD and MFD) fabrics | `false` |
+| `multisite_child_fabric_delete_mode` | Remove child fabric from MSD fabric as part of the remove role | `false` |
+| `multisite_network_delete_mode` | Remove network state as part of the remove role for multisite (MSD) fabrics | `false` |
+| `multisite_vrf_delete_mode` | Remove vrf state as part of the remove role for multisite (MSD) fabrics | `false` |
 | `network_delete_mode` | Remove network state as part of the remove role | `false` |
 | `policy_delete_mode` | Remove policy state as part of the remove role | `false` |
 | `vrf_delete_mode` | Remove vrf state as part of the remove role | `false` |
@@ -416,7 +416,7 @@ A Multi-Site Domain (MSD) is a multifabric administrative domain that is created
 ### To configure and manage MSD fabrics with VXLAN as Code, you should use the following workflow:
 1. Create each member/child fabric that will be managed by MSD using the normal data models for each fabric (or use a combined data model with all child fabrics)
 2. Create the MSD fabric. In the data model set the fabric type to MSD and specify each child fabric that will be managed.
-   Reference the [VXLAN Data Model](https://netascode.cisco.com/data_model/vxlan/overview)
+   Reference the [VXLAN MultiSite Data Model](https://netascode.cisco.com/docs/data_models/vxlan/multisite/multisite/)
 > [!NOTE]
 > Any additional changes can be done using the MSD fabric data model or on an individual fabric basis using the respective playbooks.
 

docs/maintainers.md

@@ -14,15 +14,16 @@ When we are considering publishing a new release, all of the following steps mus
 1. Update [galaxy.yml](https://github.com/netascode/ansible-dc-vxlan/blob/develop/galaxy.yml) file
     * Update Version
         ```diff
-        -  "version": "1.0.0",
-        +  "version": "1.0.1",
+        -  "version": "0.4.0-dev",
+        +  "version": "0.4.1-dev",
         ```
     * Update authors as required
     * Update dependencies as required
 
 1. Update [changelog.](https://github.com/netascode/ansible-dc-vxlan/blob/develop/CHANGELOG.rst)
      * Make sure CHANGELOG.md accurately reflects all changes since the last release
-        * Apply a search filter: `is:issue closed:>=2025-03-01`
+        * Check all issues closed with search filter: `is:issue closed:>=2025-03-01`
+        * Check all PRs merged with search filter: `is:pr merged:>=2025-03-01`
      * Add any significant changes that weren't documented in the changelog
      * Clean up any entries that are overly verbose, unclear, or otherwise could be improved
      * Indicate new support (if any)
@@ -36,23 +37,30 @@ When we are considering publishing a new release, all of the following steps mus
 1. Scrub README docs
      * Update README docs for new support and where applicable
 
-1. Pull release branch based on the `develop` branch
+1. Create a release branch based on the `develop` branch
       * 0.0.x - a bugfix release
       * 0.x.0 - new feature(s)
       * x.0.0 - backward-incompatible change (if unvoidable!)
+  
+1. On the release branch, edit galaxy.yml and remove the "-dev" from the version
+      * version: 0.4.1    (instead of version: 0.4.1-dev)
 
 1. Open pull request from release branch against the `main` branch
      * Ensure all GitHub Actions tasks have passed
      * Merge `release branch` into `main` after approval as `merge commit`
 
 ### Post-Merge to `main` branch:
 
-1. Create annotated git tag for the release
+1. git clone the repo in a new directory and create annotated git tag for the release
      * [HowTo](https://git-scm.com/book/en/v2/Git-Basics-Tagging#Annotated-Tags)
+     * git clone ....
+     * git switch main
+     * git tag -a 0.4.1 -m "Release 0.4.1"
+     * git show 0.4.1
 
 1. Draft a [new release](https://github.com/netascode/ansible-dc-vxlan/releases) on GitHub
 
-1. Investigating. Merge `main` branch back into `develop` branch safely
+1. (Investigating. Merge `main` branch back into `develop` branch safely)
 
 ### Publish Release to Ansible Galaxy:
 

galaxy.yml

@@ -1,7 +1,7 @@
 ---
 namespace: cisco
 name: nac_dc_vxlan
-version: 0.4.2
+version: 0.4.3
 readme: README.md
 authors:
   - Devendra Gupta <devegupt>
@@ -27,5 +27,5 @@ tags: [cisco, ndfc, dcnm, nxos, networking, vxlan, evpn, nac, sac]
 
 dependencies:
   "ansible.netcommon": ">=4.1.0"
-  "cisco.dcnm": ">=3.8.0"
+  "cisco.dcnm": ">=3.8.1"
   "community.general": ">=8.5.0"

plugins/action/common/prepare_plugins/prep_105_topology_interfaces.py

@@ -29,7 +29,7 @@ def __init__(self, **kwargs):
         # interface modes which are a direct match
         self.mode_direct = ['routed', 'routed_po', 'routed_sub', 'loopback', 'fabric_loopback', 'mpls_loopback']
         # interface modes which need additional validation
-        self.mode_indirect = ['access', 'trunk', 'access_po', 'trunk_po', 'access_vpc', 'trunk_vpc', 'all']
+        self.mode_indirect = ['access', 'dot1q', 'trunk', 'access_po', 'trunk_po', 'access_vpc', 'trunk_vpc', 'all']
 
     def prepare(self):
         model_data = self.kwargs['results']['model_extended']
@@ -41,6 +41,10 @@ def prepare(self):
         model_data['vxlan']['topology']['interfaces'] = {}
         model_data['vxlan']['topology']['interfaces']['modes'] = {}
 
+        # Initialize breakout interfaces
+        model_data['vxlan']['topology']['interfaces']['modes']['breakout'] = {}
+        model_data['vxlan']['topology']['interfaces']['modes']['breakout']['count'] = 0
+
         # loop through interface modes and initialize with interface count 0
         for mode in self.mode_direct:
             model_data['vxlan']['topology']['interfaces']['modes'][mode] = {}
@@ -72,6 +76,9 @@ def prepare(self):
                     else:
                         model_data['vxlan']['topology']['interfaces']['modes']['access']['count'] += 1
                         model_data['vxlan']['topology']['interfaces']['modes']['all']['count'] += 1
+                if interface.get('mode') == 'dot1q':
+                    model_data['vxlan']['topology']['interfaces']['modes']['dot1q']['count'] += 1
+                    model_data['vxlan']['topology']['interfaces']['modes']['all']['count'] += 1
                 if interface.get('mode') == 'trunk':
                     # if interface name starts with 'po' and has vpc_id, then it is a vpc trunk interface
                     if interface.get('name').lower().startswith('po') and interface.get('vpc_id'):
@@ -86,5 +93,13 @@ def prepare(self):
                         model_data['vxlan']['topology']['interfaces']['modes']['trunk']['count'] += 1
                         model_data['vxlan']['topology']['interfaces']['modes']['all']['count'] += 1
 
+            if switch.get('interface_breakouts'):
+                for breakout in switch.get('interface_breakouts'):
+                    if breakout.get('to'):
+                        nb_int = breakout['to'] - breakout['from']
+                        model_data['vxlan']['topology']['interfaces']['modes']['breakout']['count'] += nb_int + 1
+                    else:
+                        model_data['vxlan']['topology']['interfaces']['modes']['breakout']['count'] += 1
+
         self.kwargs['results']['model_extended'] = model_data
         return self.kwargs['results']

plugins/action/dtc/get_poap_data.py

@@ -225,9 +225,11 @@ def run(self, tmp=None, task_vars=None):
         workflow = POAPDevice(params)
         workflow.refresh_discovered()
         workflow.check_poap_supported_switches()
-        workflow.check_preprovision_supported_switches()
+        #
+        # TBD: Don't think we need this
+        # workflow.check_preprovision_supported_switches()
 
-        if workflow.poap_supported_switches and not workflow.preprovision_supported_switches:
+        if workflow.poap_supported_switches:
             workflow.refresh()
 
             if workflow.refresh_succeeded:
@@ -240,6 +242,9 @@ def run(self, tmp=None, task_vars=None):
                 # role is executed later in this run.
                 fail_msg = workflow.refresh_message
                 match_text = r"Please\s+enable\s+the\s+DHCP\s+in\s+Fabric\s+Settings\s+to\s+start\s+the\s+bootstrap"
+                if re.search(match_text, fail_msg, re.IGNORECASE):
+                    pass
+                match_text = r"Invalid\s+Fabric"
                 if re.search(match_text, fail_msg, re.IGNORECASE):
                     pass
                 else:

plugins/action/dtc/prepare_msite_data.py

@@ -28,6 +28,7 @@
 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
+import re
 
 display = Display()
 
@@ -88,7 +89,9 @@ def run(self, tmp=None, task_vars=None):
             for switch in model_data['vxlan']['multisite']['overlay']['vrf_attach_groups_dict'][grp['name']]:
                 for child_fabric in child_fabrics_data.keys():
                     for sw in child_fabrics_data[child_fabric]['switches']:
-                        if switch['hostname'] == sw['hostname']:
+                        # Compare switches with regex to catch hostname when ip domain-name is configured
+                        regex_pattern = f"^{switch['hostname']}$|^{switch['hostname']}\\..*$"
+                        if re.search(regex_pattern, sw['hostname']):
                             switch['mgmt_ip_address'] = sw['mgmt_ip_address']
 
                 # Append switch to a flat list of switches for cross comparison later when we query the
@@ -116,7 +119,8 @@ def run(self, tmp=None, task_vars=None):
             for switch in model_data['vxlan']['multisite']['overlay']['network_attach_groups_dict'][grp['name']]:
                 for child_fabric in child_fabrics_data.keys():
                     for sw in child_fabrics_data[child_fabric]['switches']:
-                        if switch['hostname'] == sw['hostname']:
+                        regex_pattern = f"^{switch['hostname']}$|^{switch['hostname']}\\..*$"
+                        if re.search(regex_pattern, sw['hostname']):
                             switch['mgmt_ip_address'] = sw['mgmt_ip_address']
                 # Append switch to a flat list of switches for cross comparison later when we query the
                 # MSD fabric information.  We need to stop execution if the list returned by the MSD query

plugins/action/dtc/unmanaged_child_fabric_networks.py

@@ -150,12 +150,12 @@ def run(self, tmp=None, task_vars=None):
         #     },
         #     "_ansible_parsed": true
         # }
+        diff_ndfc_network_names = []
         if ndfc_networks.get('response'):
             ndfc_network_names = [ndfc_network['parent']['networkName'] for ndfc_network in ndfc_networks['response']]
-
-        # Take the difference between the networks in the data model and the networks in NDFC
-        # 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]
+            # Take the difference between the networks in the data model and the networks in NDFC
+            # 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]
 
         if diff_ndfc_network_names:
             config = []

plugins/action/dtc/unmanaged_child_fabric_vrfs.py

@@ -146,12 +146,13 @@ def run(self, tmp=None, task_vars=None):
         #   },
         #   "_ansible_parsed": true
         # }
+        diff_ndfc_vrf_names = []
         if ndfc_vrfs.get('response'):
             ndfc_vrf_names = [ndfc_vrf['parent']['vrfName'] for ndfc_vrf in ndfc_vrfs['response']]
 
-        # Take the difference between the vrfs in the data model and the vrfs in NDFC
-        # 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]
+            # Take the difference between the vrfs in the data model and the vrfs in NDFC
+            # 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]
 
         if diff_ndfc_vrf_names:
             config = []

plugins/plugin_utils/helper_functions.py

@@ -225,11 +225,12 @@ def ndfc_get_fabric_switches(self, task_vars, tmp, fabric):
 
     fabric_switches = []
     for fabric_switch in fabric_response['response']:
-        fabric_switches.append(
-            {
-                'hostname': fabric_switch['hostName'],
-                'mgmt_ip_address': fabric_switch['ipAddress']
-            }
-        )
+        if 'hostName' in fabric_switch:
+            fabric_switches.append(
+                {
+                    'hostname': fabric_switch['hostName'],
+                    'mgmt_ip_address': fabric_switch['ipAddress']
+                }
+            )
 
     return fabric_switches