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.

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

let ssh = chilkat::Ssh::new();

let ssh_port = 22;
if ssh.connect("ssh.example.com", ssh_port).is_err() {
    println!("{}", ssh.last_error_text());
    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.
let password = "mySshPassword".to_string();

if ssh.authenticate_pw("mySshLogin", &password).is_err() {
    println!("{}", ssh.last_error_text());
    return;
}

let channel_num = ssh.open_session_channel();
if channel_num < 0 {
    println!("{}", ssh.last_error_text());
    return;
}

if ssh.send_req_exec(channel_num, "grep -q root /etc/passwd").is_err() {
    println!("{}", ssh.last_error_text());
    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.set_read_timeout_ms(15000);

if ssh.channel_receive_to_close(channel_num).is_err() {
    println!("{}", ssh.last_error_text());
    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.channel_received_exit_status(channel_num) {
    let exit_status = ssh.get_channel_exit_status(channel_num);
    println!("Exit status: {}", exit_status);

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

}

ssh.disconnect();