Downloads
Download multiple files from an SFTP server.
type: "io.kestra.plugin.fs.sftp.Downloads"Examples
Download a list of files and move it to an archive folders
id: fs_sftp_downloads
namespace: company.team
tasks:
- id: downloads
type: io.kestra.plugin.fs.sftp.Downloads
host: localhost
port: "22"
username: foo
password: "{{ secret('SFTP_PASSWORD') }}"
from: "/in/"
interval: PT10S
action: MOVE
moveDirectory: "/archive/"
Properties
from*Requiredstring
The directory to list
host*Requiredstring
Hostname of the remote server
actionstring
MOVEDELETENONEThe action to do on downloaded files
enableSshRsa1booleanstring
falseEnable the RSA/SHA1 algorithm (disabled by default)
keyExchangeAlgorithmstring
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.
keyfilestring
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
moveDirectorystring
The destination directory in case of MOVE
passphrasestring
Passphrase of the ssh key
passwordstring
Password on the remote server
portstring
22Port of the remote server
proxyAddressstring
SFTP proxy address
proxyPasswordstring
SFTP proxy password
proxyPortstring
SFTP proxy port
proxyTypestring
SFTP proxy type
proxyUsernamestring
SFTP proxy username
recursivebooleanstring
falseList file recursively
regExpstring
A regexp to filter on full path
rootDirbooleanstring
trueIs the path relative to the users home directory
usernamestring
Username on the remote server
Outputs
filesarray
Metadata of downloaded files.
io.kestra.plugin.fs.vfs.models.File
date-timeFOLDERFILEFILE_OR_FOLDERIMAGINARYurifalsedate-timeoutputFilesobject
The downloaded files as a map of from/to URIs.
