Uploads Uploads

yaml
type: "io.kestra.plugin.fs.sftp.Uploads"

Upload files to a SFTP server's directory

Examples

yaml
id: fs_sftp_uploads
namespace: company.team

inputs:
  - id: file1
    type: FILE
  - id: file2
    type: FILE

tasks:
  - id: uploads
    type: io.kestra.plugin.fs.sftp.Uploads
    host: localhost
    port: "22"
    username: foo
    password: pass
    from:
      - "{{ inputs.file1 }}"
      - "{{ inputs.file2 }}"
    to: "/upload/dir2"

Properties

from

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

The files to upload, must be internal storage URIs, must be a list of URIs or a pebble template that returns a list of URIs

host

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

Hostname of the remote server

to

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

The destination directory

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

files

  • Type: array
  • SubType: string
  • Required:

The fully-qualified URIs that point to the uploaded files on remote

Definitions

Was this page helpful?