Downloads
Download multiple files from an FTP server.
type: "io.kestra.plugin.fs.ftp.Downloads"Examples
Download a list of files and move it to an archive folders
id: fs_ftp_downloads
namespace: company.team
tasks:
- id: downloads
type: io.kestra.plugin.fs.ftp.Downloads
host: localhost
port: 21
username: foo
password: "{{ secret('FTP_PASSWORD') }}"
from: "/in/"
interval: PT10S
action: MOVE
moveDirectory: "/archive/"
Properties
from*Requiredstring
The directory to list
host*Requiredstring
Hostname of the remote server
actionstring
MOVEDELETENONEThe action to do on downloaded files
enableSshRsa1booleanstring
falseEnable the RSA/SHA1 algorithm (disabled by default)
moveDirectorystring
The destination directory in case of MOVE
optionsNon-dynamic
{
"connectionTimeout": "PT30S",
"dataTimeout": "PT30S",
"socketTimeout": "PT30S",
"controlKeepAliveTimeout": "PT30S",
"controlKeepAliveReplyTimeout": "PT30S"
}io.kestra.plugin.fs.ftp.FtpInterface-Options
PT30SdurationThe timeout for the initial control connection.
PT30SdurationThe control keep alive reply timeout.
PT30Sdurationthe control keep alive timeout.
to ensure the socket be alive after download huge file.
PT30SdurationThe timeout for opening the data channel.
PT30SdurationThe socket timeout.
passiveModebooleanstring
trueWhether to use a passive mode. Passive mode is generally considered more secure as it's less likely to encounter issues with NAT and firewalls. Therefore, this property is by default set to true. To use active mode instead, set the property to false.
passwordstring
Password on the remote server
portstring
21Port of the remote server
proxyHoststring
FTP proxy host
proxyPortstring
FTP proxy port
proxyTypestring
DIRECTHTTPSOCKSFTP proxy type
recursivebooleanstring
falseList file recursively
regExpstring
A regexp to filter on full path
remoteIpVerificationbooleanstring
trueControl that the server ip that emit the request is the same than send response.
rootDirbooleanstring
trueIs the path relative to the users home directory
usernamestring
Username on the remote server
Outputs
filesarray
Metadata of downloaded files.
io.kestra.plugin.fs.vfs.models.File
date-timeFOLDERFILEFILE_OR_FOLDERIMAGINARYurifalsedate-timeoutputFilesobject
The downloaded files as a map of from/to URIs.
