(Ruby) SFTP Upload with Bandwidth Throttling

Demonstrates how to upload a file to an SSH server in the simplest way with bandwidth throttling. Bandwidth throttling for all SFTP communications can be achieved by simply setting the BandwidthThrottleUp or BandwidthThrottleDown properties. (One limits the transfer rate for uploads, the other for downloads.)

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

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

sftp = Chilkat::CkSFtp.new()

# Set some timeouts, in milliseconds:
sftp.put_ConnectTimeoutMs(15000)
sftp.put_IdleTimeoutMs(15000)

# Connect to the SSH server.  
# The standard SSH port = 22
# The hostname may be a hostname or IP address.
hostname = "sftp.example.com"
port = 22
success = sftp.Connect(hostname,port)
if (success != true)
    print sftp.lastErrorText() + "\n";
    exit
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.AuthenticatePw("myLogin","myPassword")
if (success != true)
    print sftp.lastErrorText() + "\n";
    exit
end

# After authenticating, the SFTP subsystem must be initialized:
success = sftp.InitializeSftp()
if (success != true)
    print sftp.lastErrorText() + "\n";
    exit
end

# Limit the transfer rate (bandwidth throttle) to 64K per second.
sftp.put_BandwidthThrottleUp(65536)

# Upload from the local file to the SSH server.
# Important -- the remote filepath is the 1st argument,
# the local filepath is the 2nd argument;
remoteFilePath = "hamlet.xml"
localFilePath = "c:/temp/hamlet.xml"

success = sftp.UploadFileByName(remoteFilePath,localFilePath)
if (success != true)
    print sftp.lastErrorText() + "\n";
    exit
end

print "Success." + "\n";