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
action string
MOVEDELETENONEThe action to do on downloaded files
enableSshRsa1 booleanstring
falseEnable the RSA/SHA1 algorithm (disabled by default)
moveDirectory string
The destination directory in case of MOVE
options Non-dynamicFtpInterface-Options
{
"connectionTimeout": "PT30S",
"dataTimeout": "PT30S",
"socketTimeout": "PT30S",
"controlKeepAliveTimeout": "PT30S",
"controlKeepAliveReplyTimeout": "PT30S"
}passiveMode booleanstring
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.
password string
Password on the remote server
port string
21Port of the remote server
proxyHost string
FTP proxy host
proxyPort string
FTP proxy port
proxyType string
DIRECTHTTPSOCKSFTP proxy type
recursive booleanstring
falseList file recursively
regExp string
A regexp to filter on full path
remoteIpVerification booleanstring
trueControl that the server ip that emit the request is the same than send response.
rootDir booleanstring
trueIs the path relative to the users home directory
username string
Username on the remote server
Outputs
Definitions
io.kestra.plugin.fs.vfs.models.File
accessDate string
date-timefileType string
FOLDERFILEFILE_OR_FOLDERIMAGINARYflags integer
groupId integer
name string
path string
uripermissions integer
size integer
symbolicLink boolean
falseupdatedDate string
date-timeuserId integer
io.kestra.plugin.fs.ftp.FtpInterface-Options
connectionTimeout string
PT30SdurationThe timeout for the initial control connection.
controlKeepAliveReplyTimeout string
PT30SdurationThe control keep alive reply timeout.
to ensure the socket be alive after download huge file.
controlKeepAliveTimeout string
PT30Sdurationthe control keep alive timeout.
to ensure the socket be alive after download huge file.
dataTimeout string
PT30SdurationThe timeout for opening the data channel.
socketTimeout string
PT30SdurationThe socket timeout.