Get the Exit Status of a Remote SSH Command

See more SSH Examples

Demonstrates the Chilkat Ssh.GetChannelExitStatus method, which returns the remote process exit status for a channel. The only argument is the channel number. Call it only after ChannelReceivedExitStatus returns true.

integer li_rc
integer li_Success
oleobject loo_Ssh
integer li_SshPort
string ls_Password
integer li_ChannelNum
integer li_ExitStatus

li_Success = 0

//  Demonstrates the Ssh.GetChannelExitStatus method, which returns the remote process exit
//  status for a channel.  The only argument is the channel number.  Call it only after
//  ChannelReceivedExitStatus returns 1.

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

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

li_Success = loo_Ssh.SendReqExec(li_ChannelNum,"grep -q root /etc/passwd")
if li_Success = 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

//  IMPORTANT: Set a read timeout.  ReadTimeoutMs defaults to 0, which means no limit -- without
//  it, this call waits forever if the server never sends channel close.
loo_Ssh.ReadTimeoutMs = 15000

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

//  Retrieve the exit status immediately, before calling unrelated SSH methods or releasing the
//  channel, because the completed channel record can be discarded.
if loo_Ssh.ChannelReceivedExitStatus(li_ChannelNum) then
    li_ExitStatus = loo_Ssh.GetChannelExitStatus(li_ChannelNum)
    Write-Debug "Exit status: " + string(li_ExitStatus)

    //  By convention, 0 means the remote command succeeded.
    if li_ExitStatus = 0 then
        Write-Debug "The remote command succeeded."
    else
        Write-Debug "The remote command reported a failure."
    end if

end if

loo_Ssh.Disconnect()


destroy loo_Ssh