Sync WinSCPPath

Sync-WinSCPPath

SYNOPSIS

Synchronizes directories.

SYNTAX

Set 1

Sync-WinSCPPath [-WinSCPSession] <Session> [-Mode] <SynchronizationMode> [[-LocalPath] <String>] [[-RemotePath] <String>] [[-Criteria] <SynchronizationCriteria>] [[-TransferOptions] <TransferOptions>] [-Remove] [-Mirror] [<CommonParameters>]

DESCRIPTION

Synchronizes directories.

EXAMPLES

EXAMPLE 1

PS C:\> Sync-WinSCPPath -Mode Local


Uploads   : {}
Downloads : {/ftpDoc1.txt, /ftpDoc2.txt}
Removals  : {}
Failures  : {}
IsSuccess : True

EXAMPLE 2

PS C:\> Sync-WinSCPPath -Mode Both -Criteria Time


Uploads   : {C:\Users\us165614\Desktop\local\localDoc1.txt, C:\Users\us165614\Desktop\local\localDoc2.txt}
Downloads : {/ftpDoc1.txt, /ftpDoc2.txt}
Removals  : {}
Failures  : {}
IsSuccess : True

PARAMETERS

WinSCPSession

It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.

Type: Session
Parameter Sets: Set 1
Aliases: 

Required: true
Position: 0
Default Value: 
Pipeline Input: True (ByValue)

Mode

Synchronization mode. Possible values are SynchronizationMode.Local, SynchronizationMode.Remote and SynchronizationMode.Both.

Type: SynchronizationMode
Parameter Sets: Set 1
Aliases: 

Required: true
Position: 1
Default Value: 
Pipeline Input: false

LocalPath

Full path to local directory.

Type: String
Parameter Sets: Set 1
Aliases: 

Required: false
Position: 2
Default Value: 
Pipeline Input: false

RemotePath

Full path to remote directory.

Type: String
Parameter Sets: Set 1
Aliases: 

Required: false
Position: 3
Default Value: 
Pipeline Input: false

Remove

When set to true, deletes obsolete files. Cannot be used for SynchronizationMode.Both.

Type: SwitchParameter
Parameter Sets: Set 1
Aliases: 

Required: false
Position: named
Default Value: 
Pipeline Input: false

Mirror

When set to true, synchronizes in mirror mode (synchronizes also older files). Cannot be used for SynchronizationMode.Both. Defaults to false.

Type: SwitchParameter
Parameter Sets: Set 1
Aliases: 

Required: false
Position: named
Default Value: 
Pipeline Input: false

Criteria

Comparison criteria. Possible values are SynchronizationCriteria.None, SynchronizationCriteria.Time (default), SynchronizationCriteria.Size and SynchronizationCriteria.Either. For SynchronizationMode.Both SynchronizationCriteria.Time can be used only.

Type: SynchronizationCriteria
Parameter Sets: Set 1
Aliases: 

Required: false
Position: 4
Default Value: 
Pipeline Input: false

TransferOptions

Transfer options. Defaults to null, what is equivalent to New-WinSCPTransferOption.

Type: TransferOptions
Parameter Sets: Set 1
Aliases: 

Required: false
Position: 5
Default Value: 
Pipeline Input: false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

WinSCP.Session

OUTPUTS

WinSCP.SynchronizationResult

NOTES

RELATED LINKS

Online version:

WinSCP reference:

Generated by: PowerShell HelpWriter 2017 v2.1.36