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

2024-04-02 19:04:59 410人浏览八月长安

Python 官方文档：入门教程 => 点击学习

摘要

目录运维自动化python一、模块介绍二、模块应用1.使用paramiko模块，通过ssh协议连接服务器2.解决首次连接known_hosts问题3、执行命令exec_command

运维自动化Python

paramiko模块

一、模块介绍

模块：paramiko

模块作用：

1、通过ssh协议远程执行命令

2、文件上传下载

安装模块：

pip install paramiko

二、模块应用

1.使用paramiko模块，通过ssh协议连接服务器

#导入paramiko，（导入前需要先在环境里安装该模块）
import paramiko

#定义函数ssh,把操作内容写到函数里
def sshExeCMD():
    #定义一个变量ssh_clint
    ssh_client=paramiko.SSHClient()
    #使用cnnect类来连接服务器
    ssh_client.connect(hostname="192.168.1.110", port="22", username="songxk", passWord="123123")

#通过判断模块名运行上边函数
if __name__ == '__main__':
    sshExeCMD()

这时会报错，提示在服务器的known_hosts中没有，这个就是连接服务器的时候那个首次连接需要输入一个yes保存证书。

2.解决首次连接known_hosts问题

通过这个set_missing_host_key_policy方法用于实现登录是需要确认输入yes，否则保存

#导入paramiko，（导入前需要先在环境里安装该模块）
import paramiko

#定义函数ssh,把操作内容写到函数里
def sshExeCMD():
    #定义一个变量ssh_clint
    ssh_client=paramiko.SSHClient()
    #通过这个set_missing_host_key_policy方法用于实现登录是需要确认输入yes，否则保存
    ssh_client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
    #使用cnnect类来连接服务器
    ssh_client.connect(hostname="192.168.1.110", port="22", username="songxk", password="123123")

#通过判断模块名运行上边函数
if __name__ == '__main__':
    sshExeCMD()

连接成功，没有报错：

3、执行命令exec_command方法

使用exec_command执行命令会返回三个信息：

1、标准输入内容（用于实现交互式命令）

2、标准输出（保存命令的正常执行结果）

3、标准错误输出（保存命令的错误信息）

可以通过三个变量来接受，然后使用print输出到屏幕查看

#导入paramiko，（导入前需要先在环境里安装该模块）
import paramiko

#定义函数ssh,把操作内容写到函数里
def sshExeCMD():
    #定义一个变量ssh_clint使用SSHClient类用来后边调用
    ssh_client=paramiko.SSHClient()
    #通过这个set_missing_host_key_policy方法用于实现登录是需要确认输入yes，否则保存
    ssh_client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
    #使用cnnect类来连接服务器
    ssh_client.connect(hostname="192.168.1.110", port="22", username="songxk", password="123123")
    #使用exec_command方法执行命令，并使用变量接收命令的返回值并用print输出
    stdin, stdout, stderr = ssh_client.exec_command("hostname")
    print(stdout.read())
#通过判断模块名运行上边函数
if __name__ == '__main__':
    sshExeCMD()

展示内容以python的格式b’内容\n’的格式展示，如果后边需要对回显处理，可以直接用str把内容输出为字符串格式如下：

print(str(stdout.read()))

扩展：

使用try异常捕获

import paramiko
import sys
#定义函数ssh,把操作内容写到函数里
def sshExeCMD():
    #定义一个变量ssh_clint使用SSHClient类用来后边调用
    ssh_client=paramiko.SSHClient()
    #通过这个set_missing_host_key_policy方法用于实现登录是需要确认输入yes，否则保存
    ssh_client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
    #使用try做异常捕获
    try:
    #使用cnnect类来连接服务器
        ssh_client.connect(hostname="192.168.1.110", port="22", username="songx1k", password="123123")
    #如果上边命令报错吧报错信息定义到err变量，并输出。
    except Exception as err:
        print("服务器链接失败！！！")
        print(err)
        #如果报错使用sys的exit退出脚本
        sys.exit()
    #使用exec_command方法执行命令，并使用变量接收命令的返回值并用print输出
    stdin, stdout, stderr = ssh_client.exec_command("df -hT")
    print(str(stdout.read()))
#通过判断模块名运行上边函数
if __name__ == '__main__':
    sshExeCMD()

4、多台服务器执行命令

注意：给函数传参，需要在函数括号里写上接收的参数

#导入paramiko，（导入前需要先在环境里安装该模块）
import paramiko
import sys
#定义函数ssh,把操作内容写到函数里,函数里接收参数（写在括号里）,其中port=是设置一个默认值如果没传就用默认
def sshExeCMD(ip, username, password, port=22):
    #定义一个变量ssh_clint使用SSHClient类用来后边调用
    ssh_client=paramiko.SSHClient()
    #通过这个set_missing_host_key_policy方法用于实现登录是需要确认输入yes，否则保存
    ssh_client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
    #使用try做异常捕获
    try:
    #使用cnnect类来连接服务器
        ssh_client.connect(hostname=ip, port=port, username=username, password=password)
    #如果上边命令报错吧报错信息定义到err变量，并输出。
    except Exception as err:
        print("服务器链接失败！！！"% ip)
        print(err)
        #如果报错使用sys的exit退出脚本
        sys.exit()
    #使用exec_command方法执行命令，并使用变量接收命令的返回值并用print输出
    #这里也可以把命令做成参数传进来
    stdin, stdout, stderr = ssh_client.exec_command("hostname")
    #使用decode方法可以指定编码
    print(stdout.read().decode("utf-8"))
#通过判断模块名运行上边函数
if __name__ == '__main__':
    #定义一个字典，写服务器信息
    servers = {
        #以服务器IP为键,值为服务器的用户密码端口定义的字典
        "192.168.1.110": {
            "username": "songxk",
            "password": "123123",
            "port": 22,
        },
        "192.168.1.123": {
            "username": "root",
            "password": "123123",
            "port": 22,
        },
    }
    #使用items方法遍历，使用ip 和info把字典里的键和值遍历赋值，传给函数sshExeCMD
    for ip, info in servers.items():
        # 这里的info也就是上边定义的ip对应值的字典，使用get获取这个字典里对应username键对应的值，赋值给变量username传给函数中使用
        sshExeCMD(
            ip=ip,
            username=info.get("username"),
            password=info.get("password"),
            port=info.get("port")
        )

5、从服务器上传下载文件–SFTPClient方法

'''
通过ssh协议在服务器上传下载文
时间：2022-04-09
'''
import paramiko

def sshfileftp():
    #与服务器创建ssh连接,transport方法建立通道，以元组的方式歇服务器信息
    ssh_conn = paramiko.Transport(("192.168.1.110", 60317))
    ssh_conn.connect(username="songxk", password="123123")

    #创建连接后，使用sftpclient类和from_transport(括号里写上边创建的Transport通道)基于上边ssh连接创建一个sftp连接，定义成ftp_client变量后边方便引用
    ftp_client = paramiko.SFTPClient.from_transport(ssh_conn)
    #下载文件
    #ftp_client.get("目标文件", r"保存位置，写到文件名")
    ftp_client.get("/etc/fstab", r"C:\Users\Administrator.USER-CH3G0KO3MG\Desktop\test\fstab")
    '''
    上传文件
    ftp_client.put(r"C:\Users\Administrator.USER-CH3G0KO3MG\Desktop\test\fstab", "/etc/fstab")
    '''

    #关闭ssh连接
    ssh_conn.close()

if __name__ == '__main__':
    sshfileftp()

6、多台服务器上传下载文件

和批量对服务器执行命令原理一样，使用字典写服务器信息，通过for循环处理把变量分别传给写好的上传函数。

'''
批量通过ssh协议在服务器上传文件
时间：2022-04-09
localfile:本地文件名
remotedir:服务器目录名
'''

import paramiko
#后续需要用到os模块的方法
import os

#定义函数并且接收变量
def sshPutfile(ip, port, username, password, localfile, remotedir):
    #获取源文件的文件名,把进来的localfile变量的值处理只剩文件名
    file_name = os.path.basename(localfile)

    #处理服务器目录名，如果输入的目录名没有带后边的/(不是以/结尾)则添加一个，方便后边拼接文件名
    if not remotedir.endswith("/"):
        remotedir = remotedir + "/"
    dest_file_name = remotedir + file_name

    #创建ssh连接
    ssh_conn = paramiko.Transport((ip, port))
    ssh_conn.connect(username=username, password=password)
    #创建ftp工具（变量）
    ftp_client = paramiko.SFTPClient.from_transport(ssh_conn)
    #上传文件
    ftp_client.put(localfile, dest_file_name)
    # 关闭ssh连接
    ssh_conn.close()

if __name__ == '__main__':
    #定义一个字典，写服务器的信息
    servers = {
        #以服务器IP为键,值为服务器的用户密码端口定义的字典
        "192.168.1.110": {
            "username": "songxk",
            "password": "123123",
            "port": 60317,
        },
        "192.168.106.71": {
            "username": "root",
            "password": "123123",
            "port": 22,
        },
    }
    source_file = input("请输入源文件路径（绝对路径）：")
    remote_dir = input("服务器路径（绝对路径）：")
    for ip, info in servers.items():
        sshPutfile(
            ip=ip,
            port=info.get("port"),
            username=info.get("username"),
            password=info.get("password"),
            localfile=source_file,
            remotedir=remote_dir
        )

效果：