Node.js

SSH to Cisco Switch - Processing "More" Responses

See more SSH Examples

Demonstrates connecting to a Cisco switch, running a command to enable privileged mode, then running a command to get a paged response requiring the SPACE char to be sent to process "--More--". 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();

    success = ssh.Connect("SSH_SERVER_DOMAIN_OR_IP_ADDRESS",22);
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

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

    //  Start a shell session.
    var channelNum = ssh.QuickShell();
    if (channelNum < 0) {
        console.log(ssh.LastErrorText);
        return;
    }

    //  If the CISCO switch returns a prompt with ">", then read until we get the prompt.
    //  (It's not actually required that we do this, but it helps to know that all is OK at this point..)
    success = ssh.ChannelReceiveUntilMatch(channelNum,">","utf-8",true);
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    //  Show what we received so far:
    console.log(ssh.GetReceivedText(channelNum,"utf-8"));

    //  Send the "ena" command to enable privileged mode.
    //  (For the Cisco switch, terminate command with a single CR char.)
    success = ssh.ChannelSendString(channelNum,"ena\r","utf-8");
    //  Assume success for this example to make it shorter..

    //  Read to the "Password:" prompt.
    success = ssh.ChannelReceiveUntilMatch(channelNum,"Password:","utf-8",true);
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    //  Show what we received...
    console.log(ssh.GetReceivedText(channelNum,"utf-8"));

    //  Send the password.
    success = ssh.ChannelSendString(channelNum,"MY_PASSWORD_FOR_ELEVATED_PRIVILEGE\r","utf-8");

    //  The prompt now changes from "Something>" to "Something#>
    //  Read until the new prompt..
    success = ssh.ChannelReceiveUntilMatch(channelNum,"#","utf-8",true);
    if (success !== true) {
        console.log(ssh.LastErrorText);
        return;
    }

    //  Show what we received...
    console.log(ssh.GetReceivedText(channelNum,"utf-8"));

    //  Send the "show running-config" command.
    //  The response will be in multiple pages, each ending with "--More--" and requiring a SPACE bar to be sent
    //  to get the next page.
    success = ssh.ChannelSendString(channelNum,"show running-config\r","utf-8");

    //  Consume the response until we end with another prompt.
    var saMatch = new chilkat.StringArray();
    //  Change "YOUR_PROMPT" to your actual prompt.  We don't want to check for only "#" because
    //  it's not specific enough.  The data in the response could contain the "#" char...
    saMatch.Append("YOUR_PROMPT#");
    saMatch.Append("--More--");

    var sbReceived = new chilkat.StringBuilder();
    var moreComing = true;
    while ((moreComing == true)) {

        success = ssh.ChannelReceiveUntilMatchN(channelNum,saMatch,"utf-8",true);
        if (success !== true) {
            console.log(ssh.LastErrorText);
            return;
        }

        moreComing = false;

        sbReceived.Clear();
        sbReceived.Append(ssh.GetReceivedText(channelNum,"utf-8"));

        console.log(sbReceived.GetAsString());

        if (sbReceived.Contains("--More--",true) == true) {
            moreComing = true;

            //  Send a SPACE char just as if we were interactively pressing the SPACE key to get more output.
            success = ssh.ChannelSendString(channelNum," ","utf-8");
        }

    }

    ssh.Disconnect();

}

chilkatExample();