DeleteDirectory
Task for deleting SMB directories.
Last updated
Was this helpful?
Task for deleting SMB directories.
Task version: 2.2.0
Required Frends version: 5.7+
Required .NET version: 8.0
Compatible Agents: Crossplatform
DirectoryPath : String
Full path to the directory (relative to the share) we want to delete. If the folder already doesn't exist, nothing happens.
Default: -
Example: root\folder\newFolder
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
ThrowErrorOnFailure : Boolean
Whether to throw an error on failure.
Default: True
Example: false
ErrorMessageOnFailure : String
Overrides the error message on failure.
Default: -
Example: Custom error message
DeleteRecursively : Boolean
Whether to delete directories recursively.
Default: False
Example: false
Success : Boolean
Indicates if the task completed successfully.
Example: true
FullUncPath : PathString
Full path of the deleted directory.
Example: \host\share\dir\newDir
Error : Error
Error that occurred during task execution.
Example: object { string Message, Exception AdditionalInfo }
Changelog for Task Frends.Smb.DeleteDirectory.
Username parsing: now accepts a username without a domain instead of throwing an error.
Server connection: removed manual DNS resolve; connects using the raw server address string.
Input parameters treated as normal string instead of PathString type.
New connection parameters that defined what servers Operating System.
[Breaking Change] Introduce PathString type that will represent paths with OS specific separators.
Initial implementation
Last updated
Was this helpful?
Was this helpful?