Sample code for 30+ languages & platforms
Lianja

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.

Chilkat Lianja Downloads

Lianja
llSuccess = .F.

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

loSsh = createobject("CkSsh")

// Hostname may be an IP address or hostname:
lcHostname = "www.some-ssh-server.com"
lnPort = 22

// Connect to an SSH server:
llSuccess = loSsh.Connect(lcHostname,lnPort)
if (llSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

// Wait a max of 5 seconds when reading responses..
loSsh.IdleTimeoutMs = 5000

// Authenticate using login/password:
llSuccess = loSsh.AuthenticatePw("myLogin","myPassword")
if (llSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

// Once the SSH object is connected and authenticated, we use it
// in our SCP object.
loScp = createobject("CkScp")

llSuccess = loScp.UseSsh(loSsh)
if (llSuccess <> .T.) then
    ? loScp.LastErrorText
    release loSsh
    release loScp
    return
endif

// 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
lcRemotePath = "testApp/logs/test1.log"
lcLocalPath = "c:/testApp/logs/test1.log"
llSuccess = loScp.DownloadFile(lcRemotePath,lcLocalPath)
if (llSuccess <> .T.) then
    ? loScp.LastErrorText
    release loSsh
    release loScp
    return
endif

// The following call to DownloadFile specifies an absolute file path on the SSH server:
lcRemotePath = "/Users/chilkat/Documents/gecko.jpg"
lcLocalPath = "c:/temp/images/gecko.jpg"
llSuccess = loScp.DownloadFile(lcRemotePath,lcLocalPath)
if (llSuccess <> .T.) then
    ? loScp.LastErrorText
    release loSsh
    release loScp
    return
endif

? "SCP download file success."

// Disconnect
loSsh.Disconnect()


release loSsh
release loScp