Simplifying Network Tasks in Python using Paramiko and Netmiko

In today's interconnected world, computer networks play a vital role in facilitating communication and data exchange. As networks grow in complexity, managing and automating network tasks become increasingly important. Python, with its simplicity and versatility, has emerged as a powerful programming language for network automation. In this article, we will explore two popular Python libraries, Paramiko and Netmiko, that simplify network tasks and enable efficient network automation.

Understanding Paramiko

Paramiko is a Python library designed to automate and simplify secure network device communication using the SSH protocol. It provides a high-level API that makes it easy to establish SSH connections, execute commands, transfer files, and handle authentication. Paramiko is reliable and straightforward, making it an excellent choice for network automation tasks.

To get started with Paramiko, you need to install it using pip ?

pip install paramiko

Key Features of Paramiko

SSH Connectivity

Paramiko allows you to create SSH connections with network devices, enabling secure command execution and file transfers. It supports both password-based and key-based authentication methods.

import paramiko

# Create SSH client
ssh = paramiko.SSHClient()
ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())

# Connect to device
ssh.connect('192.168.1.1', username='admin', password='password')
print("SSH connection established successfully")

# Close connection
ssh.close()

SSH connection established successfully

Command Execution

You can execute commands on network devices using Paramiko and retrieve the results. The exec_command() method returns three file-like objects: stdin, stdout, and stderr ?

import paramiko

ssh = paramiko.SSHClient()
ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())

# Simulate command execution (demo purposes)
print("Executing command: show ip interface brief")
print("Interface              IP-Address      OK? Method Status                Protocol")
print("GigabitEthernet0/0     192.168.1.1     YES NVRAM  up                    up")
print("GigabitEthernet0/1     unassigned      YES NVRAM  administratively down down")

Executing command: show ip interface brief
Interface              IP-Address      OK? Method Status                Protocol
GigabitEthernet0/0     192.168.1.1     YES NVRAM  up                    up
GigabitEthernet0/1     unassigned      YES NVRAM  administratively down down

File Transfer

Paramiko enables file transfers between local and network devices using SFTP (Secure File Transfer Protocol). The SFTPClient class provides methods like put() and get() for transferring files ?

import paramiko

# Create SFTP client example
ssh = paramiko.SSHClient()
ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())

# Demonstrate SFTP usage (conceptual)
print("SFTP client created for file transfer")
print("Available methods: put() for upload, get() for download")
print("Example: sftp.put('local_file.txt', '/remote/path/file.txt')")

SFTP client created for file transfer
Available methods: put() for upload, get() for download
Example: sftp.put('local_file.txt', '/remote/path/file.txt')

Introduction to Netmiko

Netmiko is a multi-vendor library built on top of Paramiko that makes network automation even simpler. It provides a unified API to interact with various network devices regardless of vendor or operating system. Netmiko supports devices from Cisco, Juniper, Arista, Huawei, and many other manufacturers.

To install Netmiko, you can use pip ?

pip install netmiko

Simplifying Network Tasks with Netmiko

Netmiko abstracts away vendor-specific differences, allowing you to write network automation scripts that work consistently across different vendors.

Device Connection

Netmiko provides a straightforward method for connecting to network devices. You specify the device type, IP address, username, and password ?

from netmiko import ConnectHandler

# Device connection parameters
device = {
    'device_type': 'cisco_ios',
    'ip': '192.168.1.1',
    'username': 'admin',
    'password': 'password',
}

# Simulate connection (demo purposes)
print("Connecting to device:", device['ip'])
print("Device type:", device['device_type'])
print("Connection established successfully")

Connecting to device: 192.168.1.1
Device type: cisco_ios
Connection established successfully

Command Execution and Configuration Management

The send_command() method allows you to execute commands and retrieve output easily. Netmiko also provides configuration management capabilities ?

# Simulate Netmiko command execution
print("Executing: show version")
print("Cisco IOS Software, C2960 Software (C2960-LANBASEK9-M), Version 15.0(2)SE4")
print("System image file is 'flash:c2960-lanbasek9-mz.150-2.SE4.bin'")

# Configuration example
config_commands = [
    'interface GigabitEthernet0/1',
    'description Server Port',
    'switchport mode access',
    'switchport access vlan 10'
]

print("\nConfiguration commands to be applied:")
for cmd in config_commands:
    print(f"  {cmd}")

Executing: show version
Cisco IOS Software, C2960 Software (C2960-LANBASEK9-M), Version 15.0(2)SE4
System image file is 'flash:c2960-lanbasek9-mz.150-2.SE4.bin'

Configuration commands to be applied:
  interface GigabitEthernet0/1
  description Server Port
  switchport mode access
  switchport access vlan 10

Comparison

Example: Retrieving Device Information

Here's a practical example comparing Paramiko and Netmiko for retrieving device information ?

# Demonstrate both approaches (conceptual example)

# Paramiko approach
print("=== Paramiko Approach ===")
print("1. Create SSHClient()")
print("2. Set host key policy")
print("3. Connect with credentials") 
print("4. Execute command with exec_command()")
print("5. Read and decode output")
print("6. Close connection")

print("\n=== Netmiko Approach ===")
print("1. Define device dictionary")
print("2. Create ConnectHandler")
print("3. Send command with send_command()")
print("4. Disconnect")

# Sample output
sample_output = """
Cisco IOS Software, IOSv Software (VIOS-ADVENTERPRISEK9-M), Version 15.6(2)T
Technical Support: http://www.cisco.com/techsupport
System uptime is 2 days, 14 hours, 32 minutes
"""

print("\nSample device output:")
print(sample_output.strip())

=== Paramiko Approach ===
1. Create SSHClient()
2. Set host key policy
3. Connect with credentials
4. Execute command with exec_command()
5. Read and decode output
6. Close connection

=== Netmiko Approach ===
1. Define device dictionary
2. Create ConnectHandler
3. Send command with send_command()
4. Disconnect

Sample device output:
Cisco IOS Software, IOSv Software (VIOS-ADVENTERPRISEK9-M), Version 15.6(2)T
Technical Support: http://www.cisco.com/techsupport
System uptime is 2 days, 14 hours, 32 minutes

Conclusion

Paramiko and Netmiko are powerful Python libraries that simplify network automation tasks. Paramiko provides low-level SSH functionality, while Netmiko offers vendor-agnostic network device management. Choose Paramiko for custom SSH operations and Netmiko for streamlined network device automation across multiple vendors.