Classic ASP

Check Whether an SSH Exit Status Was Received

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.

Background: Always test this before reading the exit status, because the server is not required to send one for every channel type or command — treating a missing status as "0" would silently turn a failure into a success. Exit status is independent of EOF and CLOSE: it can arrive after EOF and either before or together with CLOSE.

Chilkat Classic ASP Downloads

Download Chilkat for Classic ASP

Classic ASP

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<%
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.

set ssh = Server.CreateObject("Chilkat.Ssh")

sshPort = 22
success = ssh.Connect("ssh.example.com",sshPort)
If (success = 0) Then
    Response.Write "<pre>" & Server.HTMLEncode( ssh.LastErrorText) & "</pre>"
    Response.End
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.
password = "mySshPassword"

success = ssh.AuthenticatePw("mySshLogin",password)
If (success = 0) Then
    Response.Write "<pre>" & Server.HTMLEncode( ssh.LastErrorText) & "</pre>"
    Response.End
End If

channelNum = ssh.OpenSessionChannel()
If (channelNum < 0) Then
    Response.Write "<pre>" & Server.HTMLEncode( ssh.LastErrorText) & "</pre>"
    Response.End
End If

success = ssh.SendReqExec(channelNum,"test -f /etc/hosts")
If (success = 0) Then
    Response.Write "<pre>" & Server.HTMLEncode( ssh.LastErrorText) & "</pre>"
    Response.End
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
    Response.Write "<pre>" & Server.HTMLEncode( ssh.LastErrorText) & "</pre>"
    Response.End
End If

'  The server is not required to send an exit status for every channel type or command.
If (ssh.ChannelReceivedExitStatus(channelNum)) Then
    exitStatus = ssh.GetChannelExitStatus(channelNum)
    Response.Write "<pre>" & Server.HTMLEncode( "Exit status: " & exitStatus) & "</pre>"
Else
    Response.Write "<pre>" & Server.HTMLEncode( "The server did not provide an exit status.") & "</pre>"
End If

ssh.Disconnect 

%>
</body>
</html>