DeleteFiles
Frends Task for deleting files from FTPS server.
Task version: 1.0.0
Required Frends version: 5.5+
Required .NET version: 6.0
Compatible Agents: Crossplatform
Task Parameters
Directory : String
Full path of the target file to be deleted.
Default: /
Example: /destination
FileMask : String
Pattern to match (Optional).
If left empty, every file is deleted from given directory.
Default: -
Example: *.txt
FilePaths : Object
The paths to the files to be deleted, mainly meant to be used with the file trigger with the syntax: #trigger.data.filePaths
Default: -
Example: #trigger.data.filePaths
Address : String
FTP(S) host address.
Default: -
Example: my.ftp.server.com
Port : Int32
Port number to use in the connection to the server.
Default: 21
Example: 21
UserName : String
Username to use for authentication to the server. Note that the file endpoint only supports
username for remote shares and the username must be in the format DOMAIN\Username.
Default: -
Example: myUsername
🗝Password : String
Password to use in the authentication to the server.
Default: -
Example: myPassword
Mode : FtpMode
Connection mode to use to connect to the FTP server.
Possible values:
Passive: Connection mode to use to connect to the FTP server.Active: Connection mode to use to connect to the FTP server.
Default: 0
Example: FtpMode.Passive
KeepConnectionAliveInterval : Int32
Sends NOOP command to keep connection alive at specified time-interval in seconds. If set to 0 the connection is not kept alive. Default value is 0
Default: 0
Example: 60
ConnectionTimeout : Int32
The length of time, in seconds, until the connection times out. You can use value 0 to indicate that the connection does not time out. Default value is 60 seconds
Default: 60
Example: 60
Encoding : String
If set, this encoding will be used to encode and decode command parameters and server responses, such as file names. Example values: utf-8, utf-16, windows-1252
Default: -
Example: utf-8
BufferSize : Int32
Integer value of used buffer size as bytes.
Default value is 4 KB.
Default: 4096
Example: 4096
UseFTPS : Boolean
Whether to use FTPS or not.
Default: False
Example: false
SecureDataChannel : Boolean
Whether the data channel is secured or not.
Default: True
Example: true
SslMode : FtpsSslMode
Specifies whether to use Explicit or Implicit SSL
Possible values:
None: Specifies whether to use Explicit or Implicit SSLExplicit: Specifies whether to use Explicit or Implicit SSLImplicit: Specifies whether to use Explicit or Implicit SSLAuto: Specifies whether to use Explicit or Implicit SSL
Default: 0
Example: FtpsSslMode.None
EnableClientAuth : Boolean
If enabled the client certificate is searched from user's certificate store
Default: False
Example: false
ClientCertificateName : String
Optional. Enables certification search by name from the certification store of current user.
Default: -
Example: mycert.crt
ClientCertificateThumbprint : String
Optional. Enables certification search by thumbprint from the certification store of current user.
Default: -
Example: a909502dd82ae41433e6f83886b00d4277a32a7b
ValidateAnyCertificate : Boolean
If enabled the any certificate will be considered valid.
Default: False
Example: false
ClientCertificatePath : String
Path to client certificate (X509).
Default: -
Example: c:\example.cer
CertificateHashStringSHA1 : String
Certificate SHA1 hash string to validate against.
Default: -
Example: D911262984DE9CC32A3518A1094CD24249EA5C49
Task Result
Files : List<String>
Contains the input repeated the specified number of times.
Example: Example of the output
Task Changelog
Changelog for Task Frends.FTP.DeleteFiles.
[1.0.0] - 2024-02-20
Changed
Initial implementation
Last updated
Was this helpful?