PowerBuilder

Start a Remote Shell over SSH

Demonstrates the Chilkat Ssh.SendReqShell method, which starts a remote shell on an open session channel. The only argument is the channel number. This example starts a shell without a PTY, which is the recommended approach for scripting, and streams a command whose output ends with a marker.

Background: A shell request starts the account's login shell and leaves the channel open for ongoing input and output — the difference from exec, which runs a single command. When no PTY is requested, the shell detects it is attached to a raw pipe rather than a terminal and runs non-interactively: it prints no command prompt, does not echo the commands you send, and skips interactive login scripts. That yields clean, easily parsed output, but it also means there is no prompt to synchronize on — have each command echo a predictable marker, or rely on EOF and the channel exit status, to know when its output is complete.

Chilkat PowerBuilder Downloads

Download Chilkat for PowerBuilder

PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Ssh
integer li_SshPort
string ls_Password
integer li_ChannelNum
integer li_CaseSensitive
string ls_Output

li_Success = 0

//  Demonstrates the Ssh.SendReqShell method, which starts a remote shell on an open session
//  channel.  The only argument is the channel number.  A shell can be started without a PTY,
//  which is the recommended approach for scripting and automation.

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

li_SshPort = 22
li_Success = loo_Ssh.Connect("ssh.example.com",li_SshPort)
if li_Success = 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

//  Normally you would not hard-code the password in source.  You should instead obtain it
//  from an interactive prompt, environment variable, or a secrets vault.
ls_Password = "mySshPassword"

li_Success = loo_Ssh.AuthenticatePw("mySshLogin",ls_Password)
if li_Success = 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

//  Open a session channel.  A negative return value indicates failure.
li_ChannelNum = loo_Ssh.OpenSessionChannel()
if li_ChannelNum < 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

//  Start a shell WITHOUT requesting a PTY.  Without a PTY the shell sees it is connected to a
//  raw data pipe and enters non-interactive mode: it suppresses the command prompt, does not
//  echo typed commands back, and skips interactive login scripts.  The output is therefore
//  clean and easily parseable -- but because no prompt is ever sent, code must not wait for
//  one.  Instead, have each command print a predictable marker, or wait for EOF / channel close.
li_Success = loo_Ssh.SendReqShell(li_ChannelNum)
if li_Success = 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

Write-Debug "Remote shell started."

//  Multiple commands can now be streamed into the shell, one after another.  Each command
//  echoes a marker so the code can tell when its output is complete.
li_Success = loo_Ssh.ChannelSendString(li_ChannelNum,"uname -a; echo DONE_MARKER~n","utf-8")
if li_Success = 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

//  IMPORTANT: Set a read timeout before receiving until a match.  ReadTimeoutMs defaults to 0,
//  which means no limit -- without it, this call waits forever if the received data never
//  contains a match.
loo_Ssh.ReadTimeoutMs = 15000

li_CaseSensitive = 0
li_Success = loo_Ssh.ChannelReceiveUntilMatch(li_ChannelNum,"DONE_MARKER","utf-8",li_CaseSensitive)
if li_Success = 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

ls_Output = loo_Ssh.GetReceivedText(li_ChannelNum,"utf-8")
if loo_Ssh.LastMethodSuccess = 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

Write-Debug ls_Output

loo_Ssh.Disconnect()


destroy loo_Ssh