uxstr FTP GET - Retrieve Files

This section describes the uxstr FTP GET command used to retrieve files from a FTP server.

This command will retrieve one or more files from an FTP server. Its syntax is as follows:

uxstr FTP GET PARTNER=hostname [ORIGIN_FILENAME=filename] [ORIGIN_PATHNAME=path] [TARGET_FILENAME=filename] [TARGET_PATHNAME=path] [LOGON=username] [PASSWORD=password] [MODE=ASCII|BINARY] [ACTION=REPLACE|ABORT|NONE] [CRLF|NOCRLF] [DELETE|NODELETE] [NEWER|NONEWER] [RECURSIVE|NORECURSIVE] [BUFFER_SIZE=nn] [RETRY=n] [UMASK=nnn]

Description of Items

• PARTNER=

  Physical name or IP address of the target machine.
  Format: 255 alphanumeric characters.

• ORIGIN_FILENAME=
  (Optional) Name of the remote file to be retrieved.
  Format: 256 alphanumeric characters.

  Default: all files in the directory.

• ORIGIN_PATHNAME=

  (Optional) Remote directory.
  Format: 256 alphanumeric characters. * forbidden. Note that paths must be given like FTP paths, meaning that a path like "C:\Temp\Transfer" should be written: "C:/Temp/Transfer".

  Default: the FTP connection user’s home directory.

• TARGET_FILENAME=

  (Optional) Local file name.
  Format: 256 alphanumeric characters.

  Default : Unchanged.

• TARGET_PATHNAME=

  (Optional) Local file reception directory.
  Format: 256 alphanumeric characters.* forbidden.

  Default: the home directory of the Uproc submission user account.

• LOGON=

  (Optional) FTP connection user.
  Format: 32 alphanumeric characters.

  Default: anonymous

• PASSWORD=

  (Optional) FTP connection user password. Passwords are invisible in the GUI.
  Format: 32 alphanumeric characters.

• MODE=

  (Optional) Type of transfer (ASCII or BINARY)

  Default: ASCII

• ACTION=

  (Optional) Behavior if the target file exists:

  • REPLACE: replace the existing file
  • ABORT: cancel the transfer and exit with error
  • NONE: do nothing

  Default: ABORT

• CRLF | NOCRLF

  (Optional) CR characters conversion. Not available for FTP_PUT.

  • CRLF: Converts all CR characters to LF during ASCII transfer.
  • NOCRLF: No conversion by default except for submissions.

  Default: NOCRLF

• DELETE | NODELETE

  (Optional) Origin file deletion

  • DELETE: Deletes the origin file if the transfer is successful.
  • NODELETE: Keep the origin file if the transfer is successful.

  Default: NODELETE:

• NEWER | NONEWER

  (Optional) Check on the file date

  • NEWER: Transfers the file if its modification date is later than the target file.
  • NONEWER: Transfer the file whatever its date.

  Default: NONEWER

  Warning! This option is not supported by SFTP by default. To see if SFTP has been configured, see the node setting U_FT_SFTPU_FT_SFTP value.

• RECURSIVE | NORECURSIVE

  (Optional) Transferred files

  • RECURSIVE: Transfers whole files and sub directories of the ORIGIN_PATHNAME (the ORIGIN_FILENAME and the TARGET_FILENAME must not be edited). The recursion depth limit is set to 150 directories.
  • NORECURSIVE: Transfers files from the current directory.

  Default: NORECURSIVE.

  The RECURSIVE option uses the FTP LIST command internally to get a list of files and directories on the remote server. The expected server answer must be formatted so each line starts with the file permissions in UNIX format. Since this answer varies from a server to another, the feature will not work if the answer has a different format. Should this happen, a fail-over option is available: it tests each single file on the specified remote server location with a FTP CWD command to check the existence of a directory. The fail-over option is less performing but it can be enabled with the U_FT_GET_DIR_FAILOVER node setting in the "Node Settings – FTP Settings" category.

  When retrieving a directory in RECURSIVE mode using an FTP_GET Uproc, the Append mode is not supported, the Abort action is used by default.

• BUFFER_SIZE=

  (Optional) Sets the communications buffer size in blocks of 512 bytes.
  Format: integer/2n between 1 and 64.

  Default: FTP default

• RETRY=

  (Optional) Number of retries in case of failure.
  Format: one digit.

• UMASK=

  (Optional) Mask applied to local file permissions. If UMASK is not set or set to 000, files are downloaded with 666 permissions by default (for a root user) or 640 (for a non-root user). Otherwise, file permissions are obtained by subtracting UMASK from the default value (666 or 640).
  Format: 3 numerical characters.

Example

• Retrieves all files from the C:\tmp directory on the Win host in binary mode by applying a 700 mask and overwrites existing files:

  uxstr FTP GET PARTNER=”WinXP” ORIGIN_PATHNAME=”C:/tmp/” CRLF MODE=BINARY UMASK=700 ACTION=CANCEL RETRY=3