JavaScript

Send a Signal to a Remote SSH Process

Demonstrates the Chilkat Ssh.SendReqSignal method, which requests delivery of a signal to the remote process running on a channel. The first argument is the channel number and the second is the signal name. Send it after the process has started.

Background: This is the SSH equivalent of pressing Ctrl+C or running kill — it lets a client interrupt or terminate a long-running remote command without tearing down the connection. Signal names are given without the SIG prefix (INT, TERM, KILL, and so on). Note that some servers, including common OpenSSH builds, do not implement signal delivery.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

JavaScript

var success = false;

//  Demonstrates the Ssh.SendReqSignal method, which requests delivery of a signal to the remote
//  process running on a channel.  The 1st argument is the channel number and the 2nd is the
//  signal name.  Send it after the process has started.

var ssh = new CkSsh();

var sshPort = 22;
success = ssh.Connect("ssh.example.com",sshPort);
if (success == false) {
    console.log(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.
var password = "mySshPassword";

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

//  Open a session channel.  A negative return value indicates failure.
var channelNum = ssh.OpenSessionChannel();
if (channelNum < 0) {
    console.log(ssh.LastErrorText);
    return;
}

//  Start a long-running command.
success = ssh.SendReqExec(channelNum,"sleep 60");
if (success == false) {
    console.log(ssh.LastErrorText);
    return;
}

//  Send an interrupt signal to the remote process.  The name omits the "SIG" prefix.
success = ssh.SendReqSignal(channelNum,"INT");
if (success == false) {
    console.log(ssh.LastErrorText);
    return;
}

console.log("Signal sent.");

ssh.Disconnect();