PluginsFile systemTasksSmb

Downloads​Downloads

yaml
type: "io.kestra.plugin.fs.smb.Downloads"

Download multiple files from a SMB (Samba for eg.) server

Examples

Download files from my_share and move them to an archive_share

yaml
id: fs_smb_downloads
namespace: company.team

tasks:
  - id: downloads
    type: io.kestra.plugin.fs.smb.Downloads
    host: localhost
    port: "445"
    username: foo
    password: pass
    from: "/my_share/"
    interval: PT10S
    action: MOVE
    moveDirectory: "/archive_share/"

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

password

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

Password on the remote server

port

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

Port of the remote server

recursive

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

regExp

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

A regexp to filter on full path

username

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

Username on the remote server

Outputs

files

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

outputFiles

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

Definitions

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

  • 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: ❓