VBScript

Get an SSH Tunnel's Current State (Diagnostics)

Demonstrates the Chilkat SshTunnel.GetCurrentState method, which returns an XML snapshot describing the tunnel manager, SSH channels, and current tunnel clients. It takes no arguments and is intended for diagnostics and monitoring.

Background: Because the tunnel forwards traffic on a background thread, there is no natural place in your code to observe what it is doing at a given moment. GetCurrentState provides that visibility — byte counts, active channels, and connected clients — as structured XML suited to logging or a monitoring dashboard. It is a read-only snapshot and does not affect the tunnel.

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 SshTunnel.GetCurrentState method, which returns an XML snapshot describing the
'  tunnel manager, SSH channels, and current tunnel clients.  It takes no arguments and is
'  intended for diagnostics and monitoring.

set tunnel = CreateObject("Chilkat.SshTunnel")

'  The tunnel forwards accepted local connections to this destination through the SSH server.
tunnel.DestHostname = "db.internal.example.com"
tunnel.DestPort = 5432

'  Connect to the SSH server.  This performs the TCP/proxy connection and SSH handshake, but
'  does not authenticate yet.
sshPort = 22
success = tunnel.Connect("ssh.example.com",sshPort)
If (success = 0) Then
    outFile.WriteLine(tunnel.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 = tunnel.AuthenticatePw("mySshLogin",password)
If (success = 0) Then
    outFile.WriteLine(tunnel.LastErrorText)
    WScript.Quit
End If

'  Begin accepting so there is live tunnel state to inspect.
listenPort = 1080
success = tunnel.BeginAccepting(listenPort)
If (success = 0) Then
    outFile.WriteLine(tunnel.LastErrorText)
    WScript.Quit
End If

'  Get a diagnostic snapshot of the tunnel's current state as XML.
stateXml = tunnel.GetCurrentState()
If (tunnel.LastMethodSuccess = 0) Then
    outFile.WriteLine(tunnel.LastErrorText)
    WScript.Quit
End If

outFile.WriteLine(stateXml)

waitForThreadExit = 1
success = tunnel.CloseTunnel(waitForThreadExit)
If (success = 0) Then
    outFile.WriteLine(tunnel.LastErrorText)
    WScript.Quit
End If


outFile.Close