Tcl

SCP Download from a Specific Directory

See more SCP Examples

Demonstrates how to download a file using the SCP protocol (Secure Copy Protocol over SSH), from a specific remote directory located on the SSH server. The remote directory can be a path relative to the HOME directory of the SSH user account, or an absolute path on the remote filesystem. Obviously, in both cases the SSH user account must have permission to open and read the file in the specified directory. Tcl

load ./chilkat.dll

set success 0

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

set ssh [new_CkSsh]

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

# Connect to an SSH server:
set success [CkSsh_Connect $ssh $hostname $port]
if {$success != 1} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    exit
}

# Wait a max of 5 seconds when reading responses..
CkSsh_put_IdleTimeoutMs $ssh 5000

# Authenticate using login/password:
set success [CkSsh_AuthenticatePw $ssh "myLogin" "myPassword"]
if {$success != 1} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    exit
}

# Once the SSH object is connected and authenticated, we use it
# in our SCP object.
set scp [new_CkScp]

set success [CkScp_UseSsh $scp $ssh]
if {$success != 1} then {
    puts [CkScp_lastErrorText $scp]
    delete_CkSsh $ssh
    delete_CkScp $scp
    exit
}

# This downloads a file from the "testApp/logs/" subdirectory (relative to the SSH user account's HOME directory).  
# For example, if the HOME directory is /Users/chilkat, then the following downloads
# /Users/chilkat/testApp/logs/test1.log
set remotePath "testApp/logs/test1.log"
set localPath "c:/testApp/logs/test1.log"
set success [CkScp_DownloadFile $scp $remotePath $localPath]
if {$success != 1} then {
    puts [CkScp_lastErrorText $scp]
    delete_CkSsh $ssh
    delete_CkScp $scp
    exit
}

# The following call to DownloadFile specifies an absolute file path on the SSH server:
set remotePath "/Users/chilkat/Documents/gecko.jpg"
set localPath "c:/temp/images/gecko.jpg"
set success [CkScp_DownloadFile $scp $remotePath $localPath]
if {$success != 1} then {
    puts [CkScp_lastErrorText $scp]
    delete_CkSsh $ssh
    delete_CkScp $scp
    exit
}

puts "SCP download file success."

# Disconnect
CkSsh_Disconnect $ssh

delete_CkSsh $ssh
delete_CkScp $scp