PowerShell-FTP

Collection of PowerShell cmdlets that can be used to interact with an FTP server using WinSCP or .NET. This supports FTP over SSH, FTP over SSL (Implicit or Explicit), and plain FTP connections.

How To Use

Uinsg WinSCP you first need to establish a WinSCP session using Connect-WinScpFTPSession. This takes a little time to complete and makes executing the other commands much faster when you have a few actions you want to take. When you are done you will want to use Disconnect-WinScpFtpSession to close the connection.

Cmdlet List

1. Connect-WinScpFtpSession Connect to a WinSCP FTP, FTPS, FTPES, or SFTP session
2. Disconnect-WinScpFtpSession Disconnect your WinSCP FTP, FTPS, FTPES, or SFTP Session
3. Get-WinScpChildItem Enumerate the contents of an FTP, FTPS, FTPES, or SFTP servers directory
4. Invoke-WinScpDownload Download files from a WinSCP FTP, FTPS, FTPES, or SFTP Server
5. Invoke-WinScpUpload Upload files from a WinSCP FTP, FTPS, FTPES, or SFTP Server
6. Get-FtpChildItem Returns a list of files from an FTP, FTPS, or FTPES server
7. Invoke-FtpDownload Downloads files from an FTP, FTPS, or FTPES server
8. Invoke-FtpUpload Uploads a file to an FTP, FTPS, or FTPES server

Examples

Connect-WinSCPFTPSession Examples

# SFTP Credential Connection
PS> Connect-WinSCPFTPSession -Protocol Sftp -Server 127.0.0.1 -Credential (Get-Credential) -LogSession
# This example logs and uses an FTP over SSH (SFTP) connection with 127.0.0.1 using a credential object. There is a 15 second timeout to connect to the destination server and any new host keys are automatically accepted

# SFTP Key Connection
PS> Connect-WinSCPFTPSession -Protocol Sftp -Server 127.0.0.1 -KeyUserName admin -SshPrivateKeyPassPhrase (ConvertTo-SecureString -String "Keypassword123!" -AsPlainText -Force) -SshPrivateKeyPath "C:\Users\admin\.ssh\id_rsa.ppk" -Timeout 15 -HostKeyPolicy AcceptNew -WinScpDllPath "C:\ProgramData\WinSCP\WinSCPnet.dll"
# This example uses an FTP over SSH (SFTP) connection with 127.0.0.1 using a password protected SSH key. There is a 15 second timeout to connect to the destination server and any new host keys are automatically accepted

# FTPS Implicit Connection
PS> Connect-WinSCPFTPSession -Protocol Ftp -FtpEncryption "Implicit" -Server 127.0.0.1 -Port 990 -HostKeyPolicy Check -FTPMode Passive -HostKeyPolicy Check -LogSession -LogPath "$env:TEMP\Logs\ftp-session.log"
# This example use a passive implicit FTP over SSL (FTPS) connection. There is a 15 second timeout to connect to the destination server and any new host keys will prompt for confirmation. This also logs the session connections to a custom log location

# FTPS Explicit Connection
PS> Connect-WinSCPFTPSession -Protocol Ftp -FtpEncryption "Explicit" -Server 127.0.0.1 -Port 21 -Credential (Get-Credential) -FTPMode Active -Timeout 15 -HostKeyPolicy GiveUpSecurityAndAcceptAny
# This example use an acive explicit FTP over SSL (FTPS) connection. There is a 15 second timeout to connect to the destination server and any new host keys will be ignored

DisConnect-WinSCPFTPSession Examples

Disconnect-WinSCPFTPSession

Disconnect-WinSCPFTPSession Examples

PS> Disconnect-WinSCPFTPSession
# This exmaple disconnects a WinSCP FTP Session using the $Global:WinSCPFTPSession variable which is created by Connect-WinSCPFTPSession

Get-WinSCPChildItem Examples

PS> Get-WinSCPChildItem -RemotePath "Test/"
# This example enumerates the contents of the Test directory on a WinSCP FTP server

PS> Get-WinSCPChildItem -RemotePath "Test/" -Recurse
# This example recursively enumerates the contents of the Test directory on a WinSCP FTP server.
# THIS DOES NOT WORK YET

Invoke-WinSCPDownload Examples

PS> Invoke-WinSCPDownload -LocalPath "$env:USERPROFILE\Downloads" -RemotePath @("Test/","Dev/")
# This example downloads the contents of Dev/ and Test/ on the FTP server to $env:USERPROFILE\Downloads on the local machine

PS> Invoke-WinSCPDownload -LocalPath "$env:USERPROFILE\Downloads" -RemotePath @("Test/","Dev/") -EnumerateDirectory
# This example downloads the contents of Dev/ and Test/ on the FTP server to $env:USERPROFILE\Downloads on the local machine and enumerates the contents of the directories

Invoke-WinSCPUpload Examples

PS> Invoke-WinSCPUpload -Path "C:\Users\Administrator\Documents\importantfile.txt","C:\Users\Administrator\Documents\otherfile2.txt" -Destination "C:\SFTP\Uploads"
# This example copies the importantfile.txt and otherfile2.txt to the WinSCP destination C:\SFTP\Uploads using passive FTP over SSH (SFTP). There is a 15 second timeout to connect to the destination server and any new host keys are automatically accepted

PS> Invoke-WinSCPUpload -Path "C:\Users\Administrator\Documents\importantfile.txt","C:\Users\Administrator\Documents\otherfile2.txt" -Destination "C:\SFTP\Uploads" -EnumerateDirectory
# This example copies the importantfile.txt and otherfile2.txt to the WinSCP destination C:\SFTP\Uploads using passive FTP over SSH (SFTP) and lists the contents of the destination directory. There is a 15 second timeout to connect to the destination server and any new host keys are automatically accepted

The below cmdlets do not use the WinSCP dll and can communicate with any FTP, FTPS, or FTPES server

Get-FtpChildItem Examples

PS> Get-FtpChildItem -FtpServer localhost -SourceDirectory "/" -UseActive $True
# This example enumerates the files in the FTP root directory over an FTP active ASCII connection wihtout credentials

PS> Get-FtpChildItem -FtpServer localhost -SourceDirectory "/" -UseSSL $True
# This example enumerates the files in the FTP root directory only over FTPES passive ASCII connection using TLSv1.2 wihtout credentials

PS> Get-FtpChildItem -FtpServer localhost -SourceDirectory "/" -UseSSL $True -UseBinary $False -UsePassive $True -TlsVersion Tls12 -KeepAlive $False
# This example enumerates the files in the FTP root directory only over FTPES passive ASCII connection using TLSv1.2 wihtout credentials

PS> Get-FtpChildItem -FtpServer localhost -SourceDirectory "/" -UseSSL $True -UseBinary $False -UsePassive $True -TlsVersion Tls12 -KeepAlive $False -IgnoreCertificateValidation $True -Credential (Get-Credential)
# This example enumerates the files in the FTP root directory only over FTPES passive ASCII connection using TLSv1.2 and ignores certificate validation errors and prompts for FTP credentials

Invoke-FtpDownload Examples

PS> Invoke-FtpDownload -SourceUri ftp://127.0.0.1:21/test.txt -Destination C:\Temp\test.txt
# This example downloads test.txt and saves it in C:\Temp over an FTP passive connection without credentials

PS> Invoke-FtpDownload -SourceUri ftp://127.0.0.1:21/test.txt -Destination C:\Temp\test.txt -UsePassive $True -KeepAlive $False -Credential (Get-Credential)
# This example downloads test.txt and saves it in C:\Temp over an FTP passive connection with credentials

PS> Invoke-FtpDownload -SourceUri ftp://127.0.0.1:21/test.txt -Destination C:\Temp\test.txt -UsePassive $True -KeepAlive $False -UseSSL $True -IgnoreCertificateValidation $True -Credential (Get-Credential)
# This example downloads test.txt and saves it in C:\Temp over an FTPES passive connection with credentials that ignores certificate validation errors

Invoke-FtpUpload Examples

PS> Invoke-FtpUpload -Path C:\Temp\test.txt -Destination "/"
# This example uploads test.txt and saves it in the FTP root directory using a passive connection without credentials

PS> Invoke-FtpUpload -Path C:\Temp\test.txt -Destination "/" -UsePassive $True -KeepAlive $False -Credential (Get-Credential)
# This example downloads test.txt and saves it in to the FTP root directory over a passive connection with credentials

PS> Invoke-FtpUpload -Path C:\Temp\test.txt -Destination "/" -UsePassive $True -KeepAlive $False -UseSSL $True -IgnoreCertificateValidation $True -Credential (Get-Credential)
# This example uploads test.txt and saves it in to the FTP root directory over a passive connection with credentials that ignores certificate validation errors