File system Delete

File system Delete

Certified

Delete a file over SMB

Removes the specified file on an SMB/CIFS share. Default port 445.

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

Delete a single file

yaml
id: fs_smb_delete
namespace: company.team

tasks:
  - id: delete
    type: io.kestra.plugin.fs.smb.Delete
    host: localhost
    port: "445"
    username: foo
    password: "{{ secret('SMB_PASSWORD') }}"
    uri: "/my_share/dir1/file.txt"

Delete files matching a pattern

yaml
id: fs_smb_delete_regexp
namespace: company.team

tasks:
  - id: delete
    type: io.kestra.plugin.fs.smb.Delete
    host: localhost
    port: "445"
    username: foo
    password: "{{ secret('SMB_PASSWORD') }}"
    uri: "/my_share/dir1/"
    regExp: '.*\.csv'
Properties

Remote host

URI of the file to delete

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
Defaultfalse

Raise error if missing

Password

Default445

Remote port

Defaultfalse

Include subdirectories

If true, traverses subdirectories when deleting files matching regExp.

A regular expression to filter files for deletion

When set, uri must point to a directory. The pattern is matched against the share-relative path of each file (for example, /share_name/dir/file.csv). Only regular files are deleted; directories are skipped.

Username

Defaultfalse

Whether the file or directory was deleted

Formaturi

The deleted URI

SubTypestring

URIs of all deleted files when regExp is used