系統工程師神器！如何讓Python在Linux上執行ssh（二）Python Paramiko程式運行@Sunny的工程師日記

        近期因為專案的關係，必須同步更新多台Linux設備的程式，但每次要更新3台以上設備就會讓我頭很痛，所以花了一些時間找辦法讓我更新的步驟能夠更快速更簡單。因此我使用了Python Paramiko套件來實現ssh及sftp的工作，實現佈建環境自動化的功能。

系統需求：
  1. Linux。
  2. Python 3.X版本。
  3. Python pip。
  4. Paramiko套件。
程式碼：
1.ssh操作。
#!/usr/bin/python
# coding:utf-8
import paramiko
import configparser


def readini():
    print("hello!")


try:
    config = configparser.ConfigParser()
    config.read('upload.ini')
    address = config.get('REMOTE', 'ipaddress')
    port = config.get('REMOTE', 'port')
    username = config.get('REMOTE', 'username')
    userpwd = config.get('REMOTE', 'password')
    suserpwd = config.get('REMOTE', 'sudo_password')
    command = config.get('REMOTE', 'command')
except Exception as e:
    print('\033[91m<<< Read configuration FAIL! >>>\033[0m', e)

print('IMPORT INI SUCCESS.')
# readini()
port = 22
ssh = paramiko.SSHClient()
ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
ssh.connect(str(address), int(port), str(username), str(userpwd))

stdin, stdout, stderr = ssh.exec_command(command)
print(stdout.readlines())
print("指令完成！")

ssh.close()

# stdin, stdout, stderr = ssh.exec_command("echo moxa|sudo -S whoami")

2.ssh INI文件，將某些常更換的參數以INI文件方式儲存。
[REMOTE]
ipaddress = 192.168.1.90
port = 22
username = 1234
password = 1234
sudo_password = 1234
command = ls

3.sftp操作。
#!/usr/bin/python
# coding=utf-8

import paramiko
import os
import configparser
import datetime


def ssh_chmod(host, port, username, password, remote_dir, dirpathmod, sudo_password):
    '''
    Change the permission of remote host's upload folder.

    @ param host:  Remote host's IP.
    @ param port:  Remote host's port for sftp
    @ param username:  Remote host's login username for ssh.
    @ param password:  Remote host's login password for ssh.
    @ param remote:  Remote host upload folder.
    @ param dirpathmod:  The permission of remote path.
    '''
    paramiko.util.log_to_file('ssh.log')

    ssh = paramiko.SSHClient()
    # Allow connections to hosts that are not in the know_hosts.
    ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
    try:
        ssh.connect(hostname=host, port=port,
                    username=username, password=password)
        print('\033[32m<<< Connected to %s >>>\033[0m' % host)
        '''
        The -S flag tells sudu to expect the password to come from stdin
        The -p '' flag tells sudo to use '' or the empty string as the prompt
        for the password.
        The permission in Linux is a octal number, but in ini file is decimal.
        So use %o to transform decimal to octal.
        '''
        stdin, stdout, stderr = ssh.exec_command(
            "sudo -S -p '' chmod %o %s" % (dirpathmod, remote_dir))
        # Enter the sudo password
        stdin.write(sudo_password + '\n')
        stdin.flush()
    except Exception as e:
        print('\033[91m<<< CONNECT %s EXCEPTION!! >>>\033[0m %s ' % (host, e))
        print()
        return host
    ssh.close()
    return 1


