Chilkat2-Python

SCP Sync Tree Upload

See more SCP Examples

Synchronize local and remote directory trees by uploading newer or missing files to the remote server. Chilkat2-Python

import sys
import chilkat2

success = False

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

ssh = chilkat2.Ssh()

# Hostname may be an IP address or hostname:
hostname = "www.some-ssh-server.com"
port = 22

# Connect to an SSH server:
success = ssh.Connect(hostname,port)
if (success != True):
    print(ssh.LastErrorText)
    sys.exit()

# Wait a max of 5 seconds when reading responses..
ssh.IdleTimeoutMs = 5000

# Authenticate using login/password:
success = ssh.AuthenticatePw("myLogin","myPassword")
if (success != True):
    print(ssh.LastErrorText)
    sys.exit()

# Once the SSH object is connected and authenticated, we use it
# in our SCP object.
scp = chilkat2.Scp()

success = scp.UseSsh(ssh)
if (success != True):
    print(scp.LastErrorText)
    sys.exit()

# The remoteRoot is relative to the HOME directory of the SSH user account.
remoteRoot = "workspace/projectB"
localRoot = "c:/aaworkarea/scp/workspace/projectB"

# Upload synchronization modes:
# mode=0: Upload all files
# mode=1: Upload all files that do not exist on the FTP server.
# mode=2: Upload newer or non-existant files.
# mode=3: Upload only newer files.  If a file does not already exist on the FTP server, it is not uploaded.
# mode=4: transfer missing files or files with size differences.
# mode=5: same as mode 4, but also newer files.

# Additional files and directores can be excluded by setting the SyncMustNotMatch property.
# The SyncMustNotMatch patterns apply only to the final filename or directory part of a path.
# If a directory matches, then it will not be traversed in a recursive traversal.
# 
scp.SyncMustNotMatch = "*.o;*.obj;*.log; temp"

# The SyncMustMatch property can be set to restrict the files uploaded to only those
# matching at least one pattern in a set.
scp.SyncMustMatch = "*.cpp; *.h"

# Do the recursive sync to upload newer or non-existant files:
bRecurse = True
mode = 2
success = scp.SyncTreeUpload(localRoot,remoteRoot,mode,bRecurse)
if (success != True):
    print(scp.LastErrorText)
    sys.exit()

# The files actually uploaded can be examined in the SyncedFiles property.
# It is a string property that contains the relative path, one per line, of each
# file uploaded.
print("Files uploaded: ")
print(scp.SyncedFiles)

print("----")
print("SCP sync upload success.")

# Disconnect
ssh.Disconnect()