Ruby

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--". Ruby

require 'chilkat'

success = false

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

ssh = Chilkat::CkSsh.new()

success = ssh.Connect("SSH_SERVER_DOMAIN_OR_IP_ADDRESS",22)
if (success != true)
    print ssh.lastErrorText() + "\n";
    exit
end

# Authenticate using login/password:
success = ssh.AuthenticatePw("myLogin","myPassword")
if (success != true)
    print ssh.lastErrorText() + "\n";
    exit
end

# Start a shell session.
channelNum = ssh.QuickShell()
if (channelNum < 0)
    print ssh.lastErrorText() + "\n";
    exit
end

# 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)
    print ssh.lastErrorText() + "\n";
    exit
end

# Show what we received so far:
print ssh.getReceivedText(channelNum,"utf-8") + "\n";

# 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)
    print ssh.lastErrorText() + "\n";
    exit
end

# Show what we received...
print ssh.getReceivedText(channelNum,"utf-8") + "\n";

# 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)
    print ssh.lastErrorText() + "\n";
    exit
end

# Show what we received...
print ssh.getReceivedText(channelNum,"utf-8") + "\n";

# 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.
saMatch = Chilkat::CkStringArray.new()
# 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--")

sbReceived = Chilkat::CkStringBuilder.new()
moreComing = true
while (moreComing == true)

    success = ssh.ChannelReceiveUntilMatchN(channelNum,saMatch,"utf-8",true)
    if (success != true)
        print ssh.lastErrorText() + "\n";
        exit
    end

    moreComing = false

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

    print sbReceived.getAsString() + "\n";

    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")
    end

end

ssh.Disconnect()