使用paramiko远程执行命令、下发文件的实例


Posted in Python onOctober 01, 2017

写部署脚本时,难免涉及到一些远程执行命令或者传输文件。

之前一直使用sh库,调用sh.ssh远程执行一些命令,sh.scp传输文件,但是实际使用中还是比较麻烦的,光是模拟用户登陆这一点,还需要单独定义方法模拟输入。

感受一下:

from sh import ssh
PASS = 'xxxx'
def ssh_interact(line, stdin):
  line = line.strip()
  print(line)
  if line.endswith('password:'):
    stdin.put(PASS)
ssh('x.x.x.x', _out=ssh_interact)

来自官方文档

后来发现paramiko库更加优雅、便捷,所以准备用pramiko替换掉sh。

之前通过同事了解到,paramiko在远程执行python脚本时,脚本中的输出内容可能会通过stderr这个管道输出出来,所以直接用paramiko的SSHClient类中的exec_command方法执行,通过读stderr管道中有无输出来判断命令是否成功执行的方式是行不通的。所以用更底层一些的Channel类的recv_exit_status方法判断执行退出码更好一些。

安装

可以通过使用pip install paramiko安装,细节这里不再赘述。

封装

首先定义几个异常

# coding: utf-8
import os.path

from paramiko import SSHClient, AutoAddPolicy, AuthenticationException


class ConnectError(Exception):
  """
  连接错误时抛出的异常
  """
  pass

class RemoteExecError(Exception):
  """
  远程执行命令,失败时抛出的异常
  """
  pass

class SCPError(Exception):
  """
  远程下发文件时抛出的异常
  """
  pass
...
class Remote(object):
  def __init__(self, host, username, password=None, port=22, key_filename=None):
    self.host = host
    self.username = username
    self.password = password
    self.port = port
    self.key_filename = key_filename
    self._ssh = None

  def _connect(self):
    self._ssh = SSHClient()
    self._ssh.set_missing_host_key_policy(AutoAddPolicy())
    try:
      if self.key_filename:
        self._ssh.connect(self.host, username=self.username, port=self.port, key_filename=self.key_filename)
      else:
        self._ssh.connect(self.host, username=self.username, password=self.password, port=self.port)
    except AuthenticationException: 
      self._ssh = None
      raise ConnectionError('连接失败,请确认用户名、密码、端口或密钥文件是否有效')
    except Exception as e:
      self._ssh = None
      raise ConnectionError('连接时出现意料外的错误:%s' % e)

  def get_ssh(self):
    if not self._ssh:
      self._connect()
    return self._ssh

实例化SSHClient类,通过它的connect()方法获取SSH连接。

需要注意的是,远程访问的主机若是第一次连接,属于未知设备需要认证,通过set_missing_host_key_policy()方法设置一种策略,这里使用的是AutoAddPolicy()。

这里的_connect支持两种方式登录,一种是提供主机的用户名密码,另一种是通过密钥文件。在连接时检查如果指定了密钥文件则使用这种方式登录,否则通过用户名密码登录。

_connect()虽然是实际的建立连接的方法,但实际对外接口是get_ssh(),如果已经有建立好的SSH连接直接返回,避免重复建立连接。

class Remote(object):
  ...
  def ssh(self, cmd, root_password=None, get_pty=False, super=False):
    cmd = self._prepare_cmd(cmd, root_password, super)
    stdout = self._exec(cmd, get_pty)
    return stdout

  def _prepare_cmd(self, cmd, root_password=None, super=False):
    if self.username != 'root' and super:
      if root_password:
        cmd = "echo '{}'|su - root -c '{}'".format(root_password, cmd)
      else:
        cmd = "echo '{}'|sudo -p '' -S su - root -c '{}'".format(self.password, cmd)
    return cmd

  def _exec(self, cmd, gty_pty=False):
    channel = self.get_ssh().get_transport().open_session()
    if get_pty:
      channel.get_pty()
    channel.exec_command(cmd)
    stdout = channel.makefile('r', -1).readlines()
    stderr = channel.makefile_stderr('r', -1).readlines()
    ret_code = channel.recv_exit_status()
    if ret_code:
      msg = ''.join(stderr) if stderr else ''.join(stdout)
      raise RemoteExecError(msg)
    return stdout

在远程执行某些命令时,可能需要管理员权限,这种时候需要做一些判断,首先判断登录提供的用户名如果不是root,则需要对命令做一些修改。这里的修改有两种情况,一是,该普通用户本身就有sudo权限,只需要把执行的命令加到sudo之后执行就可以,还有一种是普通用户没有sudo权限,需要通过su先切换到root身份之后再执行,这种情况下需要提供root密码。

还有一点要注意的是get_pty这个参数,实际在远程执行sudo命令时,一般主机都会需要通过tty才能执行,通过把get_pty值设置为True,可以模拟tty,但是随之而来也会有一个问题,如果是远程执行一个需要长期运行的进程,例如启动nginx服务,当远程命令执行后SSH退出之后,此次运行的所有程序也会随之结束,所以在需要通过远程命令运行某些服务或程序时,是不能指定get_pty参数的;但同时,如果是普通用户远程登录,是没有权限执行service命令的。建议的一种方式是修改/etc/sudoers配置文件,注释掉Defaults requiretty这行。

class Remote(object):
  ...

  def scp(self, local_file, remote_path):
    if not os.path.exists(local_file):
      raise SCPError("Local %s isn't exists" % local_file)
    if not os.path.isfile(local_file):
      raise SCPError("%s is not a File" % local_file)
    sftp = self.get_ssh().open_sftp()
    try:
      sftp.put(local_file, remote_path)
    except Exception as e:
      raise SCPError(e)

先确认要下发的文件存在,并且是文件不是目录,如果不是则抛出异常。同时,remote_path需要是远程主机的文件绝对目录,例如/tmp/xxx.xxx,而不能是/tmp。

使用

# coding: utf-8
from remote_client import RemoteClient

rc = RemoteClient('10.1.100.1', 'test', 'test_pass')
rc.ssh('whoami')  # [u'test\n']
rc.scp('/tmp/test.out', '/tmp/test.out')

总结

相较于sh,paramiko好用的不是一星半点,这里只是提供了一个简单的封装,paramiko本身还有很多其他用法,欢迎大家积极讨论。

以上只是本人的一点理解,如果有错误之处,欢迎指正。

以上这篇使用paramiko远程执行命令、下发文件的实例就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持三水点靠木。

Python 相关文章推荐
从Python的源码来解析Python下的freeblock
May 11 Python
解决Ubuntu pip 安装 mysql-python包出错的问题
Jun 11 Python
python定时关机小脚本
Jun 20 Python
python 多个参数不为空校验方法
Feb 14 Python
Python实现的爬取百度文库功能示例
Feb 16 Python
两个元祖T1=('a', 'b'),T2=('c', 'd')使用匿名函数将其转变成[{'a': 'c'},{'b': 'd'}]的几种方法
Mar 05 Python
详解Django admin高级用法
Nov 06 Python
基于python实现语音录入识别代码实例
Jan 17 Python
Tensorflow获取张量Tensor的具体维数实例
Jan 19 Python
使用Django清空数据库并重新生成
Apr 03 Python
Python LMDB库的使用示例
Feb 14 Python
python绘制汉诺塔
Mar 01 Python
解决Scrapy安装错误:Microsoft Visual C++ 14.0 is required...
Oct 01 #Python
win10下Python3.6安装、配置以及pip安装包教程
Oct 01 #Python
Python实现字符串反转的常用方法分析【4种方法】
Sep 30 #Python
Python实现利用最大公约数求三个正整数的最小公倍数示例
Sep 30 #Python
Python基于pygame模块播放MP3的方法示例
Sep 30 #Python
Python实现自动为照片添加日期并分类的方法
Sep 30 #Python
Python实现获取照片拍摄日期并重命名的方法
Sep 30 #Python
You might like
PHP学习之PHP变量
2006/10/09 PHP
一篇有意思的技术文章php介绍篇
2010/10/26 PHP
让php处理图片变得简单 基于gb库的图片处理类附实例代码下载
2011/05/17 PHP
PHP生成树的方法
2015/07/28 PHP
document.open() 与 document.write()的区别
2007/08/13 Javascript
JavaScript中的Location地址对象
2008/01/16 Javascript
javascript 正则表达式相关应介绍
2012/11/27 Javascript
jquery获取自定义属性(attr和prop)实例介绍
2013/04/21 Javascript
基于jquery的禁用右键、文本选择功能、复制按键的实现代码
2013/08/27 Javascript
js二维数组排序的简单示例代码
2014/01/24 Javascript
document.compatMode的CSS1compat使用介绍
2014/04/03 Javascript
JS获得浏览器版本和操作系统版本的例子
2014/05/13 Javascript
9款2014最热门jQuery实用特效推荐
2014/12/07 Javascript
js阻止冒泡和默认事件(默认行为)详解
2016/10/20 Javascript
weUI应用之JS常用信息提示弹层的封装
2016/11/21 Javascript
JS实现重新加载当前页面
2016/11/29 Javascript
详解angularjs实现echart图表效果最简洁教程
2017/11/29 Javascript
从setTimeout看js函数执行过程
2017/12/19 Javascript
vue-cli项目根据线上环境分别打出测试包和生产包
2018/05/23 Javascript
原生实现一个react-redux的代码示例
2018/06/08 Javascript
小程序实现人脸识别功能(百度ai)
2018/12/23 Javascript
[02:42]DOTA2英雄基础教程 杰奇洛
2013/12/23 DOTA
python查找第k小元素代码分享
2013/12/18 Python
Zabbix实现微信报警功能
2016/10/09 Python
windows系统下Python环境搭建教程
2017/03/28 Python
python实现贪吃蛇小游戏
2020/03/21 Python
基于Keras的格式化输出Loss实现方式
2020/06/17 Python
HTML5 video 事件应用示例
2014/09/11 HTML / CSS
HTML5实现简单图片上传所遇到的问题及解决办法
2016/01/20 HTML / CSS
彪马香港官方网上商店:PUMA香港
2020/12/06 全球购物
毕业生个人求职信范文分享
2014/01/05 职场文书
宣传保护环境的公益广告词
2014/03/13 职场文书
4S店销售内勤岗位职责
2015/04/13 职场文书
公司员工体检通知
2015/04/21 职场文书
小兵张嘎观后感
2015/06/03 职场文书
vue点击弹窗自动触发点击事件的解决办法(模拟场景)
2021/05/25 Vue.js