Run a Command on an SSH Session Channel

See more SSH Examples

Demonstrates the Chilkat Ssh.SendReqExec method, which requests execution of a command on a session channel. The first argument is the channel number and the second is the command line. This example runs a command, reads the output until the channel closes, and prints it.

// Demonstrates the Ssh.SendReqExec method, which requests execution of a command on a session
// channel.  The 1st argument is the channel number and the 2nd is the command line.

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

// Open a session channel.  A negative return value indicates failure.
let channel_num = ssh.open_session_channel();
if channel_num < 0 {
    println!("{}", ssh.last_error_text());
    return;
}

// Request execution of a command.  A true return means the server accepted the request; it
// does not mean the command itself succeeded.
if ssh.send_req_exec(channel_num, "ls -l /tmp").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);

// Read the command output until the server closes the channel.
if ssh.channel_receive_to_close(channel_num).is_err() {
    println!("{}", ssh.last_error_text());
    return;
}

let Ok(output) = ssh.get_received_text(channel_num, "utf-8") else {
    println!("{}", ssh.last_error_text());
    return;
};

println!("{}", output);

ssh.disconnect();