KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #typescript #developer-tools #claude-code #ai-agent #codex #deepseek-harness #ai-agents #cli #react #mcp

ansible-napalm-samples

★ 98 Open GitHub ↗

GitHub Repo comparing NAPALM and Ansible on Cisco NXOSv and Arista vEOS

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Ansible and NAPALM Samples
This GitHub Repo focuses on comparing [Ansible](https://www.ansible.com/network-automation) and [NAPALM](https://github.com/napalm-automation/napalm) on Cisco NX-OS and Arista EOS.

Ansible is powerful automation software that you can learn quickly.  Ansible is an open source project, Ansible Engine is the product you can buy enterprise support for.  NAPALM is actually a Python library that implements a set of functions to interact with different router vendor devices using a unified API. NAPLAM isn't a product, but rather another open source project with a community behind it. While many networking use-cases can potentially overlap the two tools augment each other rather than compete directly.  There are even [NAPALM Ansible modules](https://github.com/napalm-automation/napalm-ansible).

## Table of Contents
- [Example 1 - Backing up a Config](#example-1---backing-up-a-config)
- [Example 2 - Adding an IP address to an interface](#example-2---adding-an-ip-address-to-an-interface)
- [Example 3 - Adding a new VLAN](#example-3---adding-a-new-vlan)
- [Example 4 - Change the SNMP password](#example-4---change-the-snmp-password)

NAPALM also has [Ansible modules](https://github.com/napalm-automation/napalm-ansible) so you can use Ansible to run NAPLAM.  Example 5 and 6 shows NAPALM being used in conjunction with Ansible compared to native Ansible modules.

- [Example 5 - Grabbing a show version](#example-5---grabbing-a-show-version)
- [Example 6 - Changing hostname and domain_name](#example-6---changing-hostname-and-domain_name)

## Example 1 - Backing up a Config

### Ansible

Ansible can use the nxos_config module for easy backups.  There is a backup parameter that can just be turned to `yes`.  This playbook is stored as [backup.yml](backup.yml) on this git repo.

```
---
- hosts: cisco
  connection: network_cli
  tasks:
    - nxos_config:
        backup: yes
```

Run the playbook with `ansible-playbook backup.yml`.  Although not shown here the output will also have color output (yellow=changed, green=OK, red=failed.).

```
[root@localhost ~]# ansible-playbook backup.yml

PLAY [cisco] ******************************************************************

TASK [nxos_config] ************************************************************

ok: [n9k]

PLAY RECAP ********************************************************************
n9k                        : ok=1    changed=0    unreachable=0    failed=0
```

After running the playbook there will be a timestamped config stored under the directory backup:
```
[root@localhost ~]# ls backup
n9k_config.2017-09-26@10:21:28
```

### NAPALM

NAPALM calls a backup file a *checkpoint* file and can be retrieved using the `_get_checkpoint_file()`.  The code snippet below is only a portion of the code, the  python script is stored in this git repo as [get_config.py](get_config.py).

```python
###config snippet, rest of config removed for brevity
checkpoint = device._get_checkpoint_file()
#print(checkpoint)

#create the directory if it does not exist
if not os.path.exists("backup"):
  os.makedirs("backup")

f = open("backup/" + nxos_facts['hostname'] + "." + time, 'w')
f.write(checkpoint)
f.close
device.close()
###config snippet, rest of config removed for brevity
```

Run the python program with `python backup.py`.  The python program will create a folder:
```
[root@localhost naplam_examples]# ls backup/
switch.2017-09-26@15-11
```

## Example 2 - Adding an IP address to an interface

### Ansible

Ansible has a [eos_config](http://docs.ansible.com/ansible/latest/eos_config_module.html) specifically used for making config changes (either entire flat-files) or partials (in this case editing a single interface).  This playbook is stored as [ipaddress.yml](ipaddress.yml) on this git repo.
```
---
- hosts: arista
  connection: network_cli
  tasks:
    - eos_config:
        lines:
          - no switchport
          - ip address 172.16.1.1/24
        parents: interface Ethernet1
```

To run a playbook use the `ansible-playbook` command.
```
[root@localhost ~]# ansible-playbook ipaddress.yml
```

Verify the interface is configured with a `show run int e1`

```bash
eos#sh run int e1
interface Ethernet1
   no switchport
   ip address 172.16.1.1/24
```

### NAPALM

This demonstration will show NAPLAM in python only mode (meaning no third party integrations).  The code snippet below is only a portion of the code, the  python script is stored in this git repo as [ipaddress.py](ipaddress.py).  This example is configuring on NX-OS (versus Ansible that was running on Arista EOS).

```python
###config snippet, rest of config removed for brevity
driver = napalm.get_network_driver('nxos')
# Connect:
device = driver(hostname='192.168.2.3', username='admin',
                password='Bullf00d')
print 'Opening ...'
device.open()

config_string = """ interface Ethernet1/20
                      no switchport
                      ip address 172.16.1.1/24 """

device.load_merge_candidate(config=config_string)

###config snippet, rest of config removed for brevity

device.commit_config()

device.close()
```

To run the program execute the python program:
```
[root@localhost naplam_examples]# python ipaddress.py
```

Verify the interface is configured with a `show run int e1/20`
```
switch# sh run int e1/20

!Command: show running-config interface Ethernet1/20
!Time: Tue Sep 19 22:51:37 2017

version 7.0(3)I7(1)

interface Ethernet1/20
  no switchport
  ip address 172.16.1.1/24
```

## Example 3 - Adding a new VLAN

### Ansible
In addition to the [nxos_config module](http://docs.ansible.com/ansible/latest/nxos_config_module.html) we can use the [nxos_vlan module](http://docs.ansible.com/ansible/latest/nxos_vlan_module.html) to make this really easy.  This playbook is stored as [add_vlan.yml](add_vlan.yml) on this git repo.
```
---
- hosts: cisco
  connection: network_cli
  tasks:
    - nxos_vlan:
        vlan_id: 10
        name: STORAGE
```        
Run the playbook with `ansible-playbook add_vlan.yml`

Verify the VLAN is configured with a `show running-config vlan 10`
```
switch# show running-config vlan 10

!Command: show running-config vlan 10
!Time: Tue Sep 19 22:39:40 2017

version 7.0(3)I7(1)
vlan 10
vlan 10
  name STORAGE
```

### NAPALM

config_string = """ vlan 20
                      name HADOOP """

device.load_merge_candidate(config=config_string)

###config snippet, rest of config removed for brevity

device.commit_config()

device.close()
```

To run the program execute the python program:
```
[root@localhost naplam_examples]# python add_vlan.py
```

Verify with a `show vlan` or a `show run vlan 20`
```
switch# sh run vlan 20

!Command: show running-config vlan 20
!Time: Tue Sep 19 22:50:11 2017

version 7.0(3)I7(1)
vlan 20
vlan 20
  name HADOOP
```

## Example 4 - Change the SNMP password
A common maintenance task for network operations teams is to change the SNMP password every so often (e.g. every 90 days).  This can also be automated with Ansible and NAPALM.

2 NOTES:
- To see available groups on NXOS you can look at `show snmp group`.  The network-admin is commonly used for configuration.
- NXOS has some default password complexities.  From the NXOS box: `password strength check: Password should contain characters from at least three of the following classes: lower case letters, upper case letters, digits and special characters.`

### Ansible
For Ansible there is a [nxos_snmp_user module](http://docs.ansible.com/ansible/latest/nxos_snmp_user_module.html) that is available to use.  The  Ansible playbook demonstrated is stored as [change_snmp_password.yml](change_snmp_password.yml).

```
---
- hosts: cisco
  connection: network_cli
  tasks:
    - nxos_snmp_user:
        user: exampleuser
        group: network-admin
        authentication: sha
        pwd: testPASS123
```        
To run the playbook perform a `ansible-playbook change_snmp_password.yml`

On the NXOS switch we can perform a `show run | i snmp` to see the new config:
```
switch# sh run | i snmp
snmp-server user admin network-admin auth md5 0xc1ddb036df145c775510428fe3c6b553 priv 0xc1ddb036df145c775510428fe3c6b553 localizedkey
snmp-server user exampleuser network-admin auth sha 0x7071c014b53743ca568dd2c3fd70005c5e21db5e localizedkey
```

### NAPALM

NAPALM treats everything as a config merge or replace so there is no specific module just for SNMP (for configuring, there is a `get_snmp_information()`).  This is very similar where we can merge a flat-file or string into the existing config.  The code snippet below is only a portion of the code, the  python script is stored in this git repo as [change_snmp_password.py](change_snmp_password.py).

config_string = """ snmp-server user exampleuser network-admin auth sha testPASS123 """

device.load_merge_candidate(config=config_string)

###config snippet, rest of config removed for brevity

device.commit_config()

device.close()
```

To run the program execute the python program:
```
[root@localhost naplam_examples]# python change_snmp_password.py
```

### Ansible
For Ansible there is a [nxos_facts module](http://docs.ansible.com/ansible/latest/nxos_facts_module.html) that is available to use for collecting facts about a system.  The  Ansible playbook demonstrated is stored as [showversion.yml](showversion.yml).

```
---
- hosts: cisco
  connection: network_cli
  gather_facts: False
  tasks:
    - name: run show version
      nxos_facts:
    - debug:
        var: ansible_net_version
```
Run with the playbook with: `ansible-playbook showversion.yml`

```
[root@localhost ~]# ansible-playbook showversion.yml

PLAY [cisco] ******************************************************************

TASK [run show version] *******************************************************
ok: [n9k]

TASK [debug] ******************************************************************
ok: [n9k] => {
    "result.stdout_lines[0][14]": "  NXOS: version 7.0(3)I7(1)"
}

PLAY RECAP ********************************************************************
n9k                        : ok=2    changed=0    unreachable=0    failed=0
```

### NAPALM
For Ansible with NAPALM there is a [napalm_get_facts](https://github.com/napalm-automation/napalm-ansible) that is available to use.  The Ansible playbook demonstrated is stored as [showversion_napalm.yml](showversion_napalm.yml).  The connection method network_cli does not work with the NAPALM modules, and must be set to local.

```
---
- hosts: cisco
  connection: local
  tasks:
    - napalm_get_facts:
        hostname: "{{ inventory_hostname }}"
        username: "{{ login_info.username }}"
        password: "{{ login_info.password }}"
        dev_os: "nxos"
      register: version

- debug:
        var=version.ansible_facts.napalm_facts.os_version
```
Run with the playbook with: `ansible-playbook showversion_napalm.yml`
```
[root@localhost ~]# ansible-playbook showversion_napalm.yml

PLAY [cisco] ******************************************************************

TASK [napalm_get_facts] *******************************************************
ok: [n9k]

TASK [print data] *************************************************************
ok: [n9k] => {
    "version.ansible_facts.napalm_facts.os_version": "7.0(3)I7(1)"
}

PLAY RECAP ********************************************************************
n9k                        : ok=2    changed=0    unreachable=0    failed=0
```

Both examples show the NXOS switch is running 7.0(3)I7(1).

## Example 6 - Changing hostname and domain_name

### Ansible
For Ansible there is a [nxos_system module](http://docs.ansible.com/ansible/latest/nxos_system_module.html) that is available to use.  The  Ansible playbook demonstrated is stored as [hostname.yml](hostname.yml).

```
---
- hosts: cisco
  connection: local
  tasks:
    - nxos_system:
        hostname: n9k
        domain_name: durham.nc.com
        provider: "{{login_info}}"
```        
Run with the playbook with: `ansible-playbook hostname.yml`

### NAPALM with Ansible
For Ansible with NAPALM there is a [napalm_install_config](https://github.com/napalm-automation/napalm-ansible) that is available to use.  The  Ansible playbook demonstrated is stored as [hostname_napalm.yml](hostname_napalm.yml).  The [hostname.conf](hostname.conf) is also stored in this git repo for demonstration purposes.
```
---
- hosts: cisco
  connection: local
  tasks:
    - napalm_install_config:
        hostname: "{{ inventory_hostname }}"
        username: "{{ login_info.username }}"
        password: "{{ login_info.password }}"
        dev_os: "nxos"
        config_file: hostname.conf
        commit_changes: True
        diff_file: initial.diff
```  
Run with the playbook with: `ansible-playbook hostname_napalm.yml`

---
![Red Hat Ansible Automation](https://raw.githubusercontent.com/network-automation/ansible-napalm-samples/master/images/rh-ansible-automation.png)

Red Hat® Ansible® Automation consists of  three products:

- [Red Hat® Ansible® Tower](https://www.ansible.com/tower): Built for operationalizing and scaling automation, managing complex deployments and speeding up productivity. Extend the power of Ansible Tower with Workflows and Surveys to streamline jobs and simple tools to share solutions with your team.

- [Red Hat® Ansible® Engine](https://www.ansible.com/ansible-engine): a fully supported product built on the foundational capabilities of the Ansible project. Also provides support for select modules including Infoblox.

- [Red Hat® Ansible® Network Automation](https://www.ansible.com/networking): provides support for select networking modules from Arista (EOS), Cisco (IOS, IOS XR, NX-OS), Juniper (JunOS), Open vSwitch, and VyOS. Includes Ansible Tower, Ansible Engine, and curated content specifically for network use cases.

ansible-napalm-samples

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README