Chilkat2-Python

SFTP Download to Local Filesystem

See more SFTP Examples

Demonstrates how to download a file from an SSH server to the local filesystem. There are no limitations on file size, and the file is streamed directly to the local filesystem. Chilkat2-Python

import sys
import chilkat2

success = False

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

sftp = chilkat2.SFtp()

# Set some timeouts, in milliseconds:
sftp.ConnectTimeoutMs = 5000
sftp.IdleTimeoutMs = 10000

# Connect to the SSH server.  
# The standard SSH port = 22
# The hostname may be a hostname or IP address.
hostname = "sftp.example.com"
port = 22
success = sftp.Connect(hostname,port)
if (success != True):
    print(sftp.LastErrorText)
    sys.exit()

# Authenticate with the SSH server.  Chilkat SFTP supports
# both password-based authenication as well as public-key
# authentication.  This example uses password authenication.
success = sftp.AuthenticatePw("myLogin","myPassword")
if (success != True):
    print(sftp.LastErrorText)
    sys.exit()

# After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp()
if (success != True):
    print(sftp.LastErrorText)
    sys.exit()

# Open a file on the server:
handle = sftp.OpenFile("hamlet.xml","readOnly","openExisting")
if (sftp.LastMethodSuccess != True):
    print(sftp.LastErrorText)
    sys.exit()

# Download the file:
success = sftp.DownloadFile(handle,"c:/temp/hamlet.xml")
if (success != True):
    print(sftp.LastErrorText)
    sys.exit()

# Close the file.
success = sftp.CloseHandle(handle)
if (success != True):
    print(sftp.LastErrorText)
    sys.exit()

print("Success.")