VBScript

Send CLOSE on an SSH Channel

Demonstrates the Chilkat Ssh.ChannelSendClose method, which sends an SSH CLOSE message for a channel and immediately marks it locally closed. The only argument is the channel number. It does not wait for remote EOF, remote CLOSE, or an exit status.

Background: CLOSE shuts down both directions of the channel, unlike EOF which closes only your side. Because the call returns without waiting for the remote side to acknowledge, it does not guarantee the remote process has terminated — so retrieve any output and exit status you care about before calling it. Afterward ChannelIsOpen reports false, though NumOpenChannels may still count the channel until final remote-close processing.

Chilkat VBScript Downloads

Download Chilkat for VBScript

VBScript

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

success = 0

'  Demonstrates the Ssh.ChannelSendClose method, which sends an SSH CLOSE message for a channel
'  and immediately marks it locally closed.  The only argument is the channel number.  It does
'  not wait for remote EOF, remote CLOSE, or an exit status.

set ssh = CreateObject("Chilkat.Ssh")

sshPort = 22
success = ssh.Connect("ssh.example.com",sshPort)
If (success = 0) Then
    outFile.WriteLine(ssh.LastErrorText)
    WScript.Quit
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
    outFile.WriteLine(ssh.LastErrorText)
    WScript.Quit
End If

channelNum = ssh.OpenSessionChannel()
If (channelNum < 0) Then
    outFile.WriteLine(ssh.LastErrorText)
    WScript.Quit
End If

success = ssh.SendReqExec(channelNum,"uptime")
If (success = 0) Then
    outFile.WriteLine(ssh.LastErrorText)
    WScript.Quit
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
    outFile.WriteLine(ssh.LastErrorText)
    WScript.Quit
End If

output = ssh.GetReceivedText(channelNum,"utf-8")
If (ssh.LastMethodSuccess = 0) Then
    outFile.WriteLine(ssh.LastErrorText)
    WScript.Quit
End If

outFile.WriteLine(output)

'  Send CLOSE for the channel.
success = ssh.ChannelSendClose(channelNum)
If (success = 0) Then
    outFile.WriteLine(ssh.LastErrorText)
    WScript.Quit
End If

'  After a successful call, the channel is no longer reported as open.
If (ssh.ChannelIsOpen(channelNum)) Then
    outFile.WriteLine("Still open.")
Else
    outFile.WriteLine("The channel is closed.")
End If

ssh.Disconnect 

outFile.Close