Lua

SFTP Simplified Download

See more SFTP Examples

Demonstrates how to SFTP download a file by passing a remote filepath to DownloadFileByName. Lua

local chilkat = require("chilkat")

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

local sftp = chilkat.SFtp.new()

-- Set some timeouts, in milliseconds:
sftp.connect_timeout_ms = 15000
sftp.idle_timeout_ms = 15000

-- Connect to the SSH server.
-- The standard SSH port = 22
-- The hostname may be a hostname or IP address.
local hostname = "sftp.example.com"
local port = 22
local success = sftp:connect(hostname, port)
if not success then
    print(sftp.last_error_text)
    return
end

-- 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:authenticate_pw("myLogin", "myPassword")
if not success then
    print(sftp.last_error_text)
    return
end

-- After authenticating, the SFTP subsystem must be initialized:
success = sftp:initialize_sftp()
if not success then
    print(sftp.last_error_text)
    return
end

-- Download the file:
local localFilePath = "c:/temp/hamlet.xml"
-- Note: The remote filepath may be an absolute filepath,
-- a relative filepath, or simply a filename.
-- Relative filepaths are always relative to the home directory
-- of the SFTP/SSH user account.  There is no such thing
-- as "current remote directory" in the SFTP protocol.
-- A filename with no path implies that the file is located
-- in the SFTP user account's home directory.
local remoteFilePath = "subdir1/subdir2/hamlet.xml"
success = sftp:download_file_by_name(remoteFilePath, localFilePath)
if not success then
    print(sftp.last_error_text)
    return
end

print("Success.")