Automating Network Device Backups with Python: A Step-by-Step Guide

September 11, 2024 3 min read

Automating Network Device Backups with Python

Introduction

Manually backing up network device configurations is time-consuming and prone to error. With Python, you can automate the process, ensuring that you have up-to-date configurations without the hassle. In this article, we'll walk you through a simple yet powerful Python script to back up configurations from multiple devices, allowing for easier network management and disaster recovery.

Why Automate Device Backups?

Network engineers deal with various devices like routers, switches, and firewalls, all of which have critical configurations that need regular backups. Automating this process provides several benefits:

  • Time Savings: No need for manual backups, freeing up your time for more critical tasks.
  • Consistency: Automated scripts reduce the risk of human error and ensure all devices are backed up regularly.
  • Disaster Recovery: Having the latest configurations readily available is crucial in the event of a device failure or misconfiguration.

Setting Up Python for Device Backups

To automate network device backups, we'll use the popular Netmiko library. This library simplifies SSH connections to network devices and allows us to retrieve configurations with minimal code.

Prerequisites

  1. Python installed (version 3.x recommended).
  2. Install Netmiko by running:
pip install netmiko

Step-by-Step Backup Script

Here's a simple Python script to back up the running configuration from Cisco devices:

from netmiko import ConnectHandler

# Define the device details
device = {
    'device_type': 'cisco_ios',
    'ip': '192.168.1.1',
    'username': 'admin',
    'password': 'password',
}

# Establish an SSH connection
net_connect = ConnectHandler(**device)

# Retrieve the running configuration
output = net_connect.send_command('show running-config')

# Save the configuration to a file
filename = f"{device['ip']}_running-config.txt"

with open(filename, 'w') as config_file:
    config_file.write(output)

print(f"Backup saved to {filename}")

Explanation

  • ConnectHandler establishes an SSH connection to the device.
  • The send_command() function executes the Cisco show running-config command and retrieves the configuration.
  • The configuration is saved in a text file named after the device's IP address for easy identification.

Scaling the Script for Multiple Devices

To back up configurations from multiple devices, define a list of devices and loop through them:

from netmiko import ConnectHandler

# List of devices to back up
devices = [
    {
        'device_type': 'cisco_ios',
        'ip': '192.168.1.1',
        'username': 'admin',
        'password': 'password'
    },
    {
        'device_type': 'cisco_ios',
        'ip': '192.168.1.2',
        'username': 'admin',
        'password': 'password'
    },
    # Add more devices as needed
]

# Loop through each device and back up the running config
for device in devices:
    net_connect = ConnectHandler(**device)
    output = net_connect.send_command('show running-config')

    filename = f"{device['ip']}_running-config.txt"

    with open(filename, 'w') as config_file:
        config_file.write(output)

    print(f"Backup for {device['ip']} saved to {filename}")

Scheduling the Backups

Once you have the script, the next step is to automate it on a regular basis.

On Linux/Mac (Using Cron)

  1. Open the crontab editor:
crontab -e
  1. Add the following line to schedule the script to run at midnight every day:
0 0 * * * /usr/bin/python3 /path/to/your/backup_script.py

On Windows (Using Task Scheduler)

  1. Open Task Scheduler and create a new task.
  2. Under Actions, add the path to your Python interpreter and the backup script.
  3. Set the trigger to run the task daily.

Best Practices for Backup Automation

  1. Encrypt Backup Files: Store backup files in a secure location and consider encrypting them to protect sensitive network data.
  2. Log Backup Activities: Implement logging in your Python script to track successful or failed backups.
  3. Test Regularly: Periodically test your backup scripts to ensure they work as expected, especially after device updates.

Conclusion

Automating network device backups with Python is not only efficient but also ensures that you have the latest configurations at your fingertips, ready for any recovery scenario. Whether you manage a few devices or hundreds, scaling this process with Python is straightforward. With the power of libraries like Netmiko, automating network tasks like backups has never been easier.

← Back to Blog