PHP

Check Whether an SSH Exit Status Was Received

Demonstrates the Chilkat Ssh.ChannelReceivedExitStatus method, which reports whether the server supplied an exit-status value for a channel. The only argument is the channel number. When it returns true, call GetChannelExitStatus to read the value.

Background: Always test this before reading the exit status, because the server is not required to send one for every channel type or command — treating a missing status as "0" would silently turn a failure into a success. Exit status is independent of EOF and CLOSE: it can arrive after EOF and either before or together with CLOSE.

Chilkat PHP Downloads

Download Chilkat for PHP

Chilkat2 PHP

<?php

use Chilkat2\Ssh;

// Demonstrates the Ssh.ChannelReceivedExitStatus method, which reports whether the server
// supplied an exit-status value for a channel.  The only argument is the channel number.  When
// it returns true, call GetChannelExitStatus to read the value.

$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, 'test -f /etc/hosts');

    // 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);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// The server is not required to send an exit status for every channel type or command.
if ($ssh->ChannelReceivedExitStatus($channelNum)) {
    $exitStatus = $ssh->GetChannelExitStatus($channelNum);
    echo 'Exit status: ', $exitStatus, "\n";
} else {
    echo "The server did not provide an exit status.\n";
}

$ssh->Disconnect();