Download a file from an FTPS server.
type: "io.kestra.plugin.fs.ftps.Download"
Examples
id: fs_ftps_download
namespace: company.team
tasks:
- id: download
type: io.kestra.plugin.fs.ftps.Download
host: localhost
port: 990
username: foo
password: "{{ secret('FTPS_PASSWORD') }}"
from: "/in/file.txt"
Properties
from *Requiredstring
The fully-qualified URIs that point to destination path
host *Requiredstring
Hostname of the remote server
dataChannelProtectionLevel string
P
C
S
E
P
Sets the data channel protection level (PROT).
enableSshRsa1 booleanstring
false
Enable the RSA/SHA1 algorithm (disabled by default)
insecureTrustAllCertificates booleanstring
Whether the client should disable checking of the remote SSL certificate.
Note: This makes the SSL connection insecure, and should only be used for testing.
mode string
EXPLICIT
IMPLICIT
EXPLICIT
Sets FTPS mode, either "implicit" or "explicit".
options Non-dynamicFtpInterface-Options
{
"connectionTimeout": "PT30S",
"dataTimeout": "PT30S",
"socketTimeout": "PT30S",
"controlKeepAliveTimeout": "PT30S",
"controlKeepAliveReplyTimeout": "PT30S"
}
passiveMode booleanstring
true
Whether 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
990
Port of the remote server
proxyHost string
FTP proxy host
proxyPort string
FTP proxy port
proxyType string
DIRECT
HTTP
SOCKS
FTP proxy type
remoteIpVerification booleanstring
true
Control that the server ip that emit the request is the same than send response.
rootDir booleanstring
true
Is the path relative to the users home directory
username string
Username on the remote server
Outputs
from string
uri
The fully-qualified URIs that point to source data
to string
uri
The fully-qualified URIs that point to destination path
Definitions
io.kestra.plugin.fs.ftp.FtpInterface-Options
connectionTimeout string
PT30S
duration
The timeout for the initial control connection.
controlKeepAliveReplyTimeout string
PT30S
duration
The control keep alive reply timeout.
to ensure the socket be alive after download huge file.
controlKeepAliveTimeout string
PT30S
duration
the control keep alive timeout.
to ensure the socket be alive after download huge file.
dataTimeout string
PT30S
duration
The timeout for opening the data channel.
socketTimeout string
PT30S
duration
The socket timeout.