Description:

Performs a listing of the files residing on an SFTP server. For each file that is found on the remote server, a new FlowFile will be created with the filename attribute set to the name of the file on the remote server. This can then be used in conjunction with FetchSFTP in order to fetch those files.

Tags:

list, sftp, remote, ingest, source, input, files

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the Expression Language Guide 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	Default Value	Allowable Values	Description
Hostname			The fully qualified hostname or IP address of the remote system Supports Expression Language: true
Port	22		The port to connect to on the remote host to fetch the data from Supports Expression Language: true
Username			Username Supports Expression Language: true
Password			Password for the user account Sensitive Property: true
Private Key Path			The fully qualified path to the Private Key file
Private Key Passphrase			Password for the private key Sensitive Property: true
Remote Path	.		The path on the remote system from which to pull or push files Supports Expression Language: true
Distributed Cache Service		Controller Service API: DistributedMapCacheClient Implementation: DistributedMapCacheClientService	Specifies the Controller Service that should be used to maintain state about what has been pulled from the remote server so that if a new node begins pulling data, it won't duplicate all of the work that has been done. If not specified, the information will not be shared across the cluster. This property does not need to be set for standalone instances of NiFi but should be configured if NiFi is run within a cluster.
Search Recursively	false	* true</br> * false	If true, will pull files from arbitrarily nested subdirectories; otherwise, will not traverse subdirectories
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
Path Filter Regex			When Search Recursively is true, then only subdirectories whose path matches the given Regular Expression will be scanned
Ignore Dotted Files	true	* true</br> * false	If true, files whose names begin with a dot (".") will be ignored
Strict Host Key Checking	false	* true</br> * false	Indicates whether or not strict enforcement of hosts keys should be applied
Host Key File			If supplied, the given file will be used as the Host Key; otherwise, no use host key file will be used
Connection Timeout	30 sec		Amount of time to wait before timing out while creating a connection
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	true	* true</br> * false	Indicates whether or not to send a single Keep Alive message when SSH socket times out

Relationships:

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

Reads Attributes:

None specified.

Writes Attributes:

Name	Description
sftp.remote.host	The hostname of the SFTP Server
sftp.remote.port	The port that was connected to on the SFTP Server
sftp.listing.user	The username of the user that performed the SFTP Listing
file.owner	The numeric owner id of the source file
file.group	The numeric group id of the source file
file.permissions	The read/write/execute permissions of the source file
filename	The name of the file on the SFTP Server
path	The fully qualified name of the directory on the SFTP Server from which the file was pulled

See Also:

FetchSFTP,GetSFTP,PutSFTP