Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

The SFTP Delete action plugin is available in the Hub.

Plugin version: 1.5.1

Deletes the specified files from the SFTP server.

...

Property

Maco Enabled?

Description

Host

Yes

Required. Host name of the SFTP server.

Port

Yes

Optional. Port on which SFTP server is running.

Default is 22.

User Name

Yes

Required. Name of the user which will be used to connect to the SFTP server.

Authentication

Yes

Required. Specifies the type of Authentication that will be used to connect to the SFTP Server. Default is PrivateKey.

Private Key

Yes

Optional. Private RSA Key to be used to connect to the SFTP Server. This key is recommended to be stored in the Secure Key Store, and macro called into the Configuration. Must be a RSA key starting with —–BEGIN RSA PRIVATE KEY—–

Private Key Passphrase

Yes

Optional. Passphrase to be used with RSA Private Key if a Passphrase was specified when key was generated.

Password

Yes

Required. Password of the user.

Comma separated list of file names to delete

Yes

Comma separated list of files on the SFTP server to be deleted. Default value for this field is a Macro which will be substituted by SFTP copy plugin when this plugin is used with it.

Default is ${sftp.copied.file.names}.

Continue execution on error

No

Required. Boolean flag to determine whether to proceed with next files in case there is a failure in deletion of any particular file.

Default is false.

Properties for SSH

No

Optional. Specifies the properties that are used to configure SSH connection to the FTP server. For example to enable verbose logging add property 'LogLevel' with value 'VERBOSE'. To enable host key checking set 'StrictHostKeyChecking' to 'yes'. SSH can be configured with the properties described here 'https://linux.die.net/man/5/ssh_config'.