def sftp_upload(host, port, username, password, local_dir, remote_dir, filesmod):
    '''
    Upload local host's file and folder to remote host by sftp

    @ param host:  Remote host's IP.
    @ param port:  Remote host's port for sftp
    @ param username:  Remote host's login username for ssh.
    @ param password:  Remote host's login password for ssh.
    @ param local:  Local host upload folder.
    @ param remote:  Remote host upload folder.
    @ param filesmod:  The permission of upload files.
    '''
    paramiko.util.log_to_file('sftp.log')

    try:
        '''
        Create a new SSH session over an existing socket, or socket-like
        object. This only creates the Transport object; it doesn’t begin the
        SSH session yet.
        '''
        t = paramiko.Transport((host, port))
        '''
        Negotiate an SSH2 session, and optionally verify the server’s host
        key and authenticate using a password or private key
        '''
        t.connect(username=username, password=password)
        # Create an SFTP client channel from an open Transport.
        sftp = paramiko.SFTPClient.from_transport(t)
        print('\033[44m === UPLOAD FILE TO %s START AT %s === \033[0m' %
              (host, datetime.datetime.now().strftime('%H:%M:%S')))

        for root, dirs, files in os.walk(local_dir):
            '''
            os.walk will generate the file names in a directory tree by walking
            the tree. For each directory in the tree rooted at directory top
            (including top itself), it yields a 3-tuple (root, dirs, files).

            root:  The path to the directory.
            dirs:  The names of the subdirectories in dirpath (excluding
                  '.' and '..').
            file:  The names of the non-directory files in dirpath

            For example, if you want upload all files and floders in root to
            /html/ in remote host.
            root/(local)
             ├──home/
             │   └──note.txt
             ├──Pictures/
             ├──Music/
             │   └──hello.txt
             └──world.txt
            '''

            for filespath in files:
                '''
                Combine the path(root) with the file name(files) under the root
                become the file path.
                ex: /root/home/ + note.txt => /root/home/note.txt
                '''
                local_file_path = os.path.join(
                    root, filespath).replace("\\", "/")

                '''
                Delete the string of local(param) in the file path(local_file).
                ex: if local is /root/, /root/home/note.txt => home/note.txt
                '''
                local_file = local_file_path.replace(local_dir, '')

                '''
                Combine the remote host path(remote) with local_file become
                remote file path.
                ex: /html/ + home/note.txt => /www/home/note.txt
                '''
                remote_file = os.path.join(remote_dir, local_file)

                try:
                    sftp.put(local_file_path, remote_file)
                except Exception as e:
                    '''
                    An exception will be generated if the remote folder does
                    not exist. os.path.split will split the path(remote_file)
                    into (path, file). And use path to create the folder.
                    ex: /html/home/note.txt => ('/html/home/', 'note.txt')
                    '''
                    sftp.mkdir(os.path.split(remote_file)[0])
                    sftp.put(local_file_path, remote_file)
                # sftp.chmod's 2rd parma need provide decimal Linux permission.
                sftp.chmod(remote_file, filesmod)
                print("upload %s to remote %s" %
                      (local_file_path, remote_file))

            for name in dirs:
                '''
                If the local folder is empty, the above loop will not create an
                empty folder at the remote. This loop will do this.
                '''
                local_path = os.path.join(root, name)
                a = local_path.replace(local_dir, '')
                remote_path = os.path.join(remote_dir, a)
                try:
                    sftp.mkdir(remote_path)
                    print("mkdir path %s" % remote_path)
                except Exception as e:
                    # The exception will raise if the folder already exists.
                    pass

        print('\033[44m === UPLOAD FILE TO %s FINISH AT %s === \033[0m' %
              (host, datetime.datetime.now().strftime('%H:%M:%S')))
        print()
        t.close()
        return 1

    except Exception as e:
        print()
        print('\033[91m<<< UPLOAD %s EXCEPTION!! >>>\033[0m %s' % (host, e))
        print()
        return host


def print_info(msg):
    print('\033[93m****************************************\033[0m')
    print('\033[93m*{:^38}*\033[0m'.format(msg))
    print('\033[93m****************************************\033[0m')


if __name__ == '__main__':
    # Read configuration from upload.ini
    try:
        config = configparser.ConfigParser()
        config.read('upload.ini')
        address_list = config.get(
            'REMOTE', 'ipaddress').replace(' ', '').split(',')
        port = int(config.get('REMOTE', 'port'))
        username = config.get('REMOTE', 'username')
        password = config.get('REMOTE', 'password')
        local_dir = config.get('LOCAL', 'dirpath')
        remote_dir = config.get('REMOTE', 'dirpath')
        dirpathmod = int(config.get('REMOTE', 'dirpathmod'))
        filesmod = int(config.get('REMOTE', 'filesmod'))
        sudo_password = config.get('REMOTE', 'sudo_password')
    except Exception as e:
        print('\033[91m<<< Read configuration FAIL! >>>\033[0m', e)
    print()
    print_info('IMPORT INI SUCCESS.')

    # Verify configuration information
    print('Read IP address list from INI file:', address_list)
    print('Read SSH port from INI file:', port)
    print('Read username from INI file:', username)
    print('Read password from INI file:', password)
    verify = input('Do you want to start uploading files? (YES/no)')

    if verify == 'no':
        print_info('Byebye!')
    else:
        print()
        print_info('START UPLOAD OPERATION.')
        conn_err = [] # connect fail host list
        upload_err = [] # upload fail host list
        for address in address_list:
            conn_res = ssh_chmod(address, port, username, password,
                                 remote_dir, dirpathmod, sudo_password)
            if conn_res == 1:
                upload_res = sftp_upload(address, port, username, password,
                                         local_dir, remote_dir, filesmod)
                if upload_res != 1:
                    upload_err.append(upload_res)
            else:
                conn_err.append(conn_res)
        print_info('ALL UPLOAD SUCCESS.')
        print()

        if len(conn_err) != 0:
            print('\033[91m<<< CONNECT FAIL HOST LIST >>>\033[0m')
            print(conn_err)
            print()
        if len(upload_err) != 0:
            print('\033[91m<<< UPLOAD FAIL HOST LIST >>>\033[0m')
            print(upload_err)

4.sftp INI文件，將某些常更換的參數以INI文件方式儲存。
[REMOTE]
ipaddress = 192.168.1.100, 192.168.1.187
port = 22
username = 1234
password = 1234
filename = /home/moxa/smb.conf
; The permission dirpath.
; chmod need enter a decimal
; 755(octal) -> 493(decimal)
; 777(octal) -> 511(decimal)
filesmod = 420
userid=root
usergroup=root

[LOCAL]
filename = ./smb.conf

5.執行程式。
python3 ssh.py
python3 sftp.py

以上為Paramiko程式碼及如何執行，下一篇會提到如何將寫好的python程式碼編譯成可攜帶的執行檔。


以上如有任何問題，歡迎留言與我討論。

留言

張貼留言

這個網誌中的熱門文章

C# Textbox 輸入限制數字及一個小數點@Sunny的工程師日記

在開發程式的時候，常常會有某些情況是限制輸入的內容，例如我現在要一組浮點數的內容，但是操作者往往不會依照著程式設計師的想法走，或許他會多加一個小數點，或許會加入奇怪的標點符號，這就會照成程式的轉換型別時出現問題，所以要避免這種狀況，就必須要讓使用者輸入內容時作出限制。 範例： 輸入一個小數點。 數字範圍0~9。 不能夠出現奇怪的標點符號 解決方式： 要如何判斷0~9的數字區間呢？最快的做法就是判斷使用者所輸入的鍵盤對應的數字是否落在0~9之間，到這邊還不要太開心，因為電腦判斷0~9的阿拉伯數字是必須經過換算才會得到這個結果，所以這邊必須去對照ASCII Code。阿拉伯數字0~9分別對應ASCII Code DEC 48~57。 此時Textbox就可以有效的判斷輸入的內容是否為阿拉伯數字0~9區間，但為了輸入方便，必須將Enter 及delete按鍵也加入到判斷，這樣子輸入上會變得非常方便。 以下是程式碼的，可以自行參考。 //限制輸入的內容必須為數字 private void tb_KeyPress_limite_KeyPress(object sender, KeyPressEventArgs e) { //限定輸入的內容僅能有一個小數點 if (e.KeyChar == '.') { foreach (char i in (sender as TextBox).Text)//判定textBox1是否有小數點 { if (i == '.') e.Handled = true;//有 } return; } // e.KeyChar == (Char)48 ~ 57 -----> 0~9 // e.KeyChar == (Char)8 -----------> Backpace // e.KeyChar == (Char)13-----------> Enter if (e.KeyChar == (Char)48 || e.KeyChar == (Char...
閱讀完整內容

系統工程師神器！如何讓Python在Linux上執行ssh（三）pyinstaller環境建置@Sunny的工程師日記

        近期因為專案的關係，必須同步更新多台Linux設備的程式，但每次要更新3台以上設備就會讓我頭很痛，所以花了一些時間找辦法讓我更新的步驟能夠更快速更簡單。因此我使用了Python Paramiko套件來實現ssh及sftp的工作，實現佈建環境自動化的功能。         上一篇講完如何使用Python來實現ssh及sftp等工具，這一篇來講述如何將撰寫完成的Python程式碼轉為.exe執行檔或是Linux執行檔，實現任何設備都可以執行的動作。 系統需求： Linux。 Python 3.X版本。 Python pip。 Pyinstaller套件。 建置方式： 1.更新Python的pip到最新的版本。 python3 -m pip install --upgrade pip 2.安裝pyinstaller套件。 pip3 install pyinstaller 3.完成安裝後，建立HelloWorld.py。 vi HelloWorld.py 4.撰寫程式碼。 print('hello world') 5.將HelloWorld.py編譯成一個執行檔。 pyinstaller -f HelloWorld.py 6.進入dist資料夾執行程式。 cd dist/ ./HelloWorld 以上為安裝步驟Pyinstaller的安裝及操作，下一篇會提到如何將上一篇所提到的ssh及sftp工具編譯成執行檔並實際運用。 以上如有任何問題，歡迎留言與我討論。
閱讀完整內容

C# M2MQTT 斷線重連@Sunny的工程師日記

最近因為專案的需求，需要做出一個連續24小時365天運作的監看系統，為了確保通訊能夠不中斷就必須做到MQTT斷線重連，避免訊息漏接。 需求： 建立MQTT連線。 MQTT發送訊息。 MQTT接收訊息。 建置方式： 引用M2MQTT Library。 建立MQTT連線。 建立MQTT發送訊息Function。 建立MQTT接收訊息Function。 建立MQTT斷線Function。 以下是我的程式碼，請自行參考。 using uPLibrary.Networking.M2Mqtt; using uPLibrary.Networking.M2Mqtt.Exceptions; using uPLibrary.Networking.M2Mqtt.Messages; public static MqttClient client;//MqttClient string ls_Ip = "127.0.0.1";//Broker IP static void ConnectionClosed(object sender, EventArgs e) { //MQTT斷線的事件,將中斷連線時需要做的事情放在這邊 } public void Client_MqttMsgPublishReceived(object sender, MqttMsgPublishEventArgs e) { //MQTT接收的事件 } static void MqttMsgSubscribed(object sender, MqttMsgSubscribedEventArgs e) { //MQTT訂閱的事件 } public void mqttconnect() { try { client = new MqttClient(ls_Ip);//MQTTServer在本機 client.MqttMsgPublishReceived += Client_MqttMsgPublishReceived;//當接收到訊息時會啟動 client.MqttMsgSubscribed += MqttMsgSubscribed;//當Topic訂閱成功時會...
閱讀完整內容