ConfDevice.py

#!/usr/bin/env python3

# created by Alexander Deca - Deca Consulting 06/07/2023
# please note there is a requirements file -> pip install -r requirements.txt
# this script iterates over a # of commands that will be executed on the network
# device and saves the configuration.
# input csv file format is ip_address,name,platform

import time
import os
import csv
import logging
import os
from scrapli.driver.core import IOSXEDriver, NXOSDriver, IOSXRDriver
from datetime import datetime

now = datetime.now()
date = now.strftime("%Y-%m-%d")

# Constants
SSH_PORT = int(os.getenv("SSH_PORT", 22))

# Environment Variables 
SSH_USER = os.getenv("SSH_USER")
SSH_PWD = os.getenv("SSH_PWD")

logging.basicConfig(filename='error.log', level=logging.ERROR, format='%(asctime)s - %(levelname)s - %(message)s')
logger = logging.getLogger(__name__)

# Check if all required environment variables are set
if not all([SSH_USER, SSH_PWD, SSH_PORT]):
    logger.error("One or more environment variables are not set")
    exit(1)

# Define the CSV file path containing the device details
csv_file = 'hosts_test.csv'

# Create a list to store the devices
devices = []

# Read the CSV file and populate the devices list
with open(csv_file, 'r') as file:
    reader = csv.DictReader(file)
    for row in reader:
        devices.append(row)

# Iterate over the devices
for device in devices:
    # Connect to the device using Scrapli
    driver = None
    if device["platform"] == "iosxe":
        driver = IOSXEDriver
        hostname_line = 0  # Line index for IOS XE
    elif device["platform"] == "nxos":
        driver = NXOSDriver
        hostname_line = 0  # Line index for NX-OS
    elif device["platform"] == "iosxr":
        driver = IOSXRDriver
        hostname_line = 2  # Line index for IOS XR

    try:
        conn = driver(
            host=device["ip_address"],
            auth_username=SSH_USER,
            auth_password=SSH_PWD,
            auth_strict_key=False,
            ssh_config_file="~/.ssh/config",
        )
        conn.open()
        if conn.isalive():
            # Get the hostname from the device["name"]
            hostname = device["hostname"]

            # # Enter configuration mode
            # conn.send_command("configure terminal")

            # Read the commands from the CSV file
            commands = []
            with open('conf-commands.csv', 'r') as commands_file:
                commands_reader = csv.reader(commands_file)
                header = next(commands_reader)
                for command_row in commands_reader:
                    commands.append(command_row[0])

            # Execute each command in configuration mode
            for command in commands:
                # Send the command
                conn.send_config(command)

            # Exit configuration mode
            conn.send_command("end")

            # Save configuration
            conn.send_command("write memory")

            logger.info(
                f"Configuration completed successfully for {device['hostname']}.")
        else:
            logger.error(f"Connection to {device['hostname']} is not alive.")
    except Exception as e:
        logger.error(
            f"Error occurred while configuring {device['hostname']}: {str(e)}")