Powershell FTP Client Sample Source Code
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.
This document describes how the Network Component FtpServer object can be integrated into your projects.
The most important functions of the FtpServer object are:
- Connect - connect to the (remote) FTP server on port 21 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, either using binary transfer or ASCII transfer;
- PutFile - put (upload) a file, either using binary transfer or ASCII transfer;
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:
$objFtpServer = new-object -comobject AxNetwork.FtpServer
Now, add the following lines to the file to have your first Network Component Powershell program:
Write-Host "Network Component Version " $objFtpServer.Version Write-Host " Build " $objFtpServer.Build Write-Host " Module " $objFtpServer.Module Write-Host "License Status: " $objFtpServer.LicenseStatus
Appendix: Full source code
You can now connect to a remote FTP server, logon, change directory and perform file operations.
The following Powershell code shows how to list files in a specific directory on a remote FTP server:
# ******************************************************************** # ActiveXperts Network Component Sample - FTPPUT # FTP Sample: Connect to an FTP server, and upload a file # (c) Copyright by ActiveXperts Software 2011 # https://www.activexperts.com # ******************************************************************** $objFtpServer = new-object -comobject AxNetwork.FtpServer # 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". # # $objFtpServer.LicenseKey = "XXXXX-XXXXX-XXXXX" # Display ActiveXperts Network Component Version Write-Host "ActiveXperts Network Component " $objFtpServer.Version "`nBuild: " $objFtpServer.Build "`nModule: " $objFtpServer.Module "`nLicense Status: " $objFtpServer.LicenseStatus "`nLicense Key: " $objFtpServer.LicenseKey "`n`n"; # Logfile $objFtpServer.Logfile = $env:temp + "\FtpServer.log" Write-Host "Log file used: " $objFtpServer.Logfile "`n" # Connect to the remote FTP server $objFtpServer.Connect("ftp.activexperts-lab.com", "anonymous", "me@myself.dom") $res = "Connect, result: " + $objFtpServer.LastError +" (" + $objFtpServer.GetErrorDescription($objFtpServer.LastError) + ")" Write-Host $res If( $objFtpServer.LastError -ne 0 ) { $res = "Ready." Write-Host $res exit } # Show last response of FTP server $res = "Last response: " + $objFtpServer.LastResponse Write-Host $res # Change directory $objFtpServer.ChangeDir -eq "/bartjonkman/activexperts.com/html/Temp/" $res = "ChangeDir, result: " + $objFtpServer.LastError + " (" + $objFtpServer.GetErrorDescription($objFtpServer.LastError) + ")" Write-Host $res If( $objFtpServer.LastError -ne 0 ) { $objFtpServer.Disconnect $res = "Disconnected." Write-Host $res $res = "Ready." Write-Host $res exit } #Use binary transfer for putFile calls $objFtpServer.BinaryTransfer -contains $TRUE # Upload the file. if you want to upload it with a different name, specify a second parameter that indicates the new name # NOTE: You can specify a full path or a relative path for the source file $objFtpServer.PutFile >"c:\temp\picture.bmp" $res ="PutFile, result: " + $objFtpServer.LastError + " (" + $objFtpServer.GetErrorDescription($objFtpServer.LastError) + ")" Write-Host $res $objFtpServer.Disconnect $res = "Disconnected." Write-Host $res $res ="Ready." Write-Host $res
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.