Node.js

SSH Exec (Execute Command Line)

See more SSH Examples

Shows how to execute a command on an SSH server and retrieve the command output. Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

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

    var ssh = new chilkat.Ssh();

    //  Connect to an SSH server:
    var hostname;
    var port;

    //  Hostname may be an IP address or hostname:
    hostname = "192.168.1.108";
    port = 22;

    success = ssh.Connect(hostname,port);
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    //  Wait a max of 5 seconds when reading responses..
    ssh.IdleTimeoutMs = 5000;

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

    //  Open a session channel.  (It is possible to have multiple
    //  session channels open simultaneously.)
    var channelNum;
    channelNum = ssh.OpenSessionChannel();
    if (channelNum < 0) {
        console.log(ssh.LastErrorText);
        return;
    }

    //  The SendReqExec method starts a command on the remote
    //  server.   The syntax of the command string depends on the
    //  default shell used on the remote server to run the command.
    //  On Windows systems it is CMD.EXE.  On UNIX/Linux
    //  systems the user's default shell is typically defined in /etc/password.

    //  Here are some examples of command lines for <b>Windows SSH servers</b>:

    //  Get a directory listing:
    var cmd1 = "dir";

    //  Do a nameserver lookup:
    var cmd2 = "nslookup chilkatsoft.com";

    //  List a specific directory.  Given that the shell is CMD.EXE, backslashes must
    //  be used:
    var cmd3 = "dir \\temp";

    //  Execute a sequence of commands.  The syntax for CMD.EXE may be found
    //  here: http://technet.microsoft.com/en-us/library/bb490880.aspx.  Notice how the commands
    //  are separated by "&&" and the entire command must be enclosed in quotes:
    var cmd4 = "\"cd \\temp&&dir\"";

    //  Here are two examples of command lines for <b>Linux/UNIX SSH servers</b>:

    //  Get a directory listing:
    var cmd5 = "ls -l /tmp";

    //  Run a series of commands (syntax may depend on your default shell):
    var cmd6 = "cd /etc; ls -la";

    //  Request a directory listing on the remote server:
    //  If your server is Windows, change the string from "ls" to "dir";
    success = ssh.SendReqExec(channelNum,"ls");
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    //  Call ChannelReceiveToClose to read 
    //  output until the server's corresponding "channel close" is received.
    success = ssh.ChannelReceiveToClose(channelNum);
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    //  Let's pickup the accumulated output of the command:
    var cmdOutput = ssh.GetReceivedText(channelNum,"ansi");
    if (ssh.LastMethodSuccess !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    //  Display the remote shell's command output:
    console.log(cmdOutput);

    //  Disconnect
    ssh.Disconnect();

}

chilkatExample();