Python运维自动化之paramiko模块应用实例

引言

在现代IT运维工作中，自动化已经成为一种趋势。Python作为一种功能强大的编程语言，被广泛应用于各种自动化任务的开发。在运维领域，paramiko模块是一个常用的Python库，旨在提供SSHv2协议的客户端，用于远程登录和执行远程命令。

paramiko模块介绍

paramiko模块是一个基于Python编写的SSH客户端库，支持SSHv2协议。它可以实现远程登录服务器、上传下载文件、执行远程命令等功能。使用paramiko，我们可以编写Python脚本来管理远程服务器，实现自动化的运维任务。

安装paramiko模块

要使用paramiko模块，我们需要先进行安装。通过以下命令可安装paramiko模块：

pip install paramiko

远程登录服务器

paramiko提供了SSHClient类来实现远程登录服务器的功能。下面是一个简单的示例：

import paramiko

ssh = paramiko.SSHClient()
ssh.set_missing_host_key_policy(paramiko.AutoAcceptPolicy())
ssh.connect('服务器IP地址', username='用户名', password='密码')
# 执行命令
stdin, stdout, stderr = ssh.exec_command('ls')
print(stdout.read().decode())
# 关闭连接
ssh.close()

首先，我们创建了一个SSHClient实例，并设置了默认的密钥策略为自动接受。

然后，使用connect()方法连接远程服务器，传入服务器的IP地址、用户名和密码。

接着，我们可以使用exec_command()方法执行远程命令，并获取结果。这里我们执行了ls命令并打印了输出结果。

最后，通过close()方法关闭连接。

文件的上传和下载

paramiko还提供了SFTPClient类，用于上传和下载文件。下面是一个示例：

import paramiko

transport = paramiko.Transport(('服务器IP地址', 22))
transport.connect(username='用户名', password='密码')
sftp = paramiko.SFTPClient.from_transport(transport)
sftp.put('本地文件路径', '远程文件路径')
sftp.get('远程文件路径', '本地文件路径')
sftp.close()
transport.close()

首先，创建一个Transport实例，指定服务器的IP地址和端口号（默认为22），并传入用户名和密码进行连接。

然后，使用from_transport()方法创建一个SFTPClient实例。

接着，可以使用put()方法将本地文件上传到远程服务器，或使用get()方法将远程文件下载到本地。

最后，通过close()方法关闭连接。

paramiko模块的应用实例

下面是一个使用paramiko模块实现的简单的自动化运维任务示例：自动备份服务器上的日志文件。

import paramiko

import datetime
def backup_logs(server_ip, username, password, remote_dir, local_dir):
    ssh = paramiko.SSHClient()
    ssh.set_missing_host_key_policy(paramiko.AutoAcceptPolicy())
    ssh.connect(server_ip, username=username, password=password)
    
    timestamp = datetime.datetime.now().strftime('%Y%m%d%H%M%S')
    backup_file = f'log_{timestamp}.tar.gz'
    
    command = f'tar -czf {remote_dir}/{backup_file} {remote_dir}/*.log'
    ssh.exec_command(command)
    
    sftp = ssh.open_sftp()
    sftp.get(f'{remote_dir}/{backup_file}', f'{local_dir}/{backup_file}')
    sftp.close()
    
    ssh.close()
server_ip = '服务器IP地址'
username = '用户名'
password = '密码'
remote_dir = '/var/log'
local_dir = './backup'
backup_logs(server_ip, username, password, remote_dir, local_dir)

该示例中，我们首先连接远程服务器，并使用当前时间生成一个唯一的备份文件名。

然后，使用tar命令将远程目录下的所有日志文件打包为一个tar.gz压缩文件。

接着，我们使用SFTP协议将备份文件下载到本地。

最后，关闭连接。

通过paramiko模块，我们可以很方便地编写Python脚本来完成各种自动化运维任务，提高工作效率。

总结

本文介绍了paramiko模块的基本用法，并给出了一个使用paramiko实现的自动备份日志文件的示例。paramiko模块是Python中常用的运维自动化工具之一，它提供了远程登录、执行远程命令、上传下载文件等功能，可以方便地实现各种自动化任务。希望本文对大家了解paramiko模块的应用实例有所帮助。