Tcl

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. Tcl

load ./chilkat.dll

set success 0

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

set ssh [new_CkSsh]

# Connect to an SSH server:

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

set success [CkSsh_Connect $ssh $hostname $port]
if {$success != 1} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    exit
}

# Wait a max of 5 seconds when reading responses..
CkSsh_put_IdleTimeoutMs $ssh 5000

# Authenticate using login/password:
set success [CkSsh_AuthenticatePw $ssh "myLogin" "myPassword"]
if {$success != 1} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    exit
}

# Once the SSH object is connected and authenticated, we use it
# as the underlying transport in our SCP object.
set scp [new_CkScp]

set success [CkScp_UseSsh $scp $ssh]
if {$success != 1} then {
    puts [CkScp_lastErrorText $scp]
    delete_CkSsh $ssh
    delete_CkScp $scp
    exit
}

set content "This string will be the contents of the remote file."
set 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.
set 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.
set success [CkScp_UploadString $scp $remotePath $content $charset]
if {$success != 1} then {
    puts [CkScp_lastErrorText $scp]
    delete_CkSsh $ssh
    delete_CkScp $scp
    exit
}

set 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.
set 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.
set success [CkScp_UploadString $scp $remotePath $content $charset]
if {$success != 1} then {
    puts [CkScp_lastErrorText $scp]
    delete_CkSsh $ssh
    delete_CkScp $scp
    exit
}

puts "SCP upload string success."

# Disconnect
CkSsh_Disconnect $ssh

delete_CkSsh $ssh
delete_CkScp $scp