File system Trigger

File system Trigger

Certified

Trigger on new SMB files

Polls a share path on the interval and starts a Flow when new files appear. Sorted with sort (default NONE) before maxFiles truncation. Default port 445. Use action MOVE/DELETE to avoid reprocessing.

yaml
type: io.kestra.plugin.fs.smb.Trigger

Wait for one or more files in a given SMB server's directory and process each of these files sequentially. Then move them to another share which is used as an archive.

yaml
id: smb_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.smb.Trigger
    host: localhost
    port: "445"
    username: foo
    password: "{{ secret('SMB_PASSWORD') }}"
    from: "/my_share/in/"
    interval: PT10S
    action: MOVE
    moveDirectory: "/archive_share/"

Wait for one or more files in a given SMB server's directory and process each of these files sequentially. Then move them to another share which is used as an archive.

yaml
id: smb_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') }}"
      - id: delete
        type: io.kestra.plugin.fs.smb.Delete
        host: localhost
        port: "445"
        username: foo
        password: "{{ secret('SMB_PASSWORD') }}"
        uri: "/my_share/in/{{ taskrun.value | jq('.path') }}"

triggers:
  - id: watch
    type: io.kestra.plugin.fs.smb.Trigger
    host: localhost
    port: "445"
    username: foo
    password: "{{ secret('SMB_PASSWORD') }}"
    from: "/my_share/in/"
    interval: PT10S
    action: NONE

Wait for one or more files in a given SMB server's directory (composed of share name followed by dir path) and process each of these files sequentially. In this example, we restrict the trigger to only wait for CSV files in the mydir directory.

yaml
id: smb_wait_for_csv_in_my_share_my_dir
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.smb.Trigger
    host: localhost
    port: "445"
    username: foo
    password: "{{ secret('SMB_PASSWORD') }}"
    from: "my_share/mydir/"
    regExp: ".*.csv"
    action: MOVE
    moveDirectory: "my_share/archivedir"
    interval: PT10S
    sort: NAME_ASC
Properties
Possible Values
MOVEDELETENONE

Action to perform on retrieved files

If NONE, handle files in the Flow to avoid reprocessing.

Directory URI to watch

Remote host

Defaultfalse

Specifies whether a trigger is allowed to start a new execution even if a previous run is still in progress.

DefaultPT1M
Formatduration

Interval between trigger checks

Default25

Maximum files to process per poll

Destination directory when action is MOVE

DefaultCREATE_OR_UPDATE
Possible Values
CREATEUPDATECREATE_OR_UPDATE

Change event type to react to

Password

Default445

Remote port

Defaultfalse

List files recursively

Regexp filter on full path

DefaultNONE
Possible Values
NONELAST_MODIFIED_ASCLAST_MODIFIED_DESCNAME_ASCNAME_DESC

Sort order applied to pending files before maxFiles truncation

NONE (default) preserves the order returned by the share listing. LAST_MODIFIED_ASC/LAST_MODIFIED_DESC sort by last modified date, oldest/newest first. NAME_ASC/NAME_DESC sort alphabetically by file name.

Custom state key for deduplication

TTL for state entries

SubTypestring
Possible Values
CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

List of execution states after which a trigger should be stopped (a.k.a. disabled).

Username

Defaulttrue

A condition that determines whether the trigger should run.

A Pebble expression evaluated at trigger time. The trigger fires only when the expression evaluates to a truthy value (true, a non-empty string, a non-zero number). Use this to gate trigger execution on dynamic runtime values such as execution labels, flow variables, or environment conditions.

List of files that triggered the flow, each with its change type

Definitions
changeTypestring
Possible Values
CREATEUPDATE
accessDatestring
Formatdate-time
fileTypestring
Possible Values
FOLDERFILEFILE_OR_FOLDERIMAGINARY
flagsinteger
groupIdinteger
namestring
pathstring
Formaturi
permissionsinteger
sizeinteger
symbolicLinkboolean
Defaultfalse
updatedDatestring
Formatdate-time
userIdinteger

More Plugins in this Category

VMware (EE)
VMware
Enterprise

Tasks that automate VMware vSphere operations within Kestra workflows.

Infrastructure

33 tasks

3 blueprints

Canonical (EE)
Canonical
Enterprise

Tasks to interact with Canonical services, enabling automation and infrastructure management through API-driven workflows.

CloudInfrastructure

5 tasks