Lua

SCP Download Files Matching a Pattern, such as *.txt

See more SCP Examples

Demonstrates how to SCP download files matching a pattern, such as *.txt. 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:
local hostname = "MY-SSH-SERVER-DOMAIN-OR-IP"
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("MY-SSH-LOGIN", "MY-SSH-PASSWORD")
if not success then
    print(ssh.last_error_text)
    return
end

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

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

scp.heartbeat_ms = 200

-- Set the SyncMustMatch property to "*.pem" to download only .pem files
scp.sync_must_match = "*.pem"

local remoteDir = "qa_syncA"
local localDir = "c:/aaworkarea/scp/qa_syncA"

-- 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 = 0

-- Do not recurse the remote directory tree.  Only download files matching *.pem
-- from the given remote directory.
local bRecurse = false

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

print("SCP download matching success.")

-- Disconnect
ssh:disconnect()