Visual FoxPro

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. Visual FoxPro

LOCAL lnSuccess
LOCAL loSsh
LOCAL lnPort
LOCAL lnChannelNum
LOCAL loSbCommands

lnSuccess = 0

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

loSsh = CreateObject('Chilkat.Ssh')

lnPort = 22
lnSuccess = loSsh.Connect("the-ssh-server.com",lnPort)
IF (lnSuccess = 0) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    CANCEL
ENDIF

* Authenticate using login/password:
lnSuccess = loSsh.AuthenticatePw("theSshLogin","theSshPassword")
IF (lnSuccess = 0) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    CANCEL
ENDIF

* Start a shell session.
lnChannelNum = loSsh.QuickShell()
IF (lnChannelNum < 0) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    CANCEL
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.)
loSbCommands = CreateObject('Chilkat.StringBuilder')
loSbCommands.Append("echo hello world" + CHR(10))
loSbCommands.Append("date" + CHR(10))
loSbCommands.Append("df" + CHR(10))

* 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.
loSbCommands.Append("echo THIS 'IS' THE END OF THE SCRIPT" + CHR(10))

* Send the commands..
lnSuccess = loSsh.ChannelSendString(lnChannelNum,loSbCommands.GetAsString(),"ansi")
IF (lnSuccess = 0) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    RELEASE loSbCommands
    CANCEL
ENDIF

* Receive output up to our marker.
lnSuccess = loSsh.ChannelReceiveUntilMatch(lnChannelNum,"THIS IS THE END OF THE SCRIPT","ansi",1)

* 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.
lnSuccess = loSsh.ChannelSendEof(lnChannelNum)

* Close the channel.
* It is important to close the channel only after receiving the desired output.
lnSuccess = loSsh.ChannelSendClose(lnChannelNum)

* Get any remaining output..
lnSuccess = loSsh.ChannelReceiveToClose(lnChannelNum)

* Get the complete output for all the commands in the session.
? "--- output ----"
? loSsh.GetReceivedText(lnChannelNum,"ansi")

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

RELEASE loSsh
RELEASE loSbCommands