(Perl) SSH Exec (Execute Command Line)

Shows how to execute a command on an SSH server and retrieve the command output.

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

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

$ssh = chilkat::CkSsh->new();

# Connect to an SSH server:

# Hostname may be an IP address or hostname:
$hostname = "192.168.1.108";
$port = 22;

$success = $ssh->Connect($hostname,$port);
if ($success != 1) {
    print $ssh->lastErrorText() . "\r\n";
    exit;
}

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

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

# Open a session channel.  (It is possible to have multiple
# session channels open simultaneously.)

$channelNum = $ssh->OpenSessionChannel();
if ($channelNum < 0) {
    print $ssh->lastErrorText() . "\r\n";
    exit;
}

# The SendReqExec method starts a command on the remote
# server.   The syntax of the command string depends on the
# default shell used on the remote server to run the command.
# On Windows systems it is CMD.EXE.  On UNIX/Linux
# systems the user's default shell is typically defined in /etc/password.

# Here are some examples of command lines for <b>Windows SSH servers</b>:

# Get a directory listing:
$cmd1 = "dir";

# Do a nameserver lookup:
$cmd2 = "nslookup chilkatsoft.com";

# List a specific directory.  Given that the shell is CMD.EXE, backslashes must
# be used:
$cmd3 = "dir \\temp";

# Execute a sequence of commands.  The syntax for CMD.EXE may be found
# here: http://technet.microsoft.com/en-us/library/bb490880.aspx.  Notice how the commands
# are separated by "&&" and the entire command must be enclosed in quotes:
$cmd4 = "\"cd \\temp&&dir\"";

# Here are two examples of command lines for <b>Linux/UNIX SSH servers</b>:

# Get a directory listing:
$cmd5 = "ls -l /tmp";

# Run a series of commands (syntax may depend on your default shell):
$cmd6 = "cd /etc; ls -la";

# Request a directory listing on the remote server:
# If your server is Windows, change the string from "ls" to "dir"
$success = $ssh->SendReqExec($channelNum,"ls");
if ($success != 1) {
    print $ssh->lastErrorText() . "\r\n";
    exit;
}

# Call ChannelReceiveToClose to read 
# output until the server's corresponding "channel close" is received.
$success = $ssh->ChannelReceiveToClose($channelNum);
if ($success != 1) {
    print $ssh->lastErrorText() . "\r\n";
    exit;
}

# Let's pickup the accumulated output of the command:
$cmdOutput = $ssh->getReceivedText($channelNum,"ansi");
if ($ssh->get_LastMethodSuccess() != 1) {
    print $ssh->lastErrorText() . "\r\n";
    exit;
}

# Display the remote shell's command output:
print $cmdOutput . "\r\n";

# Disconnect
$ssh->Disconnect();