PluginsFile systemTasksSftpList

List​List

List List

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

List files from a SFTP server directory

Examples

yaml
id: fs_sftp_list
namespace: company.team

tasks:
  - id: list
    type: io.kestra.plugin.fs.sftp.List
    host: localhost
    port: "22"
    username: foo
    password: pass
    from: "/upload/dir1/"
    regExp: ".*\/dir1\/.*.(yaml|yml)"

Properties

from

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

The fully-qualified URIs that point to 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

recursive

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

List file recursively

regExp

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

A regexp to filter on full path

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: File
  • Required: ❌

The list of files

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: ❓
  • Type: boolean
  • Dynamic: ❓
  • Required: ❓
  • Default: false
updatedDate
  • Type: string
  • Dynamic: ❓
  • Required: ❓
  • Format: date-time
userId
  • Type: integer
  • Dynamic: ❓
  • Required: ❓

Was this page helpful?