Swift

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

func chilkatTest() {
    var success: Bool = false

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

    let ssh = CkoSsh()!

    success = ssh.connect(hostname: "SSH_SERVER_DOMAIN_OR_IP_ADDRESS", port: 22)
    if success != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    // Authenticate using login/password:
    success = ssh.authenticatePw(login: "myLogin", password: "myPassword")
    if success != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    // Start a shell session.
    var channelNum: Int = ssh.quickShell().intValue
    if channelNum < 0 {
        print("\(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.channelReceive(untilMatch: channelNum, matchPattern: ">", charset: "utf-8", caseSensitive: true)
    if success != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    // Show what we received so far:
    print("\(ssh.getReceivedText(channelNum: channelNum, charset: "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: channelNum, strData: "ena\r", charset: "utf-8")
    // Assume success for this example to make it shorter..

    // Read to the "Password:" prompt.
    success = ssh.channelReceive(untilMatch: channelNum, matchPattern: "Password:", charset: "utf-8", caseSensitive: true)
    if success != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    // Show what we received...
    print("\(ssh.getReceivedText(channelNum: channelNum, charset: "utf-8")!)")

    // Send the password.
    success = ssh.channelSendString(channelNum: channelNum, strData: "MY_PASSWORD_FOR_ELEVATED_PRIVILEGE\r", charset: "utf-8")

    // The prompt now changes from "Something>" to "Something#>
    // Read until the new prompt..
    success = ssh.channelReceive(untilMatch: channelNum, matchPattern: "#", charset: "utf-8", caseSensitive: true)
    if success != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    // Show what we received...
    print("\(ssh.getReceivedText(channelNum: channelNum, charset: "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: channelNum, strData: "show running-config\r", charset: "utf-8")

    // Consume the response until we end with another prompt.
    let saMatch = CkoStringArray()!
    // 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(str: "YOUR_PROMPT#")
    saMatch.append(str: "--More--")

    let sbReceived = CkoStringBuilder()!
    var moreComing: Bool = true
    while (moreComing == true) {

        success = ssh.channelReceive(untilMatchN: channelNum, matchPatterns: saMatch, charset: "utf-8", caseSensitive: true)
        if success != true {
            print("\(ssh.lastErrorText!)")
            return
        }

        moreComing = false

        sbReceived.clear()
        sbReceived.append(value: ssh.getReceivedText(channelNum: channelNum, charset: "utf-8"))

        print("\(sbReceived.getAsString()!)")

        if sbReceived.contains(str: "--More--", caseSensitive: 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: channelNum, strData: " ", charset: "utf-8")
        }

    }

    ssh.disconnect()

}