<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.

Represents a command-line argument.

Parameters

Attribute	Type	Description	Required
dir	directory	The value for a directory-based command-line argument; will be replaced with the absolute path of the directory.	False
file	file	The name of a file as a single command-line argument; will be replaced with the absolute filename of the file.	False
if	bool	Indicates if the argument should be passed to the external program. If true then the argument will be passed; otherwise, skipped. The default is true.	False
line	string	List of command-line arguments; will be passed to the executable as is.	False
path	<path>	The value for a PATH-like command-line argument; you can use `:` or `;` as path separators and NAnt will convert it to the platform's local conventions, while resolving references to environment variables.	False
unless	bool	Indicates if the argument should not be passed to the external program. If false then the argument will be passed; otherwise, skipped. The default is false.	False
value	string	A single command-line argument; can contain space characters.	False

Nested Elements:

<path>

Sets a single command-line argument and treats it like a PATH - ensures the right separator for the local platform is used.

</path>

Examples

A single command-line argument containing a space character.
```
<arg value="-l -a" />
    
```
Two separate command-line arguments.
```
<arg line="-l -a" />
    
```
A single command-line argument with the value \dir;\dir2;\dir3 on DOS-based systems and /dir:/dir2:/dir3 on Unix-like systems.
```
<arg path="/dir;/dir2:\dir3" />
    
```

</arg>

Examples

Copy a single file to a remote server and path.

<scp file="myfile.zip" server="myServer" path="~" />

Requirements

Assembly: NAnt.Contrib.Tasks (0.85.2344.0)