For the complete documentation index, see llms.txt. This page is also available as Markdown.

DeleteFiles

Deletes files from an SMB share by path or matching pattern.

Task version: 2.5.0

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Crossplatform

Task Parameters

Name
Description

Path : String

Path to the file or directory to delete, relative to the share.

If a file path is provided, only that file is deleted.

If a directory path is provided, only files located directly in that directory are deleted.

Default: - Example: folder/subfolder/

Name
Description

Server : String

SMB server address or hostname.

Default: - Example: 127.0.0.1

Share : String

SMB share name to connect to.

Default: - Example: testshare

Username : String

Username for SMB authentication.

This needs to be of format domain\username

Default: - Example: WORKGROUP\Administrator

🗝Password : String

Password for the SMB credentials.

Default: - Example: Password123

OperatingSystem : Os

Defines the operating system of the SMB server.

Options used to determine correct path separator to use.

Possible values:

  • Windows: Defines the operating system of the SMB server.

Options used to determine correct path separator to use.

  • Linux: Defines the operating system of the SMB server.

Options used to determine correct path separator to use.

Default: 2 Example: Linux

AuthenticationMode : AuthenticationMode

Authentication mechanism to use when connecting to the SMB server.

Kerberos requires network access to a KDC and a registered SPN (cifs/servername)

for the target server in Active Directory.

Possible values:

  • Ntlm: Authentication mechanism to use when connecting to the SMB server.

Kerberos requires network access to a KDC and a registered SPN (cifs/servername)

for the target server in Active Directory.

  • Kerberos: Authentication mechanism to use when connecting to the SMB server.

Kerberos requires network access to a KDC and a registered SPN (cifs/servername)

for the target server in Active Directory.

Default: 0 Example: Ntlm

KerberosServerName : String

Hostname used to build the Kerberos SPN (cifs/hostname) when AuthenticationMode is Kerberos.

Falls back to Server when not set. Only needed when the address used for the TCP

connection differs from the server's registered Kerberos identity - e.g.

where you connect via a mapped IP/port but the AD-registered name is something else.

Default: - Example: DC1.test.local

KdcAddress : String

Optional explicit KDC address (host or host:port) for Kerberos authentication.

Use when DNS SRV discovery is unavailable.

If empty, KDC will be discovered via DNS SRV records for the realm.

Default: - Example: kdc.company.com:88

Name
Description

PatternMatchingMode : PatternMatchingMode

Define how pattern matching will work.

Possible values:

  • Wildcards: Define how pattern matching will work.

  • Regex: Define how pattern matching will work.

Default: 2 Example: Regex

Pattern : String

Define how pattern matching will work.

Default: - Example: Regex

ContinueOnFailure : Boolean

When enabled, the task continues deleting remaining files even if individual file operations fail.

Successfully deleted files are returned in Files with Success = true. Failed files

are reported in Error.FileFailures with the reason for each failure.

Even if some files fail, the task will not throw regardless of the ThrowErrorOnFailure setting.

Default: False Example: false

ThrowErrorOnFailure : Boolean

Whether to throw an error on failure.

Default: True Example: true

ErrorMessageOnFailure : String

Overrides the error message on failure.

Default: - Example: Custom error message

Task Result

Name
Description

Success : Boolean

Indicates if the task completed successfully. Example: true

FilesDeleted : List<FileItem>

List of deleted files. Example: [ { "Name": "file1.txt", "Path": "Folder/file1.txt" } ]

TotalFilesDeleted : Int32

Total count of successfully deleted files. Example: 5

Error : Error

Error that occurred during task execution. Example: object { string Message, Exception AdditionalInfo }

Task Changelog

Changelog for Task Frends.Smb.DeleteFiles.

[2.5.0] - 2026-07-27

Added

  • Added Kerberos authentication support for SMB connections

    • New Connection.AuthenticationMode property with Ntlm (default) and Kerberos options

    • New Connection.KerberosServerName property for specifying the Kerberos SPN hostname when it differs from the TCP connection address

    • New Connection.KdcAddress property for explicit KDC address when DNS SRV discovery is unavailable

    • KerberosNetAuthenticationClient internally handles TGT acquisition, service ticket retrieval, and GSS-API token generation using the Kerberos.NET library

[2.4.0] - 2026-07-20

Fixed

  • Optimized SMB file handling: fixed lingering locks and adjusted access permissions to prevent sharing violations.

[2.3.0] - 2026-06-26

Changed

  • Username parsing: now accepts a username without a domain instead of throwing an error.

[2.2.0] - 2026-05-20

Added

  • Added ContinueOnFailure as a new option � allows the operation to proceed when individual file copies fail, collecting errors in a failures list instead of throwing immediately

[2.1.0] - 2026-04-23

Fixed

  • Input parameters treated as normal string instead of PathString type.

[2.0.0] - 2026-04-08

Added

  • New connection parameters that defined what servers Operating System.

  • [Breaking Change] Introduce PathString type that will represent paths with OS specific separators.

[1.2.0] - 2025-11-14

Changed

  • Update pattern matching

[1.1.0] - 2025-11-11

Changed

  • Update SMBLibrary version to 1.5.4.1.

[1.0.0] - 2025-11-04

Added

  • Initial implementation

Last updated

Was this helpful?