Created
October 19, 2020 23:52
-
-
Save peaeater/ada09593ae5f3b60068e7b4be3f89b20 to your computer and use it in GitHub Desktop.
Powershell using WinSCP to sync directories over SFTP with file mask.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<# | |
Sync a local to remote directory in SFTP mode | |
#> | |
param( | |
[Parameter(Mandatory = $false, Position = 0)] | |
[string]$logsrc = "", | |
[Parameter(Mandatory = $true, Position = 1)] | |
[string]$hostname, | |
[Parameter(Mandatory = $true, Position = 2)] | |
[string]$username, | |
[Parameter(Mandatory = $true, Position = 3)] | |
[string]$password, | |
[Parameter(Mandatory = $true, Position = 4)] | |
[string]$fingerprint, | |
[Parameter(Mandatory = $false, Position = 5)] | |
[int]$port = 21, | |
[Parameter(Mandatory=$false,Position=6)] | |
[string]$remotePath = "/sync", | |
[Parameter(Mandatory = $true, Position = 7)] | |
[string]$localPath, | |
[Parameter(Mandatory=$false,Position=8)] | |
[string]$winscp = "C:\Program Files (x86)\WinSCP\WinSCPNET.dll", | |
[Parameter(Mandatory=$false)] | |
[string]$filemask = $null | |
) | |
. .\helper.logging.ps1 | |
function fileTransferred { | |
param($e) | |
# file transfer status | |
if ($null -eq $e.Error) { | |
logInfo -logsrc $logsrc -msg ("INFO {0} upload OK" -f $e.FileName) | |
} | |
else { | |
logError -logsrc $logsrc -msg ("ERROR {0} upload failure: {1}" -f $e.FileName, $e.Error) | |
exit 1 | |
} | |
# file permissions status | |
if ($null -ne $e.Chmod) { | |
if ($null -ne $e.Chmod.Error) { | |
logError -logsrc $logsrc -msg ("ERROR {0} set permissions failure: {1}" -f $e.Chmod.FileName, $e.Chmod.Error) | |
} | |
} | |
# timestamp status | |
if ($null -ne $e.Touch) { | |
if ($null -ne $e.Touch.Error) { | |
logError -logsrc $logsrc -msg ("ERROR {0} set timestamp failure: {1}" -f $e.Touch.FileName, $e.Touch.Error) | |
} | |
} | |
} | |
<# | |
Push files to remote server. | |
#> | |
try { | |
# load winscp assembly | |
Add-Type -Path $winscp | |
# session options | |
$sessionOptions = New-Object WinSCP.SessionOptions | |
$sessionOptions.HostName = $hostname | |
$sessionOptions.UserName = $username | |
$sessionOptions.Password = $password | |
$sessionOptions.PortNumber = $port | |
$sessionOptions.Protocol = [WinSCP.Protocol]::Sftp | |
$sessionOptions.SshHostKeyFingerprint = $fingerprint | |
$session = New-Object WinSCP.Session | |
# sync dirs | |
try { | |
# continuously report sync progress | |
$session.add_FileTransferred( { fileTransferred($_) } ) | |
# connect | |
$session.Open($sessionOptions) | |
# apply file mask | |
$transferOptions = $null | |
if ($null -ne $filemask) { | |
$transferOptions = New-Object WinSCP.TransferOptions | |
$transferOptions.FileMask = $filemask | |
} | |
# sync files 1 direction, from local => remote. Push all local files, newer and older, and delete obsolete remote files. | |
$syncResult = $session.SynchronizeDirectories([WinSCP.SynchronizationMode]::Remote, $localPath, $remotePath, $true, $true, [WinSCP.SynchronizationCriteria]::Time, $transferOptions) | |
# throw exception for any error | |
$syncResult.Check() | |
$uploadCount = $syncResult.Uploads.Count | |
$downloadCount = $syncResults.Downloads.Count | |
$removalCount = $syncResults.Removals.Count | |
logInfo -logsrc $logsrc -msg (("File sync to {0} successful: {1} uploaded, {2} downloaded, {3} removed." -f $hostname, $uploadCount, $downloadCount, $removalCount)) | |
} | |
finally { | |
# disconnect, clean up | |
$session.Dispose() | |
} | |
exit 0 | |
} | |
catch [Exception] { | |
# any uncaught exception bubbles up here | |
logError -logsrc $logsrc -msg $_.Exception | |
exit 1 | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment