GetSFTP

Description:

Fetches files from an SFTP Server and creates FlowFiles from them

Tags: sftp, get, retrieve, files, fetch, remote, ingest, source, input

Properties:

In the list below, the names of required properties appear in bold. Anyother properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the NiFi Expression Language (or simply EL), and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.

Name	Description	Default Value	Valid Values	EL	Sensitive
Hostname	The fully qualified hostname or IP address of the remote system			Yes	No
Port	The port that the remote system is listening on for file transfers	22		No	No
Username	Username			No	No
Password	Password for the user account			No	Yes
Private Key Path	The fully qualified path to the Private Key file			No	No
Private Key Passphrase	Password for the private key			No	Yes
Remote Path	The path on the remote system from which to pull or push files			Yes	No
File Filter Regex	Provides a Java Regular Expression for filtering Filenames; if a filter is supplied, only files whose names match that Regular Expression will be fetched			No	No
Path Filter Regex	When Search Recursively is true, then only subdirectories whose path matches the given Regular Expression will be scanned			No	No
Polling Interval	Determines how long to wait between fetching the listing for new files	60 sec		No	No
Search Recursively	If true, will pull files from arbitrarily nested subdirectories; otherwise, will not traverse subdirectories	false	true false	No	No
Ignore Dotted Files	If true, files whose names begin with a dot (".") will be ignored	true	true false	No	No
Delete Original	Determines whether or not the file is deleted from the remote system after it has been successfully transferred	true	true false	No	No
Connection Timeout	Amount of time to wait before timing out while creating a connection	30 sec		No	No
Data Timeout	Amount of time to wait before timing out while transferring data	30 sec		No	No
Host Key File	If supplied, the given file will be used as the Host Key; otherwise, no use host key file will be used			No	No
Max Selects	The maximum number of files to pull in a single connection	100		No	No
Remote Poll Batch Size	The value specifies how many file paths to find in a given directory on the remote system when doing a file listing. This value in general should not need to be modified but when polling against a remote system with a tremendous number of files this value can be critical. Setting this value too high can result very poor performance and setting it too low can cause the flow to be slower than normal.	5000		No	No
Strict Host Key Checking	Indicates whether or not strict enforcement of hosts keys should be applied	false	true false	No	No
Send Keep Alive On Timeout	Indicates whether or not to send a single Keep Alive message when SSH socket times out	true	true false	No	No
Use Compression	Indicates whether or not ZLIB compression should be used when transferring files	false	true false	No	No
Use Natural Ordering	If true, will pull files in the order in which they are naturally listed; otherwise, the order in which the files will be pulled is not defined	false	true false	No	No

Relationships:

Name	Description
success	All FlowFiles that are received are routed to success