PowerBuilder

SSH Remote Shell

See more SSH Examples

Demonstrates how to start a shell on a remote SSH server, run a command, and retrieve the output. PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Ssh
string ls_Hostname
integer li_Port
integer li_ChannelNum
string ls_TermType
integer li_WidthInChars
integer li_HeightInChars
integer li_PixWidth
integer li_PixHeight
integer n
integer li_PollTimeoutMs
string ls_CmdOutput

li_Success = 0

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

loo_Ssh = create oleobject
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

// Hostname may be an IP address or hostname:
ls_Hostname = "www.some-ssh-server.com"
li_Port = 22

// Connect to an SSH server:
li_Success = loo_Ssh.Connect(ls_Hostname,li_Port)
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

// Wait a max of 5 seconds when reading responses..
loo_Ssh.IdleTimeoutMs = 5000

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

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

li_ChannelNum = loo_Ssh.OpenSessionChannel()
if li_ChannelNum < 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

// Some SSH servers require a pseudo-terminal
// If so, include the call to SendReqPty.  If not, then 
// comment out the call to SendReqPty.
// Note: The 2nd argument of SendReqPty is the terminal type,
// which should be something like "xterm", "vt100", "dumb", etc.
// A "dumb" terminal is one that cannot process escape sequences.
// Smart terminals, such as "xterm", "vt100", etc. process
// escape sequences.  If you select a type of smart terminal,
// your application will receive these escape sequences
// included in the command's output.  Use "dumb" if you do not
// want to receive escape sequences.  (Assuming your SSH
// server recognizes "dumb" as a standard dumb terminal.)
ls_TermType = "dumb"
li_WidthInChars = 120
li_HeightInChars = 40
// Use 0 for pixWidth and pixHeight when the dimensions
// are set in number-of-chars.
li_PixWidth = 0
li_PixHeight = 0
li_Success = loo_Ssh.SendReqPty(li_ChannelNum,ls_TermType,li_WidthInChars,li_HeightInChars,li_PixWidth,li_PixHeight)
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

// Start a shell on the channel:
li_Success = loo_Ssh.SendReqShell(li_ChannelNum)
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

// Start a command in the remote shell.  This example
// will send a "ls" command to retrieve the directory listing.
li_Success = loo_Ssh.ChannelSendString(li_ChannelNum,"ls~r~n","ansi")
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

// Send an EOF.  This tells the server that no more data will 
// be sent on this channel.  The channel remains open, and
// the SSH client may still receive output on this channel.
li_Success = loo_Ssh.ChannelSendEof(li_ChannelNum)
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

// Read whatever output may already be available on the
// SSH connection.  ChannelReadAndPoll returns the number of bytes
// that are available in the channel's internal buffer that
// are ready to be "picked up" by calling GetReceivedText
// or GetReceivedData.
// A return value of -1 indicates failure.
// A return value of -2 indicates a failure via timeout.

// The ChannelReadAndPoll method waits
// for data to arrive on the connection usingi the IdleTimeoutMs
// property setting.  Once the first data arrives, it continues
// reading but instead uses the pollTimeoutMs passed in the 2nd argument:
// A return value of -2 indicates a timeout where no data is received.

li_PollTimeoutMs = 2000
n = loo_Ssh.ChannelReadAndPoll(li_ChannelNum,li_PollTimeoutMs)
if n < 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

// Close the channel:
li_Success = loo_Ssh.ChannelSendClose(li_ChannelNum)
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

// Perhaps we did not receive all of the commands output.
// To make sure,  call ChannelReceiveToClose to accumulate any remaining
// output until the server's corresponding "channel close" is received.
li_Success = loo_Ssh.ChannelReceiveToClose(li_ChannelNum)
if li_Success <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

// Let's pickup the accumulated output of the command:
ls_CmdOutput = loo_Ssh.GetReceivedText(li_ChannelNum,"ansi")
if loo_Ssh.LastMethodSuccess <> 1 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

// Display the remote shell's command output:
Write-Debug ls_CmdOutput

// Disconnect
loo_Ssh.Disconnect()


destroy loo_Ssh