Check Whether an SSH Exit Status Was Received

See more SSH Examples

Demonstrates the Chilkat Ssh.ChannelReceivedExitStatus method, which reports whether the server supplied an exit-status value for a channel. The only argument is the channel number. When it returns true, call GetChannelExitStatus to read the value.

Dim success As Long
success = 0

'  Demonstrates the Ssh.ChannelReceivedExitStatus method, which reports whether the server
'  supplied an exit-status value for a channel.  The only argument is the channel number.  When
'  it returns 1, call GetChannelExitStatus to read the value.

Dim ssh As New ChilkatSsh

Dim sshPort As Long
sshPort = 22
success = ssh.Connect("ssh.example.com",sshPort)
If (success = 0) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
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.
Dim password As String
password = "mySshPassword"

success = ssh.AuthenticatePw("mySshLogin",password)
If (success = 0) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

Dim channelNum As Long
channelNum = ssh.OpenSessionChannel()
If (channelNum < 0) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

success = ssh.SendReqExec(channelNum,"test -f /etc/hosts")
If (success = 0) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
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.
ssh.ReadTimeoutMs = 15000

success = ssh.ChannelReceiveToClose(channelNum)
If (success = 0) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

'  The server is not required to send an exit status for every channel type or command.
If (ssh.ChannelReceivedExitStatus(channelNum)) Then
    Dim exitStatus As Long
    exitStatus = ssh.GetChannelExitStatus(channelNum)
    Debug.Print "Exit status: " & exitStatus
Else
    Debug.Print "The server did not provide an exit status."
End If

ssh.Disconnect