Download

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

Download file from SFTP server

Examples

id: fs_sftp_download
namespace: company.team

tasks:
  - id: download
    type: io.kestra.plugin.fs.sftp.Download
    host: localhost
    port: "22"
    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

keyExchangeAlgorithm

• Type: string
• Dynamic: ❌
• Required: ❌

Configures Key exchange algorithm explicitly e. g diffie-hellman-group14-sha1, diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1, diffie-hellman-group1-sha1.

keyfile

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

Private keyfile in the PEM file format to connect to a remote server using SSH

To generate a PEM format key from OpenSSH, use the following command: ssh-keygen -m PEM

passphrase

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

Passphrase of the ssh key

password

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

Password on the remote server

port

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

Port of the remote server

proxyHost

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

SFTP proxy host

proxyPassword

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

SFTP proxy password

proxyPort

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

SFTP proxy port

proxyType

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

SFTP proxy type

proxyUser

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

SFTP proxy user

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