FetchSFTP
Description
Fetches the content of a file from a remote SFTP server and overwrites the contents of an incoming FlowFile with the content of the remote file.
Tags
fetch, files, get, ingest, input, remote, retrieve, sftp, source
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 |
|---|---|---|---|---|
| Hostname * | Hostname | The fully-qualified hostname or IP address of the host to fetch the data from Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Port * | Port | 22 | The port to connect to on the remote host to fetch the data from 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. | ||
| Remote File * | Remote File | The fully qualified filename on the remote system Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Completion Strategy * | Completion Strategy | None |
| Specifies what to do with the original file on the server once it has been pulled into NiFi. If the Completion Strategy fails, a warning will be logged but the data will still be transferred. |
| Move Destination Directory | Move Destination Directory | The directory on the remote server to move the original file to once it has been ingested into NiFi. This property is ignored unless the Completion Strategy is set to 'Move File'. The specified directory must already exist on the remote system if 'Create Directory' is disabled, or the rename will fail. Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Create Directory | Create Directory | false |
| Used when 'Completion Strategy' is 'Move File'. Specifies whether or not the remote directory should be created if it does not exist. |
| Disable Directory Listing | Disable Directory Listing | false |
| Control how 'Move Destination Directory' is created when 'Completion Strategy' is 'Move File' and 'Create Directory' is enabled. If set to 'true', directory listing is not performed prior to create missing directories. By default, this processor executes a directory listing command to see target directory existence before creating missing directories. However, there are situations that you might need to disable the directory listing such as the following. Directory listing might fail with some permission setups (e.g. chmod 100) on a directory. Also, if any other SFTP client created the directory after this processor performed a listing and before a directory creation request by this processor is finished, then an error is returned because the directory already exists. |
| 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. |
| 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 | ||
| Strict Host Key Checking * | Strict Host Key Checking | false |
| Indicates whether or not strict enforcement of hosts keys should be applied |
| 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 | |
| Log level when file not found * | fetchfiletransfer-notfound-loglevel | ERROR |
| Log level to use in case the file does not exist when the processor is triggered |
| 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 |
|---|---|
| comms.failure | Any FlowFile that could not be fetched from the remote server due to a communications failure will be transferred to this Relationship. |
| not.found | Any FlowFile for which we receive a 'Not Found' message from the remote server will be transferred to this Relationship. |
| permission.denied | Any FlowFile that could not be fetched from the remote server due to insufficient permissions will be transferred to this Relationship. |
| success | All FlowFiles that are received are routed to success |
Reads Attributes
This processor does not read attributes.
Writes Attributes
| Name | Description |
|---|---|
| fetch.failure.reason | The name of the failure relationship applied when routing to any failure relationship |
| filename | The filename is updated to point to the filename fo the remote file |
| path | If the Remote File contains a directory name, that directory name will be added to the FlowFile using the 'path' attribute |
| sftp.remote.filename | The name of the remote file that was pulled |
| sftp.remote.host | The hostname or IP address from which the file was pulled |
| sftp.remote.port | The port that was used to communicate with the remote SFTP server |
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 Involving Other Components
Multiprocessor Use Case 1
Retrieve all files in a directory of an SFTP Server
Components Involved
- ListSFTP
- The "Hostname" property should be set to the fully qualified hostname of the FTP Server. It's a good idea to parameterize this property by setting it to something like
#{SFTP_SERVER}. - The "Remote Path" property must be set to the directory on the FTP Server where the files reside. If the flow being built is to be reused elsewhere, it's a good idea to parameterize this property by setting it to something like
#{SFTP_REMOTE_PATH}. - Configure the "Username" property to the appropriate username for logging into the FTP Server. It's usually a good idea to parameterize this property by setting it to something like
#{SFTP_USERNAME}. - Configure the "Password" property to the appropriate password for the provided username. It's usually a good idea to parameterize this property by setting it to something like
#{SFTP_PASSWORD}. - The 'success' Relationship of this Processor is then connected to FetchSFTP.
- The "Hostname" property should be set to the fully qualified hostname of the FTP Server. It's a good idea to parameterize this property by setting it to something like
- FetchSFTP
- "Hostname" = "${sftp.remote.host}"
- "Remote File" = "${path}/${filename}"
- "Username" = "${sftp.listing.user}"
- "Password" = "#{SFTP_PASSWORD}"
System Resource Considerations
This component does not specify system resource considerations.