How to use SFTP in Powershell

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 Powershell 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 Powershell

Create a new Powershell file called DEMO.PS1.

Create the Network Component object(s) like this:

$objSFtp = new-object -comobject AxNetwork.Sftp

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

Write-Host "Network Component Version " $objSFtp.Version
Write-Host "  Build  " $objSFtp.Build 
Write-Host "  Module " $objSFtp.Module
Write-Host "License Status: " $objSFtp.LicenseStatus

Appendix: Full source code

# *******************************************************************
# ActiveXperts Network Component Sample - SFTP
# Written by ActiveXperts Software - https://www.activexperts.com
# ********************************************************************

# ***************************************************************************
# Function Pad
# ***************************************************************************
Function Pad([string]$strText, [int]$nLength) 
{   
    $strhost = ""
    $Substring = $strText.substring(0,$strText.length)
    $Space = " " * ($nLength- $strText.Length)
    $strhost = $Substring + $Space
    if($strText.Length -gt  30)
    {
      $Substring = $strText.substring(0,($strText.length -5))
      $strhost = $Substring+ "..." + $Space
    }
    return $strhost
}


# ***************************************************************************
# MAIN SCRIPT
# ***************************************************************************

cls

$objSFtp = new-object -comobject 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.LicenseKey = "XXXXX-XXXXX-XXXXX"  

# Display ActiveXperts Network Component Version
Write-Host "ActiveXperts Network Component " $objSFtp.Version "`nBuild: " $objSFtp.Build "`nModule: "  $objSFtp.Module "`nLicense Status: " $objSFtp.LicenseStatus "`nLicense Key: " $objSFtp.LicenseKey "`n`n";

$objSFtp.Host     = "smpp.activexperts-labs.com"  
$objSFtp.Port     = 22
$objSFtp.UserName = "demo"
$objSFtp.Password = "demo"
$objSFtp.PrivateKeyFile = ""

#The next line accepts a changed or unknown host key
$objSFtp.AcceptHostKey = $True

$objSFtp.Connect()
$res = "Connect, result: " + $objSFtp.LastError + " (" + $objSFtp.GetErrorDescription( $objSFtp.LastError ) + ")"
Write-Host $res  
if($objSFtp.Lasterror -ne 0)
{
  if($objSftp.ProtocolError -ne "")
  {
    $res = "Protocol error: " + $objSFtp.ProtocolError 
    Write-Host $res
  }
  exit
}
Write-Host "Remote directory listing:"
$f = $objSFtp.FindFirstFile("/*")
While($objSFtp.LastError -eq 0)
{   
  $res = Pad $f.name 30
  $res1 = Pad $f.SizeBytes 10
  $res2 = $f.Date
  $result = $res + $res1 + $res2
  Write-Host $result
   
  $f = $objSFtp.FindNextFile()
}

$objSFtp.Disconnect()
Write-Host "Disconnected."

Write-Host "Finished."

To run the code, start Powershell and browse to the location of the file you just created. Enter .\Demo.ps1 to run the code. Notice that if the script is not working, you have to change the execution policy; you can do that with the following command:

Set-ExecutionPolicy -unrestricted

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 Powershell

Step 1: Download and install the Network Component

Step 2: Create a new script

Step 3: Create the Network Component object in Powershell

Appendix: Full source code