DataFlex

SSH Quick/Simple Shell Session

See more SSH Examples

Demonstrates the simplified way to run multiple commands in a shell session on an SSH server. DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoSsh
    Integer iPort
    Integer iChannelNum
    Handle hoSbCommands
    String sTemp1

    Move False To iSuccess

    // This example requires 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

    Move 22 To iPort
    Get ComConnect Of hoSsh "the-ssh-server.com" iPort To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Authenticate using login/password:
    Get ComAuthenticatePw Of hoSsh "theSshLogin" "theSshPassword" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Start a shell session.
    Get ComQuickShell Of hoSsh To iChannelNum
    If (iChannelNum < 0) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Construct a StringBuilder with multiple commands, one per line.
    // Note: The line-endings are potentially important.  Some SSH servers may
    // require either LF or CRLF line endings.  (Unix/Linux/OSX servers typically
    // use bare-LF line endings.  Windows servers likely use CRLF line endings.)
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbCommands
    If (Not(IsComObjectCreated(hoSbCommands))) Begin
        Send CreateComObject of hoSbCommands
    End
    Get ComAppend Of hoSbCommands "echo hello world" + (character(10)) To iSuccess
    Get ComAppend Of hoSbCommands "date" + (character(10)) To iSuccess
    Get ComAppend Of hoSbCommands "df" + (character(10)) To iSuccess

    // For our last command, we're going to echo a marker string that
    // we'll use in ChannelReceiveUntilMatch below.
    // The use of single quotes around 'IS' is a trick so that the output
    // of the command is "THIS IS THE END OF THE SCRIPT", but the terminal echo
    // includes the single quotes.  This allows us to read until we see the actual
    // output of the last command.
    Get ComAppend Of hoSbCommands "echo THIS 'IS' THE END OF THE SCRIPT" + (character(10)) To iSuccess

    // Send the commands..
    Get ComGetAsString Of hoSbCommands To sTemp1
    Get ComChannelSendString Of hoSsh iChannelNum sTemp1 "ansi" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoSsh To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Receive output up to our marker.
    Get ComChannelReceiveUntilMatch Of hoSsh iChannelNum "THIS IS THE END OF THE SCRIPT" "ansi" True To iSuccess

    // Send an EOF to indicate no more commands will be sent.
    // For brevity, we're not checking the return values of each method call.
    // Your code should check the success/failure of each call.
    Get ComChannelSendEof Of hoSsh iChannelNum To iSuccess

    // Close the channel.
    // It is important to close the channel only after receiving the desired output.
    Get ComChannelSendClose Of hoSsh iChannelNum To iSuccess

    // Get any remaining output..
    Get ComChannelReceiveToClose Of hoSsh iChannelNum To iSuccess

    // Get the complete output for all the commands in the session.
    Showln "--- output ----"
    Get ComGetReceivedText Of hoSsh iChannelNum "ansi" To sTemp1
    Showln sTemp1

    // Here's our actual sample output:

    // 	Last login: Thu Dec 22 20:19:09 2016 from chilkat13
    // 
    // 	echo hello world
    // 	date
    // 	df
    // 	echo THIS 'IS' THE END OF THE SCRIPT
    // 	chilkatosx:~ chilkat$ echo hello world
    // 	hello world
    // 	chilkatosx:~ chilkat$ date
    // 	Thu Dec 22 20:30:48 CST 2016
    // 	chilkatosx:~ chilkat$ df
    // 	Filesystem    512-blocks      Used  Available Capacity  iused     ifree %iused  Mounted on
    // 	/dev/disk2    2176716032 265768928 1910435104    13% 33285114 238804388   12%   /
    // 	devfs                383       383          0   100%      664         0  100%   /dev
    // 	map -hosts             0         0          0   100%        0         0  100%   /net
    // 	map auto_home          0         0          0   100%        0         0  100%   /home
    // 	/dev/disk3s2      374668    374668          0   100%    93665         0  100%   /Volumes/Google Chrome
    // 	chilkatosx:~ chilkat$ echo THIS 'IS' THE END OF THE SCRIPT
    // 	THIS IS THE END OF THE SCRIPT
    // 	chilkatosx:~ chilkat$ 


End_Procedure