-
Notifications
You must be signed in to change notification settings - Fork 30
New WinSCPTransferOption
Defines options for file transfers.
New-WinSCPTransferOption [-Confirm] [-FileMask <String>] [-FilePermissions <FilePermissions>]
[-OverwriteMode <OverwriteMode>] [-PreserveTimestamp <Boolean>] [-ResumeSupport <TransferResumeSupport>]
[-SpeedLimit <Int32>] [-TransferMode <TransferMode>] [-WhatIf] [<CommonParameters>]
Defines options for file transfers.
PS C:\> New-WinSCPTransferOption
PreserveTimestamp : True
FilePermissions :
TransferMode : Binary
FileMask :
ResumeSupport : default
SpeedLimit : 0
OverwriteMode : Overwrite
PS C:\> New-WinSCPTransferOption -PreserveTimestamp:$false -FilePermissions (New-WinSCPItemPermission -OtherExecute)
PreserveTimestamp : False
FilePermissions : --------x
TransferMode : Binary
FileMask :
ResumeSupport : default
SpeedLimit : 0
OverwriteMode : Overwrite
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
See WinSCP Documentation for filemasks and usages: https://winscp.net/eng/docs/file_mask.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Permissions to applied to a remote file (used for uploads only). Use default null to keep default permissions.
Type: FilePermissions
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Behavior when overwriting existing files. Possible values are: OverwriteMode.Overwrite (default) to overwrite the existing files. OverwriteMode.Resume to assume that the existing and smaller file is a remnant of an interrupted transfer and resumes the transfer. SFTP and FTP protocols only. OverwriteMode.Append to append the source file to the end of existing target file. SFTP protocol only.
Type: OverwriteMode
Parameter Sets: (All)
Aliases:
Accepted values: Overwrite, Resume, Append
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Preserve timestamp (set last write time of destination file to that of source file). Defaults to true. When used with Session.SynchronizeDirectories, timestamp is always preserved, disregarding property value, unless criteria parameter is SynchronizationCriteria.None or SynchronizationCriteria.Size.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Configures automatic resume/transfer to temporary filename.
Type: TransferResumeSupport
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Limit transfer speed (in KB/s).
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Possible values are TransferMode.Binary (default), TransferMode.Ascii and TransferMode.Automatic (based on file extension).
Type: TransferMode
Parameter Sets: (All)
Aliases:
Accepted values: Binary, Ascii, Automatic
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.