Download
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
host*Requiredstring
Hostname of the remote server
enableSshRsa1booleanstring
falseEnable the RSA/SHA1 algorithm (disabled by default)
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
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
fromstring
uriThe fully-qualified URIs that point to source data
tostring
uriThe fully-qualified URIs that point to destination path
