Download

type: "io.kestra.plugin.fs.ftp.Download"

Download file from FTP server

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: pass
    from: "/in/file.txt"

Properties

from

• Type: string
• Dynamic: ✔️
• Required: ✔️

The fully-qualified URIs that point to destination path

host

• Type: string
• Dynamic: ✔️
• Required: ✔️

Hostname of the remote server

passiveMode

• Type: boolean
• Dynamic: ❌
• Required: ❌
• Default: 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

• Type: string
• Dynamic: ✔️
• Required: ❌

Password on the remote server

port

• Type: string
• Dynamic: ✔️
• Required: ❌
• Default: 21

Port of the remote server

proxyHost

• Type: string
• Dynamic: ✔️
• Required: ❌

FTP proxy host

proxyPort

• Type: string
• Dynamic: ✔️
• Required: ❌

FTP proxy port

proxyType

• Type: string
• Dynamic: ✔️
• Required: ❌
• Possible Values:
  • DIRECT
  • HTTP
  • SOCKS

FTP proxy type

remoteIpVerification

• Type: boolean
• Dynamic: ❌
• Required: ❌
• Default: true

Control that the server ip that emit the request is the same than send response.

rootDir

• Type: boolean
• Dynamic: ❌
• Required: ❌
• Default: true

Is the path relative to the users home directory

username

• Type: string
• Dynamic: ✔️
• Required: ❌

Username on the remote server

Outputs

from

• Type: string
• Required: ❌
• Format: uri

The fully-qualified URIs that point to source data

to

• Type: string
• Required: ❌
• Format: uri

The fully-qualified URIs that point to destination path

Definitions