put command

put <file> [ [ <file2> ... ] <directory>/[ <newname> ] ]

If only one parameter is specified, uploads the file to remote working directory. If more parameters are specified, all except the last one specify set of files to upload. Filename can be replaced with Windows wildcard1 to select multiple files. To upload all files in a directory, use mask *.

The last parameter specifies target remote directory and optionally operation mask to store file(s) under different name. Target directory must end with slash. To upload more files to current working directory use ./ as the last parameter.

With the /stdin command-line switch, - can be used as a source to stream the standard input of winscp.com to remote server. Streaming is supported with the SFTP and FTP protocols only.

When specific file name is used, command fails when the file does not exist. When wildcard is used, command succeeds, without doing anything, if the wildcard does not match any file, by default (you can change this using option failonnomatch on command).

You can have WinSCP generate a code template for put for you.

See also synchronize, if you need to transfer modified files only.

Switches:

Aliases: send, mput

Effective options: confirm, reconnecttime, failonnomatch

XML log elements: upload, mkdir, chmod (with -permissions), touch (with -preservetime)

put index.html

put -delete index.html about.html ./

put -permissions=644 index.html about.html /home/martin/public_html/

put d:\www\index.html about.*

put *.html *.png /home/martin/backup/*.bak

put -filemask=*.html -resumesupport=on *

When converting script to .NET Assembly, map put command to Session.PutFiles method.

Parameters mapping: Command parameter file maps to method parameter localPath. When multiple source file parameters are used, you need to call Session.PutFiles multiple times. Command parameter directory/newname maps to method parameter remotePath. You have to convert relative paths to absolute paths.

Switches mapping:

To emulate the (default) option batch abort mode, call TransferOperationResult.Check on method’s result. See also Capturing results of operations.

For example, following script snippet:

cd /home/martinp
lcd d:\
...
put -delete -filemask=*>1M -resumesupport=off *.txt *.xml web/

maps to following PowerShell code:

$transferOptions = New-Object WinSCP.TransferOptions
# -filemask=*>1M
$transferOptions.FileMask = "*>1M"
# -resumesupport=off
$transferOptions.ResumeSupport.State = [WinSCP.TransferResumeSupportState]::Off
# Absolute paths + $True for -delete + Two calls for two source parameters
# + calling Check on result to emulate the (default) "option batch abort" mode
$session.PutFiles("d:\*.txt", "/home/martinp/web/", $True, $transferOptions).Check()
$session.PutFiles("d:\*.xml", "/home/martinp/web/", $True, $transferOptions).Check()