FetchSFTP 2.3.0¶

Completion Strategy

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.

Create Directory

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

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.

Hostname

The fully-qualified hostname or IP address of the host to fetch the data from

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

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.

Port

The port to connect to on the remote host to fetch the data from

Private Key Path

The fully qualified path to the Private Key file

Send Keep Alive On Timeout

Send a Keep Alive message every 5 seconds up to 5 times for an overall timeout of 25 seconds.

Use Compression

Indicates whether or not ZLIB compression should be used when transferring files

fetchfiletransfer-notfound-loglevel

Log level to use in case the file does not exist when the processor is triggered

permission.denied

Any FlowFile that could not be fetched from the remote server due to insufficient permissions will be transferred to this Relationship.

comms.failure

Any FlowFile that could not be fetched from the remote server due to a communications failure will be transferred to this Relationship.

sftp.remote.port

The port that was used to communicate with the remote SFTP server

filename

The filename is updated to point to the filename fo the remote file

fetch.failure.reason

The name of the failure relationship applied when routing to any failure relationship

Retrieve all files in a directory of an SFTP Server