(DataFlex) SSH Exec (Execute Command Line)

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-9.5.0-win32.pkg

Procedure Test
    Handle hoSsh
    String sHostname
    Integer iPort
    Boolean iSuccess
    Integer iChannelNum
    String sCmd1
    String sCmd2
    String sCmd3
    String sCmd4
    String sCmd5
    String sCmd6
    String sCmdOutput
    String sTemp1
    Boolean bTemp1

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

    Get Create (RefClass(cComChilkatSsh)) To hoSsh
    If (Not(IsComObjectCreated(hoSsh))) Begin
        Send CreateComObject of hoSsh
    End

    // Connect to an SSH server:

    // Hostname may be an IP address or hostname:
    Move "192.168.1.108" To sHostname
    Move 22 To iPort

    Get ComConnect Of hoSsh sHostname iPort To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Wait a max of 5 seconds when reading responses..
    Set ComIdleTimeoutMs Of hoSsh To 5000

    // Authenticate using login/password:
    Get ComAuthenticatePw Of hoSsh "myLogin" "myPassword" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Open a session channel.  (It is possible to have multiple
    // session channels open simultaneously.)

    Get ComOpenSessionChannel Of hoSsh To iChannelNum
    If (iChannelNum < 0) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // 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:
    Move "dir" To sCmd1

    // Do a nameserver lookup:
    Move "nslookup chilkatsoft.com" To sCmd2

    // List a specific directory.  Given that the shell is CMD.EXE, backslashes must
    // be used:
    Move "dir \temp" To sCmd3

    // 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:
    Move '"cd \temp&&dir"' To sCmd4

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

    // Get a directory listing:
    Move "ls -l /tmp" To sCmd5

    // Run a series of commands (syntax may depend on your default shell):
    Move "cd /etc; ls -la" To sCmd6

    // Request a directory listing on the remote server:
    // If your server is Windows, change the string from "ls" to "dir"
    Get ComSendReqExec Of hoSsh iChannelNum "ls" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Call ChannelReceiveToClose to read 
    // output until the server's corresponding "channel close" is received.
    Get ComChannelReceiveToClose Of hoSsh iChannelNum To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Let's pickup the accumulated output of the command:
    Get ComGetReceivedText Of hoSsh iChannelNum "ansi" To sCmdOutput
    Get ComLastMethodSuccess Of hoSsh To bTemp1
    If (bTemp1 <> True) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Display the remote shell's command output:
    Showln sCmdOutput

    // Disconnect
    Send ComDisconnect To hoSsh


End_Procedure