Get the Exit Status of a Remote SSH Command

See more SSH Examples

Demonstrates the Chilkat Ssh.GetChannelExitStatus method, which returns the remote process exit status for a channel. The only argument is the channel number. Call it only after ChannelReceivedExitStatus returns true.

<?php

use Chilkat2\Ssh;

// Demonstrates the Ssh.GetChannelExitStatus method, which returns the remote process exit
// status for a channel.  The only argument is the channel number.  Call it only after
// ChannelReceivedExitStatus returns true.

$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, 'grep -q root /etc/passwd');

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

// Retrieve the exit status immediately, before calling unrelated SSH methods or releasing the
// channel, because the completed channel record can be discarded.
if ($ssh->ChannelReceivedExitStatus($channelNum)) {
    $exitStatus = $ssh->GetChannelExitStatus($channelNum);
    echo 'Exit status: ', $exitStatus, "\n";

    // By convention, 0 means the remote command succeeded.
    if ($exitStatus == 0) {
        echo "The remote command succeeded.\n";
    } else {
        echo "The remote command reported a failure.\n";
    }
}

$ssh->Disconnect();