PluginsPlugin FsFtp File Transfer Protocol

Downloads

Download multiple files from an FTP server.

yaml
type: "io.kestra.plugin.fs.ftp.Downloads"

Examples

Download a list of files and move it to an archive folders

yaml
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 *string

The directory to list

host *string

Hostname of the remote server

action string

Possible Values

MOVEDELETENONE

The action to do on downloaded files

enableSshRsa1 booleanstring

Default false

Enable the RSA/SHA1 algorithm (disabled by default)

moveDirectory string

The destination directory in case of MOVE

options FtpInterface-Options

Default

{
  "connectionTimeout": "PT30S",
  "dataTimeout": "PT30S",
  "socketTimeout": "PT30S",
  "controlKeepAliveTimeout": "PT30S",
  "controlKeepAliveReplyTimeout": "PT30S"
}

passiveMode booleanstring

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 string

Password on the remote server

port string

Default 21

Port of the remote server

proxyHost string

FTP proxy host

proxyPort string

FTP proxy port

proxyType string

Possible Values

DIRECTHTTPSOCKS

FTP proxy type

recursive booleanstring

Default false

List file recursively

regExp string

A regexp to filter on full path

remoteIpVerification booleanstring

Default true

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

rootDir booleanstring

Default true

Is the path relative to the users home directory

username string

Username on the remote server

Outputs

files array

SubType

Metadata of downloaded files.

outputFiles object

SubType string

The downloaded files as a map of from/to URIs.

Definitions

io.kestra.plugin.fs.vfs.models.File

accessDate string

Format date-time

fileType string

Possible Values

FOLDERFILEFILE_OR_FOLDERIMAGINARY

flags integer

groupId integer

name string

path string

Format uri

permissions integer

size integer

symbolicLink boolean

Default false

updatedDate string

Format date-time

userId integer

io.kestra.plugin.fs.ftp.FtpInterface-Options

connectionTimeout string

Default PT30S

Format duration

The timeout for the initial control connection.

controlKeepAliveReplyTimeout string

Default PT30S

Format duration

The control keep alive reply timeout.

to ensure the socket be alive after download huge file.

controlKeepAliveTimeout string

Default PT30S

Format duration

the control keep alive timeout.

to ensure the socket be alive after download huge file.

dataTimeout string

Default PT30S

Format duration

The timeout for opening the data channel.

socketTimeout string

Default PT30S

Format duration

The socket timeout.

​Downloads

Downloads