DeleteSFTP
Description
Deletes a file residing on an SFTP server.
Tags
delete, remote, remove, sftp
Properties
In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Directory Path * | Directory Path | ${path} | The path to the directory the file to delete is located in. Supports Expression Language, using FlowFile attributes and Environment variables. | |
| Filename * | Filename | ${filename} | The name of the file to delete. Supports Expression Language, using FlowFile attributes and Environment variables. | |
| Hostname * | Hostname | The fully qualified hostname or IP address of the remote system Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Port * | Port | 22 | The port that the remote system is listening on for file transfers Supports Expression Language, using FlowFile attributes and Environment variables. | |
| Username * | Username | Username Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Password | Password | Password for the user account Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Private Key Path | Private Key Path | The fully qualified path to the Private Key file Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Private Key Passphrase | Private Key Passphrase | Password for the private key Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Strict Host Key Checking * | Strict Host Key Checking | false |
| Indicates whether or not strict enforcement of hosts keys should be applied |
| Host Key File | Host Key File | If supplied, the given file will be used as the Host Key; otherwise, if 'Strict Host Key Checking' property is applied (set to true) then uses the 'known_hosts' and 'known_hosts2' files from ~/.ssh directory else no host key file will be used | ||
| Batch Size * | Batch Size | 500 | The maximum number of FlowFiles to send in a single connection | |
| Connection Timeout * | Connection Timeout | 30 sec | Amount of time to wait before timing out while creating a connection | |
| Data Timeout * | Data Timeout | 30 sec | When transferring a file between the local and remote system, this value specifies how long is allowed to elapse without any data being transferred between systems | |
| Send Keep Alive On Timeout * | Send Keep Alive On Timeout | true |
| Send a Keep Alive message every 5 seconds up to 5 times for an overall timeout of 25 seconds. |
| Use Compression * | Use Compression | false |
| Indicates whether or not ZLIB compression should be used when transferring files |
| Proxy Configuration Service | proxy-configuration-service | Controller Service: ProxyConfigurationService Implementations: StandardProxyConfigurationService | Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN, SOCKS + AuthN | |
| Ciphers Allowed | Ciphers Allowed | A comma-separated list of Ciphers allowed for SFTP connections. Leave unset to allow all. Available options are: 3des-cbc, 3des-ctr, aes128-cbc, aes128-ctr, aes128-gcm@openssh.com, aes192-cbc, aes192-ctr, aes256-cbc, aes256-ctr, aes256-gcm@openssh.com, arcfour, arcfour128, arcfour256, blowfish-cbc, blowfish-ctr, cast128-cbc, cast128-ctr, chacha20-poly1305@openssh.com, idea-cbc, idea-ctr, serpent128-cbc, serpent128-ctr, serpent192-cbc, serpent192-ctr, serpent256-cbc, serpent256-ctr, twofish-cbc, twofish128-cbc, twofish128-ctr, twofish192-cbc, twofish192-ctr, twofish256-cbc, twofish256-ctr Supports Expression Language, using Environment variables. | ||
| Key Algorithms Allowed | Key Algorithms Allowed | A comma-separated list of Key Algorithms allowed for SFTP connections. Leave unset to allow all. Available options are: ecdsa-sha2-nistp256, ecdsa-sha2-nistp256-cert-v01@openssh.com, ecdsa-sha2-nistp384, ecdsa-sha2-nistp384-cert-v01@openssh.com, ecdsa-sha2-nistp521, ecdsa-sha2-nistp521-cert-v01@openssh.com, rsa-sha2-256, rsa-sha2-512, ssh-dss, ssh-dss-cert-v01@openssh.com, ssh-ed25519, ssh-ed25519-cert-v01@openssh.com, ssh-rsa, ssh-rsa-cert-v01@openssh.com Supports Expression Language, using Environment variables. | ||
| Key Exchange Algorithms Allowed | Key Exchange Algorithms Allowed | A comma-separated list of Key Exchange Algorithms allowed for SFTP connections. Leave unset to allow all. Available options are: curve25519-sha256, curve25519-sha256@libssh.org, diffie-hellman-group-exchange-sha1, diffie-hellman-group-exchange-sha256, diffie-hellman-group1-sha1, diffie-hellman-group14-sha1, diffie-hellman-group14-sha256, diffie-hellman-group14-sha256@ssh.com, diffie-hellman-group15-sha256, diffie-hellman-group15-sha256@ssh.com, diffie-hellman-group15-sha384@ssh.com, diffie-hellman-group15-sha512, diffie-hellman-group16-sha256, diffie-hellman-group16-sha384@ssh.com, diffie-hellman-group16-sha512, diffie-hellman-group16-sha512@ssh.com, diffie-hellman-group17-sha512, diffie-hellman-group18-sha512, diffie-hellman-group18-sha512@ssh.com, ecdh-sha2-nistp256, ecdh-sha2-nistp384, ecdh-sha2-nistp521, ext-info-c Supports Expression Language, using Environment variables. | ||
| Message Authentication Codes Allowed | Message Authentication Codes Allowed | A comma-separated list of Message Authentication Codes allowed for SFTP connections. Leave unset to allow all. Available options are: hmac-md5, hmac-md5-96, hmac-md5-96-etm@openssh.com, hmac-md5-etm@openssh.com, hmac-ripemd160, hmac-ripemd160-96, hmac-ripemd160-etm@openssh.com, hmac-ripemd160@openssh.com, hmac-sha1, hmac-sha1-96, hmac-sha1-96@openssh.com, hmac-sha1-etm@openssh.com, hmac-sha2-256, hmac-sha2-256-etm@openssh.com, hmac-sha2-512, hmac-sha2-512-etm@openssh.com Supports Expression Language, using Environment variables. |
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| failure | All FlowFiles, for which an existing file could not be deleted, are routed to this relationship |
| not found | All FlowFiles, for which the file to delete did not exist, are routed to this relationship |
| success | All FlowFiles, for which an existing file has been deleted, are routed to this relationship |
Reads Attributes
This processor does not read attributes.
Writes Attributes
This processor does not write attributes.
State Management
This component does not store state.
Restricted
This component is not restricted.
Input Requirement
This component requires an incoming relationship.
Example Use Cases
Use Case 1
Delete source file only after its processing completed
Configuration
Retrieve a file residing on an SFTP server, e.g. using 'ListSFTP' and 'FetchSFTP'.
Process the file using any combination of processors.
Store the resulting file to a destination, e.g. using 'PutFile'.
Using 'DeleteSFTP', delete the file residing on an SFTP server only after the result has been stored.
System Resource Considerations
This component does not specify system resource considerations.