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

Examples

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

host *string

Remote host

uri *string

URI of the file to delete

errorOnMissing booleanstring

Defaultfalse

Raise error if missing

password string

Password

pluginDefaultsRef string

Reference (ref) of the pluginDefaults to apply to this task.

port string

Default445

Remote port

recursive booleanstring

Defaultfalse

Include subdirectories

If true, traverses subdirectories when deleting files matching regExp.

regExp string

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 string

Username

Outputs

deleted boolean

Defaultfalse

Whether the file or directory was deleted

uri string

Formaturi

The deleted URI

uris array

SubTypestring

URIs of all deleted files when regExp is used