Download file from an FTP server.
type: "io.kestra.plugin.fs.ftp.Download"Examples
id: fs_ftp_download
namespace: company.team
tasks:
- id: download
type: io.kestra.plugin.fs.ftp.Download
host: localhost
port: 21
username: foo
password: "{{ secret('FTP_PASSWORD') }}"
from: "/in/file.txt"
Properties
from *Requiredstring
The fully-qualified URIs that point to destination path
host *Requiredstring
Hostname of the remote server
enableSshRsa1 booleanstring
falseEnable the RSA/SHA1 algorithm (disabled by default)
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
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
from string
uriThe fully-qualified URIs that point to source data
to string
uriThe fully-qualified URIs that point to destination path
Definitions
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.