VBScript

Get the Type of an Active SSH Channel

Demonstrates the Chilkat Ssh.GetChannelType method, which returns the type of the channel at a zero-based enumeration index. The only argument is the index — an enumeration position, not a channel number. Values include session, x11, forwarded-tcpip, and direct-tcpip.

Background: Paired with GetChannelNumber, this turns the channel collection into a readable inventory of what a connection is currently doing — which channels are running commands (session) versus tunneling TCP traffic (direct-tcpip). That is valuable for diagnostics and for application code that manages several channel kinds at once. An out-of-range index causes the string-returning method to report failure.

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.GetChannelType method, which returns the type of the channel at a
'  zero-based enumeration index.  The only argument is the index, which is an enumeration
'  position and not a channel number.  Values include "session" and "direct-tcpip".

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

'  Enumerate the active channels and report each one's number and type.
n = ssh.NumOpenChannels

For i = 0 To n - 1
    chNum = ssh.GetChannelNumber(i)
    chType = ssh.GetChannelType(i)
    If (ssh.LastMethodSuccess = 0) Then
        outFile.WriteLine(ssh.LastErrorText)
        WScript.Quit
    End If

    outFile.WriteLine("Channel " & chNum & " is of type " & chType)
Next

ssh.Disconnect 

outFile.Close