python之paramiko模块资料总结

目录

1、前言

2、paramiko模块安装方法

3、常用函数介绍（着重使用方法）

3.1 SSHclient类

---

1、前言

       paramiko模块是基于Python实现的SSH远程安全连接，可以提供在远程服务器上执行命令、上传文件到服务器或者从指定服务器下载文件的功能。

2、paramiko模块安装方法

paramiko模块不是python自带的标准库，需要自行下载安装，建议使用pip自动安装。方法如下：

pip/pip3 install paramiko

3、常用函数介绍（着重使用方法）

3.1 SSHclient类

基础配置：

引入paramiko库，引用SSHClient函数并创建sshclient，赋给ssh：

import paramiko
ssh = paramiko.SSHClient() 

备注：后续例子都参考基础配置举例

（1）ssh远程连接服务器

connect(hostname, port=22, username=None, password=None, pkey=None, key_filename=None, timeout=None, allow_agent=True, look_for_keys=True, compress=False, sock=None, gss_auth=False, gss_kex=False, gss_deleg_creds=True, gss_host=None, banner_timeout=None, auth_timeout=None, gss_trust_dns=True, passphrase=None)

参数说明：

• hostname(str类型)，连接的目标主机地址；
• port(int类型)，连接目标主机的端口，默认为22；
• username(str类型)，校验的用户名(默认为当前的本地用户名)；
• password(str类型)，密码用于身份校验或解锁私钥；
• pkey(Pkey类型)，私钥方式用于身份验证；
• key_filename(str or list(str)类型)，一个文件名或文件名列表，用于私钥的身份验证；
• timeout(float类型)，一个可选的超时时间(以秒为单位)的TCP连接；
• allow_agent(bool类型)，设置为False时用于禁用连接到SSH代理；
• look_for_keys(bool类型)，设置为False时用于来禁用在～/.ssh中搜索私钥文件；
• compress(bool类型)，设置为True时打开压缩。

例如：

ssh.connect(ip,22,username,passwd,timeout=5)

此处ip、username、passwd都作为变量；

（2）远程主机没有本地主机密钥或HostKeys对象时的连接方法，需要配置set_missing_host_key_policy(policy)

参数常见取值有3种，分别如下：

• AutoAddPolicy：自动添加主机名及主机密钥到本地的known_hosts，不依赖load_system_host_key的配置。即新建立ssh连接时不需要再输入yes或no进行确认。最为常用。
• WarningPolicy 用于记录一个未知的主机密钥的python警告。并接受，功能上和AutoAddPolicy类似，但是会提示是新连接。
• RejectPolicy 自动拒绝未知的主机名和密钥，依赖load_system_host_key的配置。此为默认选项

例如：

ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())

（3）远程执行命令，该命令的输入与输出流为标准输入(stdin)、输出(stdout)、错误(stderr)的Python文件对像

exec_command(command, bufsize=-1, timeout=None, get_pty=False, environment=None)

参数说明：

• command(str类型)，执行的命令串；
• bufsize(int类型)，文件缓冲区大小，默认为-1(不限制)

例如：

stdin,stdout,stderr = ssh.exec_command(cmd,bufsize,timeout) 
#stdin.write('y'+'\n') #这样通过标准输入输入命令???
#print stdout.read() #输出标准输出。

备注：在SSH server上执行命令，打开新的channel并执行命令，该命令返回的input，output数据流都是file-like对象。可以使用read，readline，readlines方法来将file-like数据变成string类型。stdin标准输入表示执行了cmd命令后的输入？？？

（4）在远程服务器上生成新的交互式shell

invoke_shell(term='vt100', width=80, height=24, width_pixels=0, height_pixels=0, environment=None)

例如：

在SSH server端创建一个交互式的shell，且可以按自己的需求配置伪终端，可以在invoke_shell()函数中添加参数配置

chan = ssh.invoke_shell()

chan.send(cmd) #利用send函数发送cmd到SSH server，添加做回车来执行shell命令（cmd中需要有\n命令才能执行）。注意不同的情况，如果执行完telnet命令后，telnet的换行符是\r\n

（5）通过recv函数获取回显：

chan.recv(bufsize) #

（6）关闭ssh连接

ssh.close()