Downloads

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

Download multiple files from FTP server

Examples

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

id: fs_ftp_downloads
namespace: company.team

tasks:
  - id: downloads
    type: io.kestra.plugin.fs.ftp.Downloads
    host: localhost
    port: 21
    username: foo
    password: pass
    from: "/in/"
    interval: PT10S
    action: MOVE
    moveDirectory: "/archive/"

Properties

from

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

The directory to list

host

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

Hostname of the remote server

action

• Type: string
• Dynamic: ✔️
• Required: ❌
• Possible Values:
  • MOVE
  • DELETE
  • NONE

The action to do on downloaded files

moveDirectory

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

**The destination directory in case off MOVE **

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

recursive

• Type: boolean
• Dynamic: ❓
• Required: ❌
• Default: false

List file recursively

regExp

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

A regexp to filter on full path

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 path is relative to root dir

username

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

Username on the remote server

Outputs

files

• Type: array
• SubType: File
• SubType: File
• Required: ❌

Metadata of downloaded files.

outputFiles

• Type: object
• SubType: string
• Required: ❌

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

Definitions

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

Properties

accessDate

• Type: string
• Dynamic: ❓
• Required: ❓
• Format: date-time

fileType

• Type: string
• Dynamic: ❓
• Required: ❓
• Possible Values:
  • FOLDER
  • FILE
  • FILE_OR_FOLDER
  • IMAGINARY

flags

• Type: integer
• Dynamic: ❓
• Required: ❓

groupId

• Type: integer
• Dynamic: ❓
• Required: ❓

name

• Type: string
• Dynamic: ❓
• Required: ❓

path

• Type: string
• Dynamic: ❓
• Required: ❓
• Format: uri

permissions

• Type: integer
• Dynamic: ❓
• Required: ❓

size

• Type: integer
• Dynamic: ❓
• Required: ❓

symbolicLink

• Type: boolean
• Dynamic: ❓
• Required: ❓
• Default: false

updatedDate

• Type: string
• Dynamic: ❓
• Required: ❓
• Format: date-time

userId

• Type: integer
• Dynamic: ❓
• Required: ❓