FTP - Download Files to Shipyard

Overview

Quickly export one or more files from an FTP Server. The match type selected greatly affects how this Blueprint works.

This Blueprint requires read permissions in order to download from the FTP server.

Variables

Name	Reference	Type	Required	Default	Options	Description
Host	FTP_HOST	Alphanumeric	✅	-	-	The domain or the IP address of the FTP Server you want to connect to.
Port	FTP_PORT	Integer	✅	"21"	-	Number for the port to connect to. 21 is used by default.
Username	FTP_USERNAME	Alphanumeric	➖	-	-	Value of the configured username in the FTP server.
Password	FTP_PASSWORD	Password	➖	-	-	Value of the configured password associated to the username on the FTP server.
FTP Folder Name	FTP_SOURCE_FOLDER_NAME	Alphanumeric	➖	-	-	Name of the folder where the file is stored in the FTP server.
FTP File Name Match Type	FTP_SOURCE_FILE_NAME_MATCH_TYPE	Select	✅	exact_match	Exact Match: exact_match Regex Match: regex_match	Determines if the text in "FTP File Name" will look for one file with exact match, or multiple files using regex.
FTP File Name	FTP_SOURCE_FILE_NAME	Alphanumeric	✅	-	-	Name of the target file in the FTP server. Can be regex if "Match Type" is set accordingly.
Shipyard Folder Name	FTP_DESTINATION_FOLDER_NAME	Alphanumeric	➖	-	-	Folder where the file(s) should be downloaded. Leaving blank will place the file in the home directory.
Shipyard File Name	FTP_DESTINATION_FILE_NAME	Alphanumeric	➖	-	-	What to name the file(s) being downloaded. If left blank, defaults to the original file name(s).

YAML

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
  blueprint: FTP - Download Files to Shipyard
  inputs:
    FTP_HOST: null  ## REQUIRED
    FTP_PORT: '21' ## REQUIRED
    FTP_USERNAME: null
    FTP_PASSWORD: null
    FTP_SOURCE_FOLDER_NAME: null
    FTP_SOURCE_FILE_NAME_MATCH_TYPE: exact_match ## REQUIRED
    FTP_SOURCE_FILE_NAME: null ## REQUIRED
    FTP_DESTINATION_FOLDER_NAME: null
    FTP_DESTINATION_FILE_NAME: null
  type: BLUEPRINT
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - '202'
    - '210'