(PowerBuilder) 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.

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

integer li_rc
oleobject loo_Ssh
integer li_Port
integer li_Success
integer li_ChannelNum
oleobject loo_SbCommands

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

loo_Ssh = create oleobject
// Use "Chilkat_9_5_0.Ssh" for versions of Chilkat < 10.0.0
li_rc = loo_Ssh.ConnectToNewObject("Chilkat.Ssh")
if li_rc < 0 then
    destroy loo_Ssh
    MessageBox("Error","Connecting to COM object failed")
    return
end if

li_Port = 22
li_Success = loo_Ssh.Connect("the-ssh-server.com",li_Port)
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

// Authenticate using login/password:
li_Success = loo_Ssh.AuthenticatePw("theSshLogin","theSshPassword")
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

// Start a shell session.
// (The QuickShell method was added in Chilkat v9.5.0.65)
li_ChannelNum = loo_Ssh.QuickShell()
if li_ChannelNum < 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

// 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.)
loo_SbCommands = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbCommands.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbCommands.Append("echo hello world~n")
loo_SbCommands.Append("date~n")
loo_SbCommands.Append("df~n")

// 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.
loo_SbCommands.Append("echo THIS 'IS' THE END OF THE SCRIPT~n")

// Send the commands..
li_Success = loo_Ssh.ChannelSendString(li_ChannelNum,loo_SbCommands.GetAsString(),"ansi")
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    destroy loo_SbCommands
    return
end if

// 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.
li_Success = loo_Ssh.ChannelSendEof(li_ChannelNum)

// Receive output up to our marker.
li_Success = loo_Ssh.ChannelReceiveUntilMatch(li_ChannelNum,"THIS IS THE END OF THE SCRIPT","ansi",1)

// Close the channel.
// It is important to close the channel only after receiving the desired output.
li_Success = loo_Ssh.ChannelSendClose(li_ChannelNum)

// Get any remaining output..
li_Success = loo_Ssh.ChannelReceiveToClose(li_ChannelNum)

// Get the complete output for all the commands in the session.
Write-Debug "--- output ----"
Write-Debug loo_Ssh.GetReceivedText(li_ChannelNum,"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$ 


destroy loo_Ssh
destroy loo_SbCommands