Lesson 1 of 7

Ansible Fundamentals for Networking

Objective

Learn the fundamentals of Ansible for network automation with a focus on architecture, inventory layout, modules (with FQCN usage), playbooks, roles, and variables. We will assemble a minimal control-node configuration and an Ansible role scaffold that can push VLAN-to-VNI configuration to a Nexus/NX-OS style fabric. This matters in production because consistent, repeatable device configuration at scale eliminates human error and accelerates change windows—common in data center VXLAN EVPN deployments where many leaf/spine devices require identical underlay/overlay configuration.

Real-world scenario: a data center operator at NHPREP must deploy VLAN-to-VNI mappings across three leaf switches and two spines. Using Ansible and the cisco.nxos collection, you can centralize that work in an idempotent playbook and role, preventing drift and simplifying audits.


Topology & Device Table

ASCII topology (management-plane connectivity for automation). Each device is reachable by its management IP shown on the mgmt0 interface.

                    +----------------------+             +----------------------+
                    |        Spine 1       |             |        Spine 2       |
                    |        S1            |             |        S2            |
                    |  mgmt0: 10.15.1.11   |             |  mgmt0: 10.15.1.12   |
                    +----------+-----------+             +-----------+----------+
                               |                                   |
                               |                                   |
                      +--------+-----------------------------------+--------+
                      |                Management Network (OOB)              |
                      |                     10.15.1.0/24                      |
                      +--------+----------------+---------------+--------+-----+
                               |                |               |        |
                      +--------+---+    +-------+-----+   +-----+-------+ +--+--------+
                      |   Leaf 1   |    |   Leaf 2    |   |   Leaf 3   | | Ansible   |
                      |    L1      |    |    L2       |   |    L3      | | Control   |
                      | mgmt0:     |    | mgmt0:      |   | mgmt0:     | | Node      |
                      | 10.15.1.13 |    | 10.15.1.14  |   | 10.15.1.15 | | lab.nhprep.com |
                      +------------+    +-------------+   +------------+ +-------------+

Device Table

DeviceInterfaceIP AddressSubnet MaskRole
S1mgmt010.15.1.11255.255.255.0Spine
S2mgmt010.15.1.12255.255.255.0Spine
L1mgmt010.15.1.13255.255.255.0Leaf
L2mgmt010.15.1.14255.255.255.0Leaf
L3mgmt010.15.1.15255.255.255.0Leaf
Ansibleeth0(control node)network-managedControl Node (lab.nhprep.com)

Tip: In production, the control node (lab.nhprep.com) typically lives in a secured management network and authenticates to devices via SSH with least-privilege accounts.


Key Concepts

  • Ansible Control Node vs Managed Nodes
    The control node (lab.nhprep.com) runs playbooks and modules. Managed network devices (10.15.1.11–15) are contacted over SSH (network_cli) or HTTP/HTTPS (httpapi). For NX-OS automation, network_cli is commonly used and requires persistent SSH connections for efficiency.

  • Inventory and Groups
    Inventory defines hosts and groups (spines, leafs). Grouping lets you target only the appropriate devices (e.g., run overlay role only against leafs). Ansible variables can be applied globally (all:vars), per group (group_vars), or per host (host_vars).

  • Collections and FQCN (Fully Qualified Collection Name)
    Modules are delivered in collections (e.g., cisco.nxos). Always invoke modules with their FQCN (cisco.nxos.nxos_vlans) to avoid ambiguity and to ensure the correct vendor implementation is used.

  • Idempotency and Desired State
    Modules accept parameters describing the desired configuration (e.g., list of VLANs with mapped VNI). Ansible computes changes and applies only the differences—this prevents duplicate or destructive changes.

  • Roles, Tasks, and File Layout
    Roles encapsulate configuration intent (common, underlay, overlay). Use ansible-galaxy to create role scaffolding and place tasks/templates/vars accordingly. This modularity supports reuse and testing in CI/CD pipelines.


Step-by-step configuration

Step 1: Install Ansible on the Control Node

What we are doing: Install Ansible core (control plane software) on the control host so it can execute playbooks and use collections. This is the foundation for all subsequent automation.

% pip install ansible-core
% pip install ansible

What just happened:

  • The first command installs Ansible core runtime (required for playbook execution).
  • The second command installs the higher-level Ansible package including plugins and CLI utilities. Together they enable running playbooks and interacting with network devices over network_cli/httpapi.

Real-world note: Use virtual environments on production control nodes and pin versions to avoid unexpected behavior during automated runs.

Verify:

% ansible --version
ansible [core 2.14.0]
  configured module search path = ['/home/user/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/local/lib/python3.8/site-packages/ansible
  ansible collection location = /home/user/.ansible/collections:/usr/share/ansible/collections
  executable location = /usr/local/bin/ansible
  python version = 3.8.10 (default, Jun  4 2024, 12:00:00) [GCC 9.3.0]


<div class="topology-diagram">
<img src="data:image/svg+xml;base64,<?plantuml 1.2026.1?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentStyleType="text/css" data-diagram-type="NWDIAG" height="216px" preserveAspectRatio="none" style="width:833px;height:216px;background:#FFFFFF;" version="1.1" viewBox="0 0 833 216" width="833px" zoomAndPan="magnify"><defs/><g><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="82.5527" x="28.666" y="16.1387">Control_Plane</text><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="76.5645" x="34.6543" y="30.1074">10.15.1.0/24</text><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="96.8496" x="14.3691" y="158.5215">Underlay_Fabric</text><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="106.2188" x="5" y="172.4902">L2/L3_fabric_links</text><rect fill="#E2E2F0" height="5" style="stroke:#181818;stroke-width:1;" width="709.1294" x="116.2188" y="16.4688"/><rect fill="#E2E2F0" height="5" style="stroke:#181818;stroke-width:1;" width="565.7544" x="259.5938" y="158.8516"/><path d="M189.9063,21.4688 L189.9063,70.6758" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="66.478" x="143.3308" y="40.978">10.15.1.100</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="93.1509" x="143.3308" y="53.7827">SSH(network_cli)</text><path d="M318.1692,21.4688 L318.1692,70.6758" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="271.5938" y="40.978">10.15.1.11</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="93.1509" x="271.5938" y="53.7827">SSH(network_cli)</text><path d="M318.1692,104.6445 L318.1692,158.8516" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="288.4294" y="135.5562">10.15.1.11</text><path d="M431.3201,21.4688 L431.3201,70.6758" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="384.7446" y="40.978">10.15.1.12</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="93.1509" x="384.7446" y="53.7827">SSH(network_cli)</text><path d="M431.3201,104.6445 L431.3201,158.8516" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="401.5803" y="135.5562">10.15.1.12</text><path d="M544.4709,21.4688 L544.4709,70.6758" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="497.8955" y="40.978">10.15.1.13</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="93.1509" x="497.8955" y="53.7827">SSH(network_cli)</text><path d="M544.4709,104.6445 L544.4709,158.8516" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="514.7312" y="135.5562">10.15.1.13</text><path d="M657.6218,21.4688 L657.6218,70.6758" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="611.0464" y="40.978">10.15.1.14</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="93.1509" x="611.0464" y="53.7827">SSH(network_cli)</text><path d="M657.6218,104.6445 L657.6218,158.8516" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="627.8821" y="135.5562">10.15.1.14</text><path d="M770.7727,21.4688 L770.7727,70.6758" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="724.1973" y="40.978">10.15.1.15</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="93.1509" x="724.1973" y="53.7827">SSH(network_cli)</text><path d="M770.7727,104.6445 L770.7727,158.8516" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="741.033" y="135.5562">10.15.1.15</text><rect fill="#F1F1F1" height="33.9688" style="stroke:#181818;stroke-width:0.5;" width="113.375" x="131.2188" y="70.6758"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="93.375" x="141.2188" y="91.8145">Ansible_Control</text><rect fill="#F1F1F1" height="33.9688" style="stroke:#181818;stroke-width:0.5;" width="67.1914" x="282.5735" y="70.6758"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="47.1914" x="292.5735" y="91.8145">Spine_1</text><rect fill="#F1F1F1" height="33.9688" style="stroke:#181818;stroke-width:0.5;" width="67.1914" x="395.7244" y="70.6758"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="47.1914" x="405.7244" y="91.8145">Spine_2</text><rect fill="#F1F1F1" height="33.9688" style="stroke:#181818;stroke-width:0.5;" width="59.2813" x="512.8303" y="70.6758"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="39.2813" x="522.8303" y="91.8145">Leaf_1</text><rect fill="#F1F1F1" height="33.9688" style="stroke:#181818;stroke-width:0.5;" width="59.2813" x="625.9812" y="70.6758"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="39.2813" x="635.9812" y="91.8145">Leaf_2</text><rect fill="#F1F1F1" height="33.9688" style="stroke:#181818;stroke-width:0.5;" width="59.2813" x="739.1321" y="70.6758"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="39.2813" x="749.1321" y="91.8145">Leaf_3</text><?plantuml-src ZP4z2y8m48PtVyMHIPSswSSa3YA8GmUXEAc4j4abD5mbBHIH_dSXL11iQURtddkvvx2NMZpWlG90rVMDhU7GO6SRmyz6e789W93IghQ57H160vO6BA1Xb10Nxh7LXL5y1E4wCSqelM6UdzPZ2o-Dtf3xrYt8dneLPzCWM-AYQIwQvp8bghcwU06RQKiMi7WQI-UmOVNpaGjAPOruyQCeh2x_Vv95OHRpogNSQAnRuY7MJwEND2z5NaA-vmyV?></g></svg>" alt="Network Topology Diagram" style="max-width:100%;height:auto;background:#fff;padding:16px;border:1px solid #e5e7eb;border-radius:8px;" />
</div>

cisco
% ansible-galaxy collection install cisco.nxos cisco.dcnm
% ansible-galaxy init overlay

What just happened:

  • The first command downloads the cisco.nxos and cisco.dcnm collections into your local Ansible collection path, making FQCN modules available.
  • The second command creates the directory structure for a role named "overlay" (tasks, templates, vars, etc), which organizes overlay-related tasks (VLANs, SVIs, NVE).

Real-world note: Collections are versioned independently from Ansible core—pin collection versions in production to ensure consistent behavior.

Verify:

% tree overlay
overlay
├── README.md
├── tasks
│   └── main.yml
├── templates
└── vars
    └── main.yml

Step 3: Create the main inventory file

What we are doing: Build the Ansible inventory that defines connection parameters and host groups (spines and leafs). This file tells Ansible where devices are and how to connect (network_cli).

# save as inventory.yml
all:
  vars:
    ansible_connection: ansible.netcommon.network_cli
    ansible_user: "nxos_username"
    ansible_password: "nxos_password"
    ansible_network_os: cisco.nxos.nxos
  children:
    spines:
      hosts:
        10.15.1.11:
        10.15.1.12:
    leafs:
      hosts:
        10.15.1.13:
        10.15.1.14:
        10.15.1.15:

What just happened:

  • The file declares global variables that apply to all hosts: connection type (network_cli), credentials (username/password), and the network OS collection name (cisco.nxos.nxos).
  • Hosts are grouped into spines and leafs so playbooks can target them selectively. The control node will use SSH to connect to the mgmt0 addresses listed.

Real-world note: Never keep plaintext passwords in production; use Vault or an authentication broker. This example uses straightforward variables for lab clarity.

Verify:

% ansible-inventory -i inventory.yml --list
{
    "_meta": {
        "hostvars": {
            "10.15.1.11": {
                "ansible_connection": "ansible.netcommon.network_cli",
                "ansible_user": "nxos_username",
                "ansible_password": "nxos_password",
                "ansible_network_os": "cisco.nxos.nxos"
            },
            "10.15.1.12": { ... },
            "10.15.1.13": { ... },
            "10.15.1.14": { ... },
            "10.15.1.15": { ... }
        }
    },
    "all": {
        "children": [
            "spines",
            "leafs"
        ]
    },
    "spines": {
        "hosts": [
            "10.15.1.11",
            "10.15.1.12"
        ]
    },
    "leafs": {
        "hosts": [
            "10.15.1.13",
            "10.15.1.14",
            "10.15.1.15"
        ]
    }
}


<div class="topology-diagram">
<img src="data:image/svg+xml;base64,<?plantuml 1.2026.1?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentStyleType="text/css" data-diagram-type="NWDIAG" height="216px" preserveAspectRatio="none" style="width:833px;height:216px;background:#FFFFFF;" version="1.1" viewBox="0 0 833 216" width="833px" zoomAndPan="magnify"><defs/><g><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="82.5527" x="28.666" y="16.1387">Control_Plane</text><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="76.5645" x="34.6543" y="30.1074">10.15.1.0/24</text><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="96.8496" x="14.3691" y="158.5215">Underlay_Fabric</text><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="106.2188" x="5" y="172.4902">L2/L3_fabric_links</text><rect fill="#E2E2F0" height="5" style="stroke:#181818;stroke-width:1;" width="709.1294" x="116.2188" y="16.4688"/><rect fill="#E2E2F0" height="5" style="stroke:#181818;stroke-width:1;" width="565.7544" x="259.5938" y="158.8516"/><path d="M189.9063,21.4688 L189.9063,70.6758" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="66.478" x="143.3308" y="40.978">10.15.1.100</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="93.1509" x="143.3308" y="53.7827">SSH(network_cli)</text><path d="M318.1692,21.4688 L318.1692,70.6758" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="271.5938" y="40.978">10.15.1.11</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="93.1509" x="271.5938" y="53.7827">SSH(network_cli)</text><path d="M318.1692,104.6445 L318.1692,158.8516" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="288.4294" y="135.5562">10.15.1.11</text><path d="M431.3201,21.4688 L431.3201,70.6758" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="384.7446" y="40.978">10.15.1.12</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="93.1509" x="384.7446" y="53.7827">SSH(network_cli)</text><path d="M431.3201,104.6445 L431.3201,158.8516" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="401.5803" y="135.5562">10.15.1.12</text><path d="M544.4709,21.4688 L544.4709,70.6758" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="497.8955" y="40.978">10.15.1.13</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="93.1509" x="497.8955" y="53.7827">SSH(network_cli)</text><path d="M544.4709,104.6445 L544.4709,158.8516" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="514.7312" y="135.5562">10.15.1.13</text><path d="M657.6218,21.4688 L657.6218,70.6758" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="611.0464" y="40.978">10.15.1.14</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="93.1509" x="611.0464" y="53.7827">SSH(network_cli)</text><path d="M657.6218,104.6445 L657.6218,158.8516" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="627.8821" y="135.5562">10.15.1.14</text><path d="M770.7727,21.4688 L770.7727,70.6758" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="724.1973" y="40.978">10.15.1.15</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="93.1509" x="724.1973" y="53.7827">SSH(network_cli)</text><path d="M770.7727,104.6445 L770.7727,158.8516" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="741.033" y="135.5562">10.15.1.15</text><rect fill="#F1F1F1" height="33.9688" style="stroke:#181818;stroke-width:0.5;" width="113.375" x="131.2188" y="70.6758"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="93.375" x="141.2188" y="91.8145">Ansible_Control</text><rect fill="#F1F1F1" height="33.9688" style="stroke:#181818;stroke-width:0.5;" width="67.1914" x="282.5735" y="70.6758"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="47.1914" x="292.5735" y="91.8145">Spine_1</text><rect fill="#F1F1F1" height="33.9688" style="stroke:#181818;stroke-width:0.5;" width="67.1914" x="395.7244" y="70.6758"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="47.1914" x="405.7244" y="91.8145">Spine_2</text><rect fill="#F1F1F1" height="33.9688" style="stroke:#181818;stroke-width:0.5;" width="59.2813" x="512.8303" y="70.6758"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="39.2813" x="522.8303" y="91.8145">Leaf_1</text><rect fill="#F1F1F1" height="33.9688" style="stroke:#181818;stroke-width:0.5;" width="59.2813" x="625.9812" y="70.6758"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="39.2813" x="635.9812" y="91.8145">Leaf_2</text><rect fill="#F1F1F1" height="33.9688" style="stroke:#181818;stroke-width:0.5;" width="59.2813" x="739.1321" y="70.6758"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="39.2813" x="749.1321" y="91.8145">Leaf_3</text><?plantuml-src ZP4z2y8m48PtVyMHIPSswSSa3YA8GmUXEAc4j4abD5mbBHIH_dSXL11iQURtddkvvx2NMZpWlG90rVMDhU7GO6SRmyz6e789W93IghQ57H160vO6BA1Xb10Nxh7LXL5y1E4wCSqelM6UdzPZ2o-Dtf3xrYt8dneLPzCWM-AYQIwQvp8bghcwU06RQKiMi7WQI-UmOVNpaGjAPOruyQCeh2x_Vv95OHRpogNSQAnRuY7MJwEND2z5NaA-vmyV?></g></svg>" alt="Network Topology Diagram" style="max-width:100%;height:auto;background:#fff;padding:16px;border:1px solid #e5e7eb;border-radius:8px;" />
</div>

cisco
# save as roles/overlay/tasks/main.yml
- name: Configure VLAN-to-VNI Mappings
  cisco.nxos.nxos_vlans:
    config:
      - name: Web Servers
        vlan_id: 101
        mapped_vni: 10101
      - name: DB Servers
        vlan_id: 102
        mapped_vni: 10102
      - name: vMotion
        vlan_id: 103
        mapped_vni: 10103
    state: merged

What just happened:

  • The task calls the NX-OS VLAN module with a config list containing dictionaries for each VLAN.
  • state: merged signals Ansible to merge these VLAN entries into the device configuration (adding/updating without removing unspecified VLANs). The module will compare current device state and apply only necessary changes.

Real-world note: Using a list of dictionaries allows you to define many VLANs cleanly; put these variables into group_vars or host_vars for larger deployments.

Verify:

# run a check-mode dry run (preview changes)
% ansible-playbook -i inventory.yml -l leafs --check -vv overlay_playbook.yml

PLAY [leafs] *******************************************************************
TASK [Configure VLAN-to-VNI Mappings] *****************************************
task path: /home/user/overlay/tasks/main.yml
ok: [10.15.1.13] => (item=None)
ok: [10.15.1.14] => (item=None)
ok: [10.15.1.15] => (item=None)

PLAY RECAP *********************************************************************
10.15.1.13                 : ok=1    changed=0    unreachable=0    failed=0
10.15.1.14                 : ok=1    changed=0    unreachable=0    failed=0
10.15.1.15                 : ok=1    changed=0    unreachable=0    failed=0


<div class="topology-diagram">
<img src="data:image/svg+xml;base64,<?plantuml 1.2026.1?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentStyleType="text/css" data-diagram-type="NWDIAG" height="216px" preserveAspectRatio="none" style="width:833px;height:216px;background:#FFFFFF;" version="1.1" viewBox="0 0 833 216" width="833px" zoomAndPan="magnify"><defs/><g><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="82.5527" x="28.666" y="16.1387">Control_Plane</text><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="76.5645" x="34.6543" y="30.1074">10.15.1.0/24</text><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="96.8496" x="14.3691" y="158.5215">Underlay_Fabric</text><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="106.2188" x="5" y="172.4902">L2/L3_fabric_links</text><rect fill="#E2E2F0" height="5" style="stroke:#181818;stroke-width:1;" width="709.1294" x="116.2188" y="16.4688"/><rect fill="#E2E2F0" height="5" style="stroke:#181818;stroke-width:1;" width="565.7544" x="259.5938" y="158.8516"/><path d="M189.9063,21.4688 L189.9063,70.6758" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="66.478" x="143.3308" y="40.978">10.15.1.100</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="93.1509" x="143.3308" y="53.7827">SSH(network_cli)</text><path d="M318.1692,21.4688 L318.1692,70.6758" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="271.5938" y="40.978">10.15.1.11</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="93.1509" x="271.5938" y="53.7827">SSH(network_cli)</text><path d="M318.1692,104.6445 L318.1692,158.8516" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="288.4294" y="135.5562">10.15.1.11</text><path d="M431.3201,21.4688 L431.3201,70.6758" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="384.7446" y="40.978">10.15.1.12</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="93.1509" x="384.7446" y="53.7827">SSH(network_cli)</text><path d="M431.3201,104.6445 L431.3201,158.8516" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="401.5803" y="135.5562">10.15.1.12</text><path d="M544.4709,21.4688 L544.4709,70.6758" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="497.8955" y="40.978">10.15.1.13</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="93.1509" x="497.8955" y="53.7827">SSH(network_cli)</text><path d="M544.4709,104.6445 L544.4709,158.8516" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="514.7312" y="135.5562">10.15.1.13</text><path d="M657.6218,21.4688 L657.6218,70.6758" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="611.0464" y="40.978">10.15.1.14</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="93.1509" x="611.0464" y="53.7827">SSH(network_cli)</text><path d="M657.6218,104.6445 L657.6218,158.8516" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="627.8821" y="135.5562">10.15.1.14</text><path d="M770.7727,21.4688 L770.7727,70.6758" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="724.1973" y="40.978">10.15.1.15</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="93.1509" x="724.1973" y="53.7827">SSH(network_cli)</text><path d="M770.7727,104.6445 L770.7727,158.8516" fill="none" style="stroke:#181818;stroke-width:1;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacing" textLength="59.4795" x="741.033" y="135.5562">10.15.1.15</text><rect fill="#F1F1F1" height="33.9688" style="stroke:#181818;stroke-width:0.5;" width="113.375" x="131.2188" y="70.6758"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="93.375" x="141.2188" y="91.8145">Ansible_Control</text><rect fill="#F1F1F1" height="33.9688" style="stroke:#181818;stroke-width:0.5;" width="67.1914" x="282.5735" y="70.6758"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="47.1914" x="292.5735" y="91.8145">Spine_1</text><rect fill="#F1F1F1" height="33.9688" style="stroke:#181818;stroke-width:0.5;" width="67.1914" x="395.7244" y="70.6758"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="47.1914" x="405.7244" y="91.8145">Spine_2</text><rect fill="#F1F1F1" height="33.9688" style="stroke:#181818;stroke-width:0.5;" width="59.2813" x="512.8303" y="70.6758"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="39.2813" x="522.8303" y="91.8145">Leaf_1</text><rect fill="#F1F1F1" height="33.9688" style="stroke:#181818;stroke-width:0.5;" width="59.2813" x="625.9812" y="70.6758"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="39.2813" x="635.9812" y="91.8145">Leaf_2</text><rect fill="#F1F1F1" height="33.9688" style="stroke:#181818;stroke-width:0.5;" width="59.2813" x="739.1321" y="70.6758"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacing" textLength="39.2813" x="749.1321" y="91.8145">Leaf_3</text><?plantuml-src ZP4z2y8m48PtVyMHIPSswSSa3YA8GmUXEAc4j4abD5mbBHIH_dSXL11iQURtddkvvx2NMZpWlG90rVMDhU7GO6SRmyz6e789W93IghQ57H160vO6BA1Xb10Nxh7LXL5y1E4wCSqelM6UdzPZ2o-Dtf3xrYt8dneLPzCWM-AYQIwQvp8bghcwU06RQKiMi7WQI-UmOVNpaGjAPOruyQCeh2x_Vv95OHRpogNSQAnRuY7MJwEND2z5NaA-vmyV?></g></svg>" alt="Network Topology Diagram" style="max-width:100%;height:auto;background:#fff;padding:16px;border:1px solid #e5e7eb;border-radius:8px;" />
</div>

cisco
# save as overlay_playbook.yml
- hosts: leafs
  gather_facts: false
  roles:
    - role: overlay
% ansible-playbook -i inventory.yml overlay_playbook.yml

What just happened:

  • The playbook targets the "leafs" group and runs the overlay role tasks. Ansible connects over network_cli to each leaf (10.15.1.13-15), executes the cisco.nxos.nxos_vlans module, and enforces the desired VLAN-to-VNI state. The module uses NX-OS APIs/CLI under the hood to apply changes and returns standardized results.

Real-world note: In production, schedule such plays during maintenance windows and monitor for config locks or rollback needs.

Verify:

# On a leaf switch (10.15.1.13), verify VLANs exist (example NX-OS CLI)
show vlan brief
VLAN Name                             Status    Ports
101  Web Servers                      active
102  DB Servers                       active
103  vMotion                          active
# Verify playbook run summary
PLAY RECAP *********************************************************************
10.15.1.13                 : ok=1    changed=1    unreachable=0    failed=0
10.15.1.14                 : ok=1    changed=1    unreachable=0    failed=0
10.15.1.15                 : ok=1    changed=1    unreachable=0    failed=0

Verification Checklist

  • Check 1: Inventory parsed correctly — run ansible-inventory -i inventory.yml --list and confirm spines and leafs groups include the exact IPs (10.15.1.11–15).
  • Check 2: Role scaffolding exists — tree overlay shows tasks/main.yml and vars/, templates/ directories.
  • Check 3: VLANs applied on leaf devices — run show vlan brief on a leaf (e.g., 10.15.1.13) and confirm VLANs 101/102/103 exist and are active.

Common Mistakes

SymptomCauseFix
Ansible fails to connect to devicesWrong ansible_connection or ansible_network_os in inventory.ymlSet ansible_connection: ansible.netcommon.network_cli and ansible_network_os: cisco.nxos.nxos in all:vars
Playbook reports changed=0 but device lacks VLANsTask written incorrectly or state mismatch (e.g., using wrong module args)Use FQCN cisco.nxos.nxos_vlans and the config list format shown; run with -vv for debug
Credentials rejected during SSHUsing lab plaintext credentials without correct accountVerify ansible_user/ansible_password values; use Vault or SSH keys in real deployments
Role files not discoveredRole not created under roles/ or playbook not referencing role correctlyRun ansible-galaxy init overlay and place tasks in roles/overlay/tasks/main.yml; reference role by name in playbook

Key Takeaways

  • Inventory grouping (spines vs leafs) and global vars (ansible_connection, ansible_network_os) are the backbone of network automation targeting specific device types and connection methods.
  • Always use the module’s Fully Qualified Collection Name (FQCN) — e.g., cisco.nxos.nxos_vlans — to ensure the intended vendor implementation is executed.
  • Roles provide structure for reusable, testable configuration units (common, underlay, overlay). Use ansible-galaxy init to scaffold.
  • Idempotency is central: describe the desired state (VLAN list and VNIs), and Ansible will apply only necessary changes, which is essential for safe, repeatable production changes.

Final tip: Move device-specific data into group_vars/host_vars for larger deployments, and encrypt sensitive values (passwords, keys) with Ansible Vault before production use.