(Node.js) SSH Parallel Remote Commands on Multiple Servers

See more SSH Examples

Shows how to execute a command in parallel on multiple servers.

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    // Executing a command on multiple servers simultaneously is straightforward.
    // It's just a matter of using one SSH object per server..
    var ssh1 = new chilkat.Ssh();
    var ssh2 = new chilkat.Ssh();
    var ssh3 = new chilkat.Ssh();

    var port = 22;
    var success = ssh1.Connect("ssh-server1.com",port);
    if (success !== true) {
        console.log(ssh1.LastErrorText);
        return;
    }

    // Authenticate using login/password:
    success = ssh1.AuthenticatePw("sshLogin1","sshPassword1");
    if (success !== true) {
        console.log(ssh1.LastErrorText);
        return;
    }

    // Connect and authenticate with 2 more servers.
    // For brevity, the success/failure won't be checked...
    success = ssh2.Connect("ssh-server2.com",port);
    success = ssh2.AuthenticatePw("sshLogin2","sshPassword2");
    success = ssh3.Connect("ssh-server3.com",port);
    success = ssh3.AuthenticatePw("sshLogin3","sshPassword3");

    // Note: If we wanted, we could've used ConnectAsync and AuthenticatePwAsync
    // to do the connecting and authenticating in parallel...

    // The command to be run on each SSH server will sleep for 5 seconds,
    // and then show the current system date/time.
    var cmd = "sleep 5; date";

    // Start each command
    var ssh1Channel = ssh1.QuickCmdSend(cmd);
    if (ssh1Channel < 0) {
        console.log(ssh1.LastErrorText);
        return;
    }

    // For brevity, we're not checking the return values here:
    var ssh2Channel = ssh2.QuickCmdSend(cmd);
    var ssh3Channel = ssh3.QuickCmdSend(cmd);

    // OK, at this point the command is running simultaneously on each server.

    // Now collect the results of each command.
    var pollTimeoutMs = 50;
    var numFinished = 0;
    var channel;
    // Note: You would rewrite this code to use arrays.
    var ssh1Finished = false;
    var ssh2Finished = false;
    var ssh3Finished = false;
    while (numFinished < 3) {
        // Check to see if anything has finished.
        // QuickCmdCheck returns -1 if there are no errors and nothing else finished
        // QuickCmdCheck returns -2 if there was an error (such as a lost connection)
        // QuickCmdCheck returns a channel number if a channel finished.
        if (ssh1Finished !== true) {
            channel = ssh1.QuickCmdCheck(pollTimeoutMs);
            if (channel == -2) {
                console.log(ssh1.LastErrorText);
                return;
            }

            if (channel == ssh1Channel) {
                console.log("---- ssh1 channel " + channel + " finished ----");
                console.log(ssh1.GetReceivedText(channel,"ansi"));
                numFinished = numFinished+1;
                ssh1Finished = true;
            }

        }

        if (ssh2Finished !== true) {
            channel = ssh2.QuickCmdCheck(pollTimeoutMs);
            if (channel == -2) {
                console.log(ssh2.LastErrorText);
                return;
            }

            if (channel == ssh2Channel) {
                console.log("---- ssh2 channel " + channel + " finished ----");
                console.log(ssh2.GetReceivedText(channel,"ansi"));
                numFinished = numFinished+1;
                ssh2Finished = true;
            }

        }

        if (ssh3Finished !== true) {
            channel = ssh3.QuickCmdCheck(pollTimeoutMs);
            if (channel == -2) {
                console.log(ssh3.LastErrorText);
                return;
            }

            if (channel == ssh3Channel) {
                console.log("---- ssh3 channel " + channel + " finished ----");
                console.log(ssh3.GetReceivedText(channel,"ansi"));
                numFinished = numFinished+1;
                ssh3Finished = true;
            }

        }

    }

    // --------------
    // Sample output:

    // 	---- ssh2 channel 101 finished ----
    // 	Fri Dec 23 00:25:48 UTC 2016
    // 
    // 	---- ssh3 channel 102 finished ----
    // 	Thu Dec 22 18:25:12 CST 2016
    // 
    // 	---- ssh1 channel 100 finished ----
    // 	Thu Dec 22 18:25:48 CST 2016

}

chilkatExample();