Skip to content

TSTool / Command / FTPGet

Overview

The FTPGet command retrieves one or more files from a remote system using file transfer protocol (FTP). The retrieval is not recursive to child folders.

Command Editor

The following dialog is used to edit the command and illustrates the command syntax.

FTPGet

FTPGet Command Editor (see also the full-size image)

Command Syntax

The command syntax is as follows:

FTPGet(Parameter="Value",...)

Command Parameters

Parameter                    Description Default                
RemoteSite
required		 The address of the remote site, for example: ftp.acme.com
Global properties can be used with the ${Property} syntax.		 None – must be specified.
Login The FTP login to use. anonymous
Password The FTP password to use. anonymous
RemoteFolder The folder on the remote site, for example: /outgoing/data
Global properties can be used with the ${Property} syntax.		 Root folder (/).
FilePattern The pattern to use to determine which files should be transferred. Simple patterns are used, where * is a wildcard. Global properties can be used with the ${Property} syntax. Retrieve all files in the RemoteFolder.
DestinationFolder
required		 The folder to receive the files, can be relative to the working directory. Global properties can be used with the ${Property} syntax. None – must be specified.
TransferMode The transfer mode:
  • ASCII – for text files
  • Binary – for binary files
 Binary
RetryCount The number of times to retry the login if it fails (e.g., due to busy site). 3
RetryWait The amount of time to wait between retries, seconds. 3

Examples

See the automated tests.

Troubleshooting

See Also