AutoIt

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. AutoIt

Local $bSuccess = False

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

$oSsh = ObjCreate("Chilkat.Ssh")

Local $iPort = 22
$bSuccess = $oSsh.Connect("the-ssh-server.com",$iPort)
If ($bSuccess = False) Then
    ConsoleWrite($oSsh.LastErrorText & @CRLF)
    Exit
EndIf

; Authenticate using login/password:
$bSuccess = $oSsh.AuthenticatePw("theSshLogin","theSshPassword")
If ($bSuccess = False) Then
    ConsoleWrite($oSsh.LastErrorText & @CRLF)
    Exit
EndIf

; Start a shell session.
Local $iChannelNum = $oSsh.QuickShell()
If ($iChannelNum < 0) Then
    ConsoleWrite($oSsh.LastErrorText & @CRLF)
    Exit
EndIf

; 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.)
$oSbCommands = ObjCreate("Chilkat.StringBuilder")
$oSbCommands.Append("echo hello world" & @LF)
$oSbCommands.Append("date" & @LF)
$oSbCommands.Append("df" & @LF)

; 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.
$oSbCommands.Append("echo THIS 'IS' THE END OF THE SCRIPT" & @LF)

; Send the commands..
$bSuccess = $oSsh.ChannelSendString($iChannelNum,$oSbCommands.GetAsString(),"ansi")
If ($bSuccess = False) Then
    ConsoleWrite($oSsh.LastErrorText & @CRLF)
    Exit
EndIf

; Receive output up to our marker.
$bSuccess = $oSsh.ChannelReceiveUntilMatch($iChannelNum,"THIS IS THE END OF THE SCRIPT","ansi",True)

; 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.
$bSuccess = $oSsh.ChannelSendEof($iChannelNum)

; Close the channel.
; It is important to close the channel only after receiving the desired output.
$bSuccess = $oSsh.ChannelSendClose($iChannelNum)

; Get any remaining output..
$bSuccess = $oSsh.ChannelReceiveToClose($iChannelNum)

; Get the complete output for all the commands in the session.
ConsoleWrite("--- output ----" & @CRLF)
ConsoleWrite($oSsh.GetReceivedText($iChannelNum,"ansi") & @CRLF)

; 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$