Perl

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. Chilkat2 Perl

use strict;
use warnings;
use Chilkat2;

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

my $ssh = Chilkat2::Ssh->new;

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

# Connect to an SSH server:
my $success = $ssh->Connect($hostname, $port);
if (!$success) {
    print $ssh->LastErrorText, "\n";
    exit;
}

# Wait a max of 5 seconds when reading responses..
$ssh->IdleTimeoutMs(5000);

# Authenticate using login/password:
$success = $ssh->AuthenticatePw('myLogin', 'myPassword');
if (!$success) {
    print $ssh->LastErrorText, "\n";
    exit;
}

# Once the SSH object is connected and authenticated, we use it
# in our SCP object.
my $scp = Chilkat2::Scp->new;

$success = $scp->UseSsh($ssh);
if (!$success) {
    print $scp->LastErrorText, "\n";
    exit;
}

# This downloads a file from the "repositor/xml/" subdirectory (relative to the SSH user account's HOME directory).
my $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.
my $charset = 'utf-8';

my $fileContents = $scp->DownloadString($remotePath, $charset);
if (!$scp->LastMethodSuccess) {
    print $scp->LastErrorText, "\n";
    exit;
}

print "Received file:\n";
print $fileContents, "\n";

print "SCP download string success.\n";

# Disconnect
$ssh->Disconnect();