PHP

Get Received SSH Text into a StringBuilder

Demonstrates the Chilkat Ssh.GetReceivedSb method, which decodes a channel's receive buffer and appends the text to a StringBuilder. The arguments are the channel number, the charset, and the StringBuilder. The receive buffer is cleared afterward.

Background: Because this appends rather than replaces, it is the natural choice for accumulating output across repeated reads — call it in a loop and the StringBuilder grows into the complete transcript. It also avoids creating a new string on every retrieval, which matters when a command produces a large amount of text.

Chilkat PHP Downloads

Download Chilkat for PHP

Chilkat2 PHP

<?php

use Chilkat2\Ssh;
use Chilkat2\StringBuilder;

// Demonstrates the Ssh.GetReceivedSb method, which decodes the channel's receive buffer and
// appends the text to a StringBuilder.  The 1st argument is the channel number, the 2nd is the
// charset, and the 3rd is the StringBuilder.  The receive buffer is cleared afterward.

$ssh = new Ssh();

$sshPort = 22;
try {
    $ssh->Connect('ssh.example.com', $sshPort);

    // Normally you would not hard-code the password in source.  You should instead obtain it
    // from an interactive prompt, environment variable, or a secrets vault.
    $password = 'mySshPassword';

    $ssh->AuthenticatePw('mySshLogin', $password);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

$channelNum = $ssh->OpenSessionChannel();
if ($channelNum < 0) {
    echo $ssh->LastErrorText, "\n";
    exit;
}

try {
    $ssh->SendReqExec($channelNum, 'ls -l /tmp');

    // IMPORTANT: Set a read timeout.  ReadTimeoutMs defaults to 0, which means no limit -- without
    // it, this call waits forever if the server never sends channel close.
    $ssh->ReadTimeoutMs = 15000;

    $ssh->ChannelReceiveToClose($channelNum);

    // Append the received text to a StringBuilder.  Existing content is preserved.
    $sb = new StringBuilder();
    $ssh->GetReceivedSb($channelNum, 'utf-8', $sb);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

echo 'Characters received: ', $sb->Length, "\n";
$output = $sb->GetAsString();
echo $output, "\n";

$ssh->Disconnect();