Plugin FsSftp Ssh File Transfer Protocol

Trigger

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

Examples

yaml
id: sftp_trigger_flow
namespace: company.team

tasks:
  - id: for_each_file
    type: io.kestra.plugin.core.flow.ForEach
    values: "{{ trigger.files }}"
    tasks:
      - id: return
        type: io.kestra.plugin.core.debug.Return
        format: "{{ taskrun.value | jq('.path') }}"

triggers:
  - id: watch
    type: io.kestra.plugin.fs.sftp.Trigger
    host: localhost
    port: 6622
    username: foo
    password: "{{ secret('SFTP_PASSWORD') }}"
    from: "/in/"
    interval: PT10S
    action: MOVE
    moveDirectory: "/archive/"

yaml
id: sftp_trigger_flow
namespace: company.team

tasks:
  - id: for_each_file
    type: io.kestra.plugin.core.flow.ForEach
    values: "{{ trigger.files | jq('.path') }}"
    tasks:
      - id: return
        type: io.kestra.plugin.core.debug.Return
        format: "{{ taskrun.value }}"
      - id: delete
        type: io.kestra.plugin.fs.sftp.Delete
        host: localhost
        port: 6622
        username: foo
        password: bar
        uri: "/in/{{ taskrun.value }}"

triggers:
  - id: watch
    type: io.kestra.plugin.fs.sftp.Trigger
    host: localhost
    port: 6622
    username: foo
    password: bar
    from: "/in/"
    interval: PT10S
    action: NONE

yaml
id: ftp_wait_for_csv_in_mydir
namespace: company.team

tasks:
  - id: each
    type: io.kestra.plugin.core.flow.ForEach
    values: "{{ trigger.files }}"
    tasks:
      - id: return
        type: io.kestra.plugin.core.debug.Return
        format: "{{ taskrun.value | jq('.path') }}"

triggers:
  - id: watch
    type: io.kestra.plugin.fs.sftp.Trigger
    host: localhost
    port: "6622"
    username: foo
    password: bar
    from: "mydir/"
    regExp: ".*.csv"
    action: MOVE
    moveDirectory: "archive/"
    interval: PTS

Properties

action *string

Possible Values

MOVEDELETENONE

from *string

host *string

conditions DateTimeBetween DayWeek DayWeekInMonth ExecutionFlow ExecutionLabels ExecutionNamespace ExecutionOutputs ExecutionStatus Expression FlowCondition FlowNamespaceCondition HasRetryAttempt MultipleCondition Not Or PublicHoliday TimeBetween Weekend

enableSshRsa1 booleanstring

Default false

interval string

Default PT1M

Format duration

keyExchangeAlgorithm string

keyfile string

moveDirectory string

passphrase string

password string

port string

Default 22

proxyHost string

proxyPassword string

proxyPort string

proxyType string

proxyUser string

recursive booleanstring

Default false

regExp string

rootDir booleanstring

Default true

stopAfter array

SubType string

Possible Values

CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINT

username string

Outputs

files array

SubType

outputFiles object

SubType string

Definitions

io.kestra.core.models.triggers.TimeWindow

deadline string

Format partial-time

endTime string

Format partial-time

startTime string

Format partial-time

type string

Default DURATION_WINDOW

Possible Values

DAILY_TIME_DEADLINEDAILY_TIME_WINDOWDURATION_WINDOWSLIDING_WINDOW

window string

Format duration

windowAdvance string

Format duration

Condition for a specific flow of an execution.

flowId *string

namespace *string

type *object

Condition for a flow namespace.

namespace *string

type *object

prefix boolean

Default false

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

accessDate string

Format date-time

fileType string

Possible Values

FOLDERFILEFILE_OR_FOLDERIMAGINARY

flags integer

groupId integer

name string

path string

Format uri

permissions integer

size integer

symbolicLink boolean

Default false

updatedDate string

Format date-time

userId integer

Condition for a specific flow. Note that this condition is deprecated, use `io.kestra.plugin.core.condition.ExecutionFlow` instead.

flowId *string

namespace *string

type *object

Condition to allow events between two specific times.

type *object

after string

Format time

before string

Format time

date string

Default {{ trigger.date }}

Condition that checks labels of an execution.

labels *arrayobject

type *object

Condition based on the outputs of an upstream execution.

expression *booleanstring

type *object

Condition to allow events on weekend.

type *object

date string

Default {{ trigger.date }}

Condition to have at least one condition validated.

conditions *DateTimeBetween DayWeek DayWeekInMonth ExecutionFlow ExecutionLabels ExecutionNamespace ExecutionOutputs ExecutionStatus Expression FlowCondition FlowNamespaceCondition HasRetryAttempt MultipleCondition Not Or PublicHoliday TimeBetween Weekend

Min items 1

type *object

Condition for an execution namespace.

namespace *string

type *object

comparison string

Possible Values

EQUALSPREFIXSUFFIX

prefix booleanstring

Default false

Run a flow if the list of preconditions is met in a time window.

conditions *object

SubType

id *string

Validation RegExp ^[a-zA-Z0-9][a-zA-Z0-9_-]*

Min length 1

type *object

resetOnSuccess boolean

Default true

timeWindow TimeWindow

Default

{
  "type": "DURATION_WINDOW"
}

Condition to exclude other conditions.

Min items 1

type *object

Condition to execute tasks on a specific day of the week relative to the current month (first, last, ...)

dayInMonth *string

Possible Values

FIRSTLASTSECONDTHIRDFOURTH

dayOfWeek *string

Possible Values

MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY

type *object

date string

Default {{ trigger.date }}

Condition based on variable expression.

expression *string

type *object

Condition to allow events on a particular day of the week.

dayOfWeek *string

Possible Values

MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY

type *object

date string

Default {{ trigger.date }}

Condition based on execution status.

type *object

in array

SubType string

Possible Values

CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINT

notIn array

SubType string

Possible Values

CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINT

Condition to allow events between two specific datetime values.

type *object

after string

Format date-time

before string

Format date-time

date string

Default {{ trigger.date }}

Condition that matches if any taskRun has retry attempts.

type *object

in array

SubType string

Possible Values

CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINT

notIn array

SubType string

Possible Values

CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINT

Condition to allow events on public holidays.

type *object

country string

date string

Default {{ trigger.date }}

subDivision string

​Trigger

Trigger