Step 1 - Add Variable File overlay.yml under group_vars/all/

To manage the overlay pieces, you will create a file that contains the VRFs and Networks variable data. This data will be used to create the VRF and Network objects in NDFC but the actual configuration will not be deployed to the devices until the deploy role is executed.

Step 2 - Create Overlay Variables File for the Staging Fabric

This file contains the overlay specific variables for attaching VRF(s) to your border leaf switch in your staging fabric.

touch ~/workspace/ndfclab/ansible/group_vars/stage/overlay.yml
cat << EOF > ~/workspace/ndfclab/ansible/group_vars/stage/overlay.yml
---

vrf_attach_group:
  all_leaf:
    - ip_address: 10.15.5.12
    - ip_address: 10.15.5.13

net_attach_group:
  esxi:
    - ip_address: 10.15.5.12
      ports: [Ethernet1/1]
    - ip_address: 10.15.5.13
      ports: [Ethernet1/1]
EOF

Step 3 - Open The Main Task File for the Role

For the overlay role tasks, ensure you are in your VSCode Terminal and open the main.yml file found in roles/manage_overlay/tasks/ using the VSCode code keyword as before.

code-server -r ~/workspace/ndfclab/ansible/roles/manage_overlay/tasks/main.yml

Step 4 - Create Tasks To Add Overlay VRFs and Networks

Copy the below tasks into the roles/manage_overlay/tasks/main.yml file that uses Ansible's block keyword. The block keyword is used to group tasks together. The first tasks use Ansible's built-in ansible.builtin.template module to generate the payload to a file that would be found in the files directory of the role. Then the ansible.builtin.set_fact task is used to set a variable called vrf_config from the created file that will be used in the cisco.dcnm.dcnm_vrf module to create the VRF objects in NDFC. The same style of tasks is used to create the network configuration where the cisco.dcnm.dcnm_network module is used to create the network objects in NDFC.

Also note, the tags parameter is used to tag the tasks so that you can run only the tasks you want to run such as only VRFs or only Networks.

- name: Role Entry Point - [manage_overlay]
  ansible.builtin.debug:
    msg:
      - "----------------------------------------------------------------"
      - "+             Calling Role - [manage_overlay]                  +"
      - "----------------------------------------------------------------"
  tags:
    - mo_vrfs_nets
    - mo_vrfs
    - mo_networks
    - mo_all

# -------------------
# CREATE VRF SECTION
# -------------------

- name: Generate and Manage NDFC Fabric VRFs
  tags:
    - mo_vrfs_nets
    - mo_vrfs
    - mo_all
  block:
    # --------------------------------------------------------------------
    # Generate VRF Configuration for NDFC
    # --------------------------------------------------------------------
    - name: Create file to hold rendered VRF information
      ansible.builtin.template:
        src: attach_vrfs.j2
        dest: "{{ role_path }}/files/attach_vrfs.yml"
        mode: preserve

    - name: Create and store generated VRF configuration
      ansible.builtin.set_fact:
        vrf_config: "{{ lookup('file', 'attach_vrfs.yml') | from_yaml }}"

    # --------------------------------------------------------------------
    # Manage VRF Configuration on NDFC
    # --------------------------------------------------------------------
    - name: Manage NDFC Fabric VRFs
      cisco.dcnm.dcnm_vrf:
        fabric: "{{ fabric_settings.FABRIC_NAME }}"
        config: "{{ vrf_config }}"
        state: replaced

# -----------------------
# CREATE NETWORK SECTION
# -----------------------

- name: Generate and Manage NDFC Fabric Networks
  tags:
    - mo_vrfs_nets
    - mo_vrfs
    - mo_all
  block:
    # --------------------------------------------------------------------
    # Generate Network Configuration for NDFC
    # --------------------------------------------------------------------
    - name: Create file to hold rendered Network information
      ansible.builtin.template:
        src: attach_networks.j2
        dest: "{{ role_path }}/files/attach_nets.yml"
        mode: preserve

    - name: Create and store generated Network configuration
      ansible.builtin.set_fact:
        net_config: "{{ lookup('file', 'attach_nets.yml') | from_yaml }}"

    # --------------------------------------------------------------------
    # Manage Network Configuration on NDFC
    # --------------------------------------------------------------------
    - name: Manage NDFC Fabric Networks
      cisco.dcnm.dcnm_network:
        fabric: "{{ fabric_settings.FABRIC_NAME }}"
        config: "{{ net_config }}"
        state: replaced

Step 5 - Create templates and files directories under the manage_overlay role

mkdir -p ~/workspace/ndfclab/ansible/roles/manage_overlay/templates
mkdir -p ~/workspace/ndfclab/ansible/roles/manage_overlay/files

• roles/manage_overlay/templates - This directory will store the Jinja2 templates
• roles/manage_overlay/files - This directory will store the rendered configuration files

The diagram below demonstrates how the main playbook tasks will call the Jinja2 templates to render the configuration files that will be used to deploy the VRFs and Networks to the fabric.

1. The task on line 6 uses the ansible.builtin.template module
2. This module calls the roles/manage_overlay/templates/attach_vrfs.j2 Jinja2 template
3. This Jinja2 template renders the configuration to a file called roles/manage_overlay/files/attach_vrfs.yml using the VRF variable data defined in group_vars/all/overlay.yml
4. The task on line 11 saves the rendered configuration to a variable called vrf_config which is then passed to the cisco.dcnm.dcnm_vrf module to create the VRF objects in NDFC

---

---

Step 6 - Create Jinja2 Templates for VRFs and Networks

This step will create the Jinja2 templates that will be used to render the VRF and Network configuration files.

touch ~/workspace/ndfclab/ansible/roles/manage_overlay/templates/attach_vrfs.j2
cat << EOF > ~/workspace/ndfclab/ansible/roles/manage_overlay/templates/attach_vrfs.j2
---
# This file is auto-generated
# DO NOT EDIT MANUALLY
#
{% for vrf in vrfs %}
- vrf_name: {{ vrf['vrf_name'] }}
{# ------------------------------------------------------ #}
{# Properties Section #}
{# ------------------------------------------------------ #}
  vrf_id: {{ vrf['vrf_id']  }}
  vlan_id: {{ vrf['vlan_id'] }}
{# ------------------------------------------------------ #}
{# Attach Group Section #}
{# ------------------------------------------------------ #}
  attach:
{% for switch in vrf_attach_group.all_leaf %}
    - ip_address: {{ switch['ip_address'] }}
{% endfor %}
  deploy: false
{% endfor %}
EOF

touch ~/workspace/ndfclab/ansible/roles/manage_overlay/templates/attach_networks.j2
cat << EOF > ~/workspace/ndfclab/ansible/roles/manage_overlay/templates/attach_networks.j2
---
# This file is auto-generated
# DO NOT EDIT MANUALLY
#
{% for net in networks %}
- net_name: {{ net['net_name'] }}
{# ------------------------------------------------------ #}
{# Properties Section #}
{# ------------------------------------------------------ #}
  vrf_name: {{ net['vrf_name'] }}
  net_id: {{ net['net_id'] }}
  vlan_id: {{ net['vlan_id'] }}
  vlan_name: {{ net['vlan_name'] }}
  gw_ip_subnet: {{ net['gw_ip_subnet'] }}
{# ------------------------------------------------------ #}
{# Attach Group Section #}
{# ------------------------------------------------------ #}
  attach:
{% for switch in net_attach_group.esxi %}
    - ip_address: {{ switch['ip_address'] }}
      ports: {{ switch['ports'] }}
{% endfor %}
  deploy: false
{% endfor %}
EOF

Step 7 - Open the Top Level fabric.yml Ansible Playbook

Navigate back to your fabric.yml file by using the VSCode code command:

code-server -r ~/workspace/ndfclab/ansible/fabric.yml

Step 8 - Add a line to call the manage_overlay role under the roles: section of the playbook

Your fabric.yml file should already be populated from the previous section. With the file open, you only need to add the highlighted line, which should be line number 12 in your file. You can do this by highlighting the text in the lab guide and copying then pasting in your file or typing the line in your file. After one of those actions, press the return key such that there is a new line after where you entered - manage_overlay.

---
# This is the top level build playbook that runs the various
# Ansible roles that will be used to build out the fabric

- name: Build VXLAN EVPN Fabric on NDFC
  hosts: ndfc
  gather_facts: false

  roles:
    - create_fabric
    - add_inventory
    - manage_overlay # Add this line under the add_inventory role from the previous section

Step 9 - Execute Ansible Playbook

Make sure you are in the root Ansible directory

cd ~/workspace/ndfclab/ansible

From the root ansible project directory execute the following command.

ansible-playbook -i hosts.stage.yml fabric.yml --tags mo_vrfs_nets

Upon a successful run of the playbook your output should look as follows:

  PLAY [Build VXLAN EVPN Fabric on NDFC] **********************************************************************************************************************************

  TASK [manage_overlay : Role Entry Point - [manage_overlay]] *************************************************************************************************************
  ok: [10.15.0.23] => {
      "msg": [
          "----------------------------------------------------------------",
          "+             Calling Role - [manage_overlay]                     +",
          "----------------------------------------------------------------"
      ]
  }

  TASK [manage_overlay : Create file to hold rendered VRF information] ****************************************************************************************************
  changed: [10.15.0.23]

  TASK [manage_overlay : Create and store generated VRF configuration] ****************************************************************************************************
  ok: [10.15.0.23]

  TASK [manage_overlay : Manage NDFC Fabric VRFs] *************************************************************************************************************************
  changed: [10.15.0.23]

  TASK [manage_overlay : Create file to hold rendered Network information] ************************************************************************************************
  changed: [10.15.0.23]

  TASK [manage_overlay : Create and store generated Network configuration] ************************************************************************************************
  ok: [10.15.0.23]

  TASK [manage_overlay : Manage NDFC Fabric Networks] *********************************************************************************************************************
  changed: [10.15.0.23]

  PLAY RECAP **************************************************************************************************************************************************************
  10.15.0.23                 : ok=7    changed=4    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0 

Step 10 - Return to NDFC & Verify Network and VRF Information

Return to your NDFC browser where you should be sitting on the Interfaces tab

1. Click the VRFs tab in the top navigation bar



Verify you see the VRF AnsibleVRF that was created by your Ansible playbook.

Like previous sections, when reviewing the VRFs tab, it is expected to see VRFs in the Pending status since a deployment has not taken place yet. Again, you will deploy to your switches in the deploy role. Following the remaining steps to verify the interface configuration is pre-staged in NDFC.

2. Double-click AnsibleVRF to review the VRF details




3. Click VRF Attachments
4. Confirm AnsibleVRF is pending deployment and attachment to your switches




5. Click Networks
6. Confirm AnsibleNet1 and AnsibleNet2 is associated to AnsibleVRF and pending deployment to your switches
7. Click the close button




8. Click the Networks tab in the top navigation bar



Verify you see the Networks AnsibleNet1 and AnsibleNet2 that was created by your Ansible playbook.

Like previous sections, when reviewing the Networks tab, it is expected to see VRFs in the Pending status since a deployment has not taken place yet. Again, you will deploy to your switches in the deploy role. Following the remaining steps to verify the interface configuration is pre-staged in NDFC.

9. Double-click AnsibleNet1 to review the Network details




10. Click Network Attachments
11. Confirm AnsibleNet1 is pending deployment and attachment to your switches




12. Click VRF
13. Confirm AnsibleVRF is associated to AnsibleNet1 and pending deployment to your switches
14. Click the close button

Step 11 - Return to VSCode & Close All Open Tabs

On the keyword press Ctrl + K + W. This should close all open tabs to clear your workspace for the next section.

Continue to the next section to populate the deploy role with the necessary tasks to deploy all of your configuration to your staging fabric.