PHP Extension

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 Extension Downloads

Download Chilkat for PHP Extension

PHP Extension

<?php

include("chilkat.php");

$success = false;

//  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 CkSsh();

$sshPort = 22;
$success = $ssh->Connect('ssh.example.com',$sshPort);
if ($success == false) {
    print $ssh->lastErrorText() . "\n";
    exit;
}

//  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';

$success = $ssh->AuthenticatePw('mySshLogin',$password);
if ($success == false) {
    print $ssh->lastErrorText() . "\n";
    exit;
}

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

$success = $ssh->SendReqExec($channelNum,'test -f /etc/hosts');
if ($success == false) {
    print $ssh->lastErrorText() . "\n";
    exit;
}

//  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->put_ReadTimeoutMs(15000);

$success = $ssh->ChannelReceiveToClose($channelNum);
if ($success == false) {
    print $ssh->lastErrorText() . "\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);
    print 'Exit status: ' . $exitStatus . "\n";
}
else {
    print 'The server did not provide an exit status.' . "\n";
}

$ssh->Disconnect();

?>