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.

bool success = false;

//  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.

Chilkat.Ssh ssh = new Chilkat.Ssh();

int sshPort = 22;
success = ssh.Connect("ssh.example.com",sshPort);
if (success == false) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

//  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.
string password = "mySshPassword";

success = ssh.AuthenticatePw("mySshLogin",password);
if (success == false) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

int channelNum = ssh.OpenSessionChannel();
if (channelNum < 0) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

success = ssh.SendReqExec(channelNum,"grep -q root /etc/passwd");
if (success == false) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

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

success = ssh.ChannelReceiveToClose(channelNum);
if (success == false) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

//  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)) {
    int exitStatus = ssh.GetChannelExitStatus(channelNum);
    Debug.WriteLine("Exit status: " + Convert.ToString(exitStatus));

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

}

ssh.Disconnect();