Skip to main content

SFTP - Move or Rename Files

Overview​

Quickly move or rename one or more files from an SFTP Server. The match type selected greatly affects how this Blueprint works.

This Blueprint requires write permissions in order to move objects from the SFTP server.

Variables​

NameReferenceTypeRequiredDefaultOptionsDescription
HostSFTP_HOSTAlphanumericβœ…--The domain or the IP address of the SFTP Server you want to connect to.
PortSFTP_PORTIntegerβœ…"22"-Number for the port to connect to. 22 is used by default.
UsernameSFTP_USERNAMEAlphanumericβž–--Value of the configured username in the SFTP server.
PasswordSFTP_PASSWORDPasswordβž–--Value of the configured password associated to the username on the SFTP server.
RSA Key FileSFTP_RSK_KEYAlphanumericβž–--The private key file used to authenticate via ssh into the SFTP server
SFTP File Name Match TypeSFTP_SOURCE_FILE_NAME_MATCH_TYPESelectβœ…exact_matchExact Match: exact_match

Regex Match: regex_match

Determines if the text in "SFTP File Name" will look for one file with exact match, or multiple files using regex.
SFTP Folder NameSFTP_SOURCE_FOLDER_NAMEAlphanumericβž–--Name of the folder where the file is stored in the SFTP server. If left blank, will look in the root directory.
SFTP File NameSFTP_SOURCE_FILE_NAMEAlphanumericβœ…--Name of the target file in the SFTP server. Can be regex if "Match Type" is set accordingly.
Destination Folder NameSFTP_DESTINATION_FOLDER_NAMEAlphanumericβž–--The name of the folder where the target file will be moved. Leaving blank will default to the root directory.
Destination File NameSFTP_DESTINATION_FILE_NAMEAlphanumericβž–--Name of the file for the target file once it is moved. If left blank, the original file name will be retained

YAML​

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

source:
blueprint: SFTP - Move or Rename Files
inputs:
SFTP_HOST: null ## REQUIRED
SFTP_PORT: '22' ## REQUIRED
SFTP_USERNAME: null
SFTP_PASSWORD: null
SFTP_RSK_KEY: null
SFTP_SOURCE_FILE_NAME_MATCH_TYPE: exact_match ## REQUIRED
SFTP_SOURCE_FOLDER_NAME: null
SFTP_SOURCE_FILE_NAME: null ## REQUIRED
SFTP_DESTINATION_FOLDER_NAME: null
SFTP_DESTINATION_FILE_NAME: null
type: BLUEPRINT
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- '200'
- '202'
- '207'
- '210'