Ruby

SCP Download Text File to String Variable

See more SCP Examples

Downloads a file using the SCP protocol (Secure Copy Protocol over SSH), from a specific remote directory located on the SSH server directly into a string variable. Ruby

require 'chilkat'

success = false

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

ssh = Chilkat::CkSsh.new()

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

# Connect to an SSH server:
success = ssh.Connect(hostname,port)
if (success != true)
    print ssh.lastErrorText() + "\n";
    exit
end

# Wait a max of 5 seconds when reading responses..
ssh.put_IdleTimeoutMs(5000)

# Authenticate using login/password:
success = ssh.AuthenticatePw("myLogin","myPassword")
if (success != true)
    print ssh.lastErrorText() + "\n";
    exit
end

# Once the SSH object is connected and authenticated, we use it
# in our SCP object.
scp = Chilkat::CkScp.new()

success = scp.UseSsh(ssh)
if (success != true)
    print scp.lastErrorText() + "\n";
    exit
end

# This downloads a file from the "repositor/xml/" subdirectory (relative to the SSH user account's HOME directory).  
remotePath = "repository/xml/hamlet.xml"

# The byte representation of the remote text file (i.e. the charset) must be
# indicated to allow the receiving software to correctly interpret the incoming
# bytes as the correct chars.
# See https://www.chilkatsoft.com/p/p_463.asp for a list of valid charset names.
charset = "utf-8"

fileContents = scp.downloadString(remotePath,charset)
if (scp.get_LastMethodSuccess() != true)
    print scp.lastErrorText() + "\n";
    exit
end

print "Received file:" + "\n";
print fileContents + "\n";

print "SCP download string success." + "\n";

# Disconnect
ssh.Disconnect()