How to use SFTP 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.

The most important functions of the SFtp object are:

Connect - connect to the (remote) FTP server on port 22 or any alternate port;
Disconnect - to diconnect after a connect call;
GetCurrentDir - retrieve the current directory;
ChangeDir - change the current directory;
CreateDir - create a new directory;
RenameDir - rename a directory;
DeleteDir - delete a directory;
FindFile - find a specific file in the current directory;
FindFirstFile - iterate over all files in the current directory; find the first file;
FindNextFile - iterate over all files in the current directory; find the next file;
RenameFile - rename a file in the current directory;
DeleteFile - delete a file in the current directory;
GetFile - get (download) a file;
PutFile - put (upload) a file;

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 objSftp

Create the Network Component object(s) like this:

Set objSftp      = CreateObject( "AxNetwork.Sftp" )

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

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

Appendix: Full source code

' ********************************************************************
' ActiveXperts Network Component sample - SFTP List directory
'   
' Written by ActiveXperts Software 
'     https://www.activexperts.com
' ********************************************************************

Option Explicit

Dim objSFtp, fso

Set objSFtp = CreateObject( "AxNetwork.SFtp" )

' 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".
'
' objSFtp.Activate "XXXXX-XXXXX-XXXXX", False

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

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

objSFtp.Host = "smpp.activexperts-labs.com"
objSFtp.UserName = "demo"
objSFtp.Password = "demo"
objSFtp.Port     = 22
objSFtp.PrivateKeyFile = ""
objSFtp.LogFile  = "log.txt"
'The next line accepts a changed or unknown host key
objSFtp.AcceptHostKey = true

Function Pad(ByRef Text, ByVal Length)
  Pad = Left(Text & Space(Length), Length)
End Function

objSFtp.Connect
if objSFtp.LastError <> 0 then
  WScript.Echo "Failed; got result: " & objSFtp.LastError & " (" & objSFtp.GetErrorDescription( objSFtp.LastError ) & ")"
  if objSFtp.ProtocolError <> "" then
    WScript.Echo "Protocol error: " & objSFtp.protocolerror    
  end if
  WScript.Quit 1
end if

WScript.Echo "Remote directory listing:"
dim f, str
set f = objSFtp.FindFirstFile("/*")
while objSftp.LastError = 0
  str = pad(f.name, 30) & pad(f.SizeBytes, 10) & f.Date
  WScript.Echo str
'  Uncomment to save the files
'  if not f.IsDirectory then 
'    objSFtp.GetFile f.name, f.name
'  end if

  set f = objSftp.FindNextFile    
wend

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

Contact Info

ActiveXperts Network Component

Crumbtrail

How to use SFTP in VBScript

Step 1: Download and install the Network Component

Step 2: Create a new script

Step 3: Create the Network Component object in VBScript

Appendix: Full source code