Lua

SCP Upload Contents of String to Remote File

See more SCP Examples

Demonstrates how to upload the contents of a string variable using the SCP protocol (Secure Copy Protocol over SSH). The text is uploaded to a file in specific remote directory. If the file did not already exist, it is created. If it already existed, it is overwritten. 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
-- as the underlying transport 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 content = "This string will be the contents of the remote file."
local remotePath = "uploads/text/testUtf8.txt"

-- The utf-8 byte representation of the string will be uploaded.
-- See https://www.chilkatsoft.com/p/p_463.asp for a list of valid charsets.
local charset = "utf-8"

-- This uploads to the "uploads/text" directory relative to the HOME
-- directory of the SSH user account.
-- Note: The remote target directory must already exist on the SSH server.
success = scp:upload_string(remotePath, content, charset)
if not success then
    print(scp.last_error_text)
    return
end

remotePath = "uploads/text/testUtf8_withBOM.txt"

-- To include the utf-8 preamble (also known as the BOM),
-- prefix the charset name with "bom:".  Any charset that can
-- optionally include a BOM can be specified in this way.
charset = "bom:utf-8"

-- Uploads to a remote file that contains text in the
-- utf-8 representation, including the BOM at the start of the file.
success = scp:upload_string(remotePath, content, charset)
if not success then
    print(scp.last_error_text)
    return
end

print("SCP upload string success.")

-- Disconnect
ssh:disconnect()