<scp>

[This is preliminary documentation and subject to change.]

Copies a file to a remote server using scp.

Copies a file using scp to a remote server.

The Username Environment variable is used.

Parameters

Attribute Type Description Required
file string The file to transfer. True
server string The server to send the file to. True
basedir directory The directory in which the command will be executed. False
options string The command line arguments. False
path string The path on the remote server. The default is "~". False
program string The program to execute. The default is "scp". False
program-path-sep string The path separator used by the program. The default is "/". False
user string The username to connect as. The default is the value of the USERNAME environment variable. False
failonerror bool Determines if task failure stops the build, or is just reported. The default is true. False
if bool If true then the task will be executed; otherwise, skipped. The default is true. False
timeout int The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out. False
unless bool Opposite of if. If false then the task will be executed; otherwise, skipped. The default is false. False
verbose bool Determines whether the task should report detailed build log messages. The default is false. False

Framework-configurable parameters

Attribute Type Description Required
exename string The name of the executable that should be used to launch the external program. False
useruntimeengine bool Specifies whether the external program should be executed using a runtime engine, if configured. The default is false. False

Nested Elements:

<arg>

The command-line arguments for the external program.

Contains a collection of Argument elements.

</arg>

Examples

Requirements

Assembly: NAnt.Contrib.Tasks (0.85.1793.0)