VBScript

Enumerate Active SSH Channel Numbers

Demonstrates the Chilkat Ssh.GetChannelNumber method, which returns the channel number at a zero-based enumeration index in the active channel collection. The only argument is the index — an enumeration position, not itself a channel number. Valid indexes run from 0 through NumOpenChannels - 1, and out-of-range indexes return -1.

Background: One SSH connection can carry many simultaneous channels, and this method lets you walk the live set rather than tracking every channel number yourself. The index-versus-channel-number distinction is the key point: index 0 is simply the first channel in the collection and may well be channel number 3. As channels open and close the enumeration shifts, so treat an index as valid only for the moment you read it.

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.GetChannelNumber method, which returns the channel number at a
'  zero-based enumeration index in the active channel collection.  The only argument is the
'  index, which is an enumeration position and not itself a channel number.

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

'  Open a couple of channels so the collection has more than one entry.
channelA = ssh.OpenSessionChannel()
If (channelA < 0) Then
    outFile.WriteLine(ssh.LastErrorText)
    WScript.Quit
End If

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

'  Enumerate the active channels.  Valid indexes are 0 through NumOpenChannels - 1.
n = ssh.NumOpenChannels
outFile.WriteLine("Open channels: " & n)

For i = 0 To n - 1
    chNum = ssh.GetChannelNumber(i)
    outFile.WriteLine("Index " & i & " is channel number " & chNum)
Next

ssh.Disconnect 

outFile.Close