FTP plug-in task reference

Edit online

The FTP tasks have arguments that you can specify.

Delete

The Delete task deletes files or directories from the remote server.

The following table shows the task arguments for the Delete task.

Table 1. Task arguments for the Delete task
Argument Description
File name Name of the files or directories to delete. Use the wildcard characters * and ? to match multiple files or directories.
Recursive If selected, delete directories and their contents recursively. If cleared, the task fails to delete a non-empty directory.

The default is cleared.

Delete directory

The Delete Directory task deletes directories from the remote server.

The following table shows the task argument for the Delete Directory task.

Table 2. Task argument for the Delete Directory task
Argument Description
Path Name of the directories to delete. Use the wildcard characters * and ? to match multiple directories.

Dir

The Dir task lists the content of a directory on the remote server.

The following table shows the task argument for the Dir task.

Table 3. Task argument for the Dir task
Argument Description
Directory The directory to list contents of.

Get

The Get task downloads files from the remote server to the local host where the task is run.

The following table shows the task arguments for the Get task.

Table 4. Task arguments for the Get task
Argument Description
Remote file The name of the files on the FTP server. Use the wildcard characters * and ? to specify multiple files on the server.
Local file The name of the file or directory where the content of the remote files are written to. When you get multiple files, this must be the name of a directory.
Overwrite If selected, overwrite existing files. If cleared, the task exits without overwriting existing files.

The default is cleared.

Make directory

The Make Directory task creates a directory on the remote server.

The following table shows the task arguments for the Make Directory task.

Table 5. Task arguments for the Make Directory task
Argument Description
Directory The name of the directory to create.

Move

The Move task moves files or directories on the remote FTP server.

The following table shows the task arguments for the Move task.

Table 6. Task arguments for the Move task
Argument Description
Source Name of the files or directories to move. Use the wildcard characters * and ? to match multiple files or directories.
Destination The new location of the files or directories. When you move multiple items, the destination must be a directory on the remote FTP server.
Overwrite If selected, overwrite existing files. If cleared, the task exits without overwriting existing files.

The default is cleared.

Put

The Put task uploads files from the local host where the task is being run to the remote FTP server.

The following table shows the task arguments for the Put task.

Table 7. Task arguments for the Put task
Argument Description
Local file The name of the files on the local host. Use the wildcard characters * and ? to specify multiple files.
Remote file The local file where the content of the local file is written. When you upload multiple files, the remote file must be a directory name.
Overwrite If selected, overwrite existing files. If cleared, the task exits without overwriting existing files.

The default is cleared.