ActiveXperts Network Component


How to use SSH in VBScript

Network Component provides an easy-to-use development interface to a variety of IP protocols. By using Network Component, you can very easily create or enhance applications with network features.

Network Component features the following: DNS, FTP, HTTP, HTTPs, ICMP Ping, IP-to-Country, MSN, NTP, RSH, SCP, SFTP, SNMP v1/v2c (Get, GetNext, Set), SNMP Traps, SNMP MIB, SSH, TCP, Telnet, TFTP, UDP, Telnet, Wake-On-LAN and more.

Network Component can be well integrated into any development platform that supports ActiveX objects.

Network Component is compliant with SNMP v1 and SNMP v2c. Several SNMP data types are supported, including:

  • String types (also called "octet strings");
  • Integer types (16bit, 32bit, 64bit and unsigned integers);
  • IP Address types;
  • Timetick types;
  • Counter types (32bit and 64bit counters);
  • OID types (also called "Object ID's");
  • Other, less frequently used datatypes.

Network Component SNMP traps features:

  • SNMP v1 and SNMP v2c support;
  • Support for aplphanumeric OID's (object identifier) and numeric OID's;
  • Multi-threading architecture: send SNMP traps simultaneously from one process using multiple threads;
  • Support for ports other than the default 161 and 162 ports;
  • Support for enterprise specific traps;
  • Support for SNMP v1 generic traps;
  • Send multiple variables in a single SNMP TRAP message.

Step 1: Download and install the Network Component

Download Network Component from the ActiveXperts Download Site and start the installation. The installation guides you through the installation process.

Step 2: Create a new script

Create a new script using your favorite editor. You can simply use notepad. However, a VBScript editor is recommended, so you can browse through objects, objects properties and object functions.

You're now able to write a more advanced script to communicate using the Network Component.

Step 3: Create the Network Component object in VBScript

Create a new VBScript file called DEMO.VBS. It is recommended to insert the following line on top of your code:

Option Explicit

This statement requires that all variable names be defined (with the Dim statement), to avoid simple typos that can cause incredible headaches and long debugging sessions for something that should have never happened.

Now, declare the Network Component object(s):

Dim objSsh

Create the Network Component object(s) like this:

Set objSsh      = CreateObject( "AxNetwork.Ssh" )

Now, add the following lines to the file to have your first Network Component VBScript program:

WScript.Echo "Version: " & objSsh.Version
WScript.Echo "License Status: " & objSsh.LicenseStatus

Appendix: Full source code

' ********************************************************************
' ActiveXperts Network Component sample - Ssh Secure Shell
'   This SSH sample run the 'ls' command on a remote Unix/Linux machine
' Written by ActiveXperts Software 
' ********************************************************************

Option Explicit

' Declare variables
Dim objSsh, fso

' Create SSh instance
Set objSsh = CreateObject( "AxNetwork.Ssh")

' A license key is required to unlock this component after the trial period has expired.
' Call 'Activate' with a valid license key as its first parameter. Second parameter determines whether to save the license key permanently 
' to the registry (True, so you need to call Activate only once), or not to store the key permanently (False, so you need to call Activate
' every time the component is created). For details, see manual, chapter "Product Activation".
' objSsh.Activate "XXXXX-XXXXX-XXXXX", False

' Component info
Wscript.Echo "ActiveXpert Network Component " & objSsh.Version
Wscript.Echo "Build: " & objSsh.Build & vbCrLf & "Module: " & objSsh.Module
Wscript.Echo "License Status: " & objSsh.LicenseStatus & vbCrLf & "License Key: " & objSsh.LicenseKey & vbCrLf

' Set Logfile
Set fso = CreateObject( "Scripting.FileSystemObject" )
objSsh.LogFile = fso.GetSpecialFolder(2) & "\Ssh.log"
WScript.Echo "Log file: " & objSsh.LogFile & vbCrLf

objSsh.Host     = ReadInput( "Enter name or IP address of the (remote) SSH machine:", "", False )
objSsh.UserName = ReadInput( "Enter user name to logon to remote machine:", "activexperts", False )
objSsh.Password = ReadInput( "Enter password to logon to remote machine (optional): ", "topsecret", True )
objSsh.PrivateKeyFile = ReadInput( "Enter private key file to logon to remote machine (optional): ", "", True )
'The next line accepts a changed or unknown host key
objSsh.AcceptHostKey = true

objSsh.Command  = ReadInput( "Enter command:", "ls -als /cygdrive/c/sshroot/network-component", False )
objSsh.ScriptTimeOut = 5000
WScript.Echo "Run, result: " & objSsh.LastError & " (" & objSsh.GetErrorDescription( objSsh.LastError ) & ")"

If objSsh.LastError = 0 Then
   WScript.Echo "StdOut: " & objSsh.StdOut
   WScript.Echo "StdErr: " & objSsh.StdErr
End If

WScript.Echo "Ready."

' ***************************************************************************
' Function ReadInput
' ***************************************************************************
Function ReadInput( ByVal strTitle, ByVal strDefault, ByVal bAllowEmpty )

   Dim strInput, strReturn
      strInput = inputbox( strTitle, "Enter value", strDefault )
      If ( strInput <> "" ) Then
         strReturn = strInput
      End If
   Loop until strReturn <> "" Or bAllowEmpty
   ReadInput = strReturn
End Function

You can download the complete sample on our FTP site There are many other working Network Component scripts on our site and shipped with the product.