Lua

SCP Sync Tree Download

See more SCP Examples

Synchronize local and remote directory trees by downloading newer or missing files from the remote server. Lua

local chilkat = require("chilkat")

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

local ssh = chilkat.Ssh.new()

-- Connect to an SSH server:

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

local success = ssh:connect(hostname, port)
if not success then
    print(ssh.last_error_text)
    return
end

-- Wait a max of 5 seconds when reading responses..
ssh.idle_timeout_ms = 5000

-- Authenticate using login/password:
success = ssh:authenticate_pw("myLogin", "myPassword")
if not success then
    print(ssh.last_error_text)
    return
end

-- Once the SSH object is connected and authenticated, we use it
-- in our SCP object.
local scp = chilkat.Scp.new()

success = scp:use_ssh(ssh)
if not success then
    print(scp.last_error_text)
    return
end

local remoteRoot = "workspace/php"
local localRoot = "c:/aaworkarea/scp/workspace/php"

-- Download synchronization modes:
-- mode=0: Download all files
-- mode=1: Download all files that do not exist on the local filesystem.
-- mode=2: Download newer or non-existant files.
-- mode=3: Download only newer files.
--         If a file does not already exist on the local filesystem, it is not downloaded from the server.
-- mode=5: Download only missing files or files with size differences.
-- mode=6: Same as mode 5, but also download newer files.
local mode = 2

-- Sync the entire tree by using recursion.
local bRecurse = true

success = scp:sync_tree_download(remoteRoot, localRoot, mode, bRecurse)
if not success then
    print(scp.last_error_text)
    return
end

print("SCP sync download success.")

-- Disconnect
ssh:disconnect()