python paramiko模块

1.介绍:

ssh是一个协议,OpenSSH是其中一个开源实现,paramikoPython的一个库,实现了SSHv2协议(底层使用cryptography)。
有了Paramiko以后,我们就可以在Python代码中直接使用SSH协议对远程服务器执行操作,而不是通过ssh命令对远程服务器进行操作。
由于paramiko属于第三方库,所以需要使用如下命令先行安装:
pip install paramiko

2.paramiko介绍:

paramiko包含两个核心组件:SSHClientSFTPClient
SSHClient的作用类似于Linuxssh命令,是对SSH会话的封装,该类封装了传输(Transport),通道(Channel)及SFTPClient建立的方法(open_sftp),通常用于执行远程命令。
SFTPClient的作用类似与Linuxsftp命令,是对SFTP客户端的封装,用以实现远程文件操作,如文件上传、下载、修改文件权限等操作。

转自Python模块学习 - Paramiko

3.实践:连接多个remote并实现上传下载和运行command

# -*- coding: utf-8 -*-

import paramiko
from paramiko import SSHClient as sc

import logging
import os

# 把接收的stdout转成generator,不然超过3k,程序会被hang住
class ReceiveGenerator(object):
    def __init__(self, stdout):
        self.output = stdout
        self.out_channel = stdout.channel

    def __iter__(self):
        return self

    def next(self):
        """
        python2 compatibly
        """
        return self.out_channel.recv(1024)

    def __next__(self):
        """
        python3 compatibly
        """
        return self.out_channel.recv(1024)

    def exit_code_ready(self):
        return self.out_channel.exit_status_ready()

    def exit_code(self):
        return self.out_channel.recv_exit_status()


class SSHClient(object):
    def __init__(self, transport, sftp, ssh):

        self.transport = transport
        self.sftp = sftp
        self.ssh = ssh
        self.hostname = None

    @staticmethod
    def connect(hostname, port, username, key_path):
        try:
            # 私钥的文件路径
            key = paramiko.RSAKey.from_private_key_file(key_path)
            # 创建transport通道
            transport = paramiko.Transport(hostname, port)
            transport.connect(username=username, pkey=key)

            # 创建sftp通道
            sftp = paramiko.SFTPClient.from_transport(transport)
            ssh = sc()
            ssh._transport = transport

            # logger.info('connection is succeed, hostname: %s', hostname)

            return SSHClient(transport, sftp, ssh)
        except:
            raise Exception('connection is failed')

    # 执行linux上的命令
    def ssh_command(self, command):

        stdin, stdout, stderr = self.ssh.exec_command(command)

        return stdin, stdout, stderr

     # 上传
    def sftp_upload(self, local_path, remote_path):

        self.sftp.put(localpath=local_path, remotepath=remote_path)

     # 下载
    def sftp_download(self, local_path, remote_path):

        self.sftp.get(localpath=local_path, remotepath=remote_path)

    def close(self):
        self.transport.close()

    def structure_output(self, command):
        stdin, stdout, stderr = self.ssh_command(command)

        # structure a generator class
        return ReceiveGenerator(stdout), stderr

    # 如果params是string的话直接上传至指定文件, 如果是路径直接上传并执行commamd
    def script(self, params, remote_path, command=None):
        if os.path.isfile(params):
            self.sftp_upload(params, remote_path)

            stdout_iterator, stderr = self.structure_output(command)
            out = ['']
            for i in stdout_iterator:
                # 返回长度为0通道关闭
                if not len(i):
                    break
                out[0] += i

            return {
                'stdout': out[0],
                'stderr': stderr.read().decode('utf-8'),
                'exitcode': stdout_iterator.exit_code()
            }

        ftp_file = self.sftp.file(remote_path, 'w', -1)
        ftp_file.write(params)
        ftp_file.flush()

        stdout_iterator, stderr = self.structure_output(command)

        return {
            'stdout': stdout_iterator,
            'stderr': stderr.read().decode('utf-8'),
            'exitcode': stdout_iterator.exit_code()
        }


if __name__ == '__main__':

    logger = logging.getLogger(__name__)
    logger.setLevel(level=logging.INFO)
    handler = logging.StreamHandler()
    logger.addHandler(handler)


    def main(hostname_list, port, username, pkey_path, input_params, remote_path, command):
        """
        :param hostname_list: list, of hostname
        :param port: int, port
        :param username: string
        :param pkey_path: string, path
        :param input_params: string, it can be path in local or string
        :param remote_path: string, path of remote
        :param command: string
        :return: a generator class
        """

        for hostname in hostname_list:
            ssh_client = SSHClient.connect(hostname, port, username, pkey_path)

            generator_outputs = ssh_client.script(params=input_params, remote_path=remote_path, command=command)
            yield generator_outputs

            ssh_client.close()


    test_hostname_list = ['52.82.7.121']
    test_port = 22
    test_username = 'ubuntu'
    test_pkey = '/home/python/Desktop/fastone-demo.pem'

    test_input_params = '/home/python/Desktop/cb-aws-vmtypes.json'
    test_remote_path = 'test.txt'
    test_command = 'cat test.txt'
    test_outputs_list = main(test_hostname_list,
                             test_port,
                             test_username,
                             test_pkey,
                             test_input_params,
                             test_remote_path,
                             test_command
                             )
    for outputs in test_outputs_list:
        for output in outputs:
            print('output : ', output)

这里不熟悉的朋友可以先把每个函数拆开实现,再抽象成类。
以上!

附带链接:
官方文档
python模块之 paramiko
Python模块学习 - Paramiko

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,417评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,921评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,850评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,945评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,069评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,188评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,239评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,994评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,409评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,735评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,898评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,578评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,205评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,916评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,156评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,722评论 2 363
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,781评论 2 351