PowerShell

SFTP Sync Download Tree w/ Must-Match Directory Constraints

See more SFTP Examples

Demonstrates how SFTP synchronize a directory tree in the download direction, but only entering directories matching a set of wildcard filenames.

Note: This example requires Chilkat v9.5.0.76 or greater.

PowerShell

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

$sftp = New-Object Chilkat.SFtp

$success = $sftp.Connect("my-ssh-server.com",22)
if ($success -eq $true) {
    $success = $sftp.AuthenticatePw("mySshLogin","mySshPassword")
}

if ($success -eq $true) {
    $success = $sftp.InitializeSftp()
}

if ($success -ne $true) {
    $($sftp.LastErrorText)
    exit
}

# Possible synchronization modes are:
# mode=0: Download all files
# mode=1: Download all files that do not exist on the local filesystem.
# mode=2: Download newer or non-existant files.
# mode=3: Download only newer files. If a file does not already exist on the local filesystem, it is not downloaded from the server.
# mode=5: Download only missing files or files with size differences.
# mode=6: Same as mode 5, but also download newer files.

# Only enter remote directories named either "data" or matching "x*"
$sftp.SyncMustMatchDir = "data; x*"

# Imagine our remote directory tree has these files and directories:

# 	accentedLatin1.txt
# 	accentedUtf8.txt
# 	alice.key
# 	anter_cert.pem
# 	chiliPepper.gif
# 	helloWorld.pdf
# 	abc/chiliPepper.gif
# 	abc/ghk/
# 	data/chiliPepper.gif
# 	data/xyz/dkimHtmlBody.txt
# 	data/xyz/dkimVerifyTest.eml
# 	data/xyz/emailForCreateDsn.eml
# 	text/frenchUtf8.txt
# 	text/helloWorld.txt
# 	text/PolishEmailBody.txt
# 	text/something/

$remoteDir = "syncDownloadTest/someDir"
$localDir = "qa_output"
$mode = 0
$recursive = $true
$success = $sftp.SyncTreeDownload($remoteDir,$localDir,$mode,$recursive)
if ($success -ne $true) {
    $($sftp.LastErrorText)
    exit
}

# The following files were downloaded:

# accentedLatin1.txt
# accentedUtf8.txt
# alice.key
# anter_cert.pem
# chiliPepper.gif
# helloWorld.pdf
# data/chiliPepper.gif
# data/xyz/dkimHtmlBody.txt
# data/xyz/dkimVerifyTest.eml
# data/xyz/emailForCreateDsn.eml

$("Success.")