(PureBasic) SSH Exec (Execute Command Line)

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

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkSsh.pb"

Procedure ChilkatExample()

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

    ssh.i = CkSsh::ckCreate()
    If ssh.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Connect to an SSH server:
    hostname.s
    port.i

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

    success.i = CkSsh::ckConnect(ssh,hostname,port)
    If success <> 1
        Debug CkSsh::ckLastErrorText(ssh)
        CkSsh::ckDispose(ssh)
        ProcedureReturn
    EndIf

    ; Wait a max of 5 seconds when reading responses..
    CkSsh::setCkIdleTimeoutMs(ssh, 5000)

    ; Authenticate using login/password:
    success = CkSsh::ckAuthenticatePw(ssh,"myLogin","myPassword")
    If success <> 1
        Debug CkSsh::ckLastErrorText(ssh)
        CkSsh::ckDispose(ssh)
        ProcedureReturn
    EndIf

    ; Open a session channel.  (It is possible to have multiple
    ; session channels open simultaneously.)
    channelNum.i
    channelNum = CkSsh::ckOpenSessionChannel(ssh)
    If channelNum < 0
        Debug CkSsh::ckLastErrorText(ssh)
        CkSsh::ckDispose(ssh)
        ProcedureReturn
    EndIf

    ; 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:
    cmd1.s = "dir"

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

    ; List a specific directory.  Given that the shell is CMD.EXE, backslashes must
    ; be used:
    cmd3.s = "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:
    cmd4.s = Chr(34) + "cd \temp&&dir" + Chr(34)

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

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

    ; Run a series of commands (syntax may depend on your default shell):
    cmd6.s = "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 = CkSsh::ckSendReqExec(ssh,channelNum,"ls")
    If success <> 1
        Debug CkSsh::ckLastErrorText(ssh)
        CkSsh::ckDispose(ssh)
        ProcedureReturn
    EndIf

    ; Call ChannelReceiveToClose to read 
    ; output until the server's corresponding "channel close" is received.
    success = CkSsh::ckChannelReceiveToClose(ssh,channelNum)
    If success <> 1
        Debug CkSsh::ckLastErrorText(ssh)
        CkSsh::ckDispose(ssh)
        ProcedureReturn
    EndIf

    ; Let's pickup the accumulated output of the command:
    cmdOutput.s = CkSsh::ckGetReceivedText(ssh,channelNum,"ansi")
    If CkSsh::ckLastMethodSuccess(ssh) <> 1
        Debug CkSsh::ckLastErrorText(ssh)
        CkSsh::ckDispose(ssh)
        ProcedureReturn
    EndIf

    ; Display the remote shell's command output:
    Debug cmdOutput

    ; Disconnect
    CkSsh::ckDisconnect(ssh)


    CkSsh::ckDispose(ssh)


    ProcedureReturn
EndProcedure