ListSFTP

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 NiFi Expression Language, 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.

NameDefault ValueAllowable ValuesDescription
HostnameThe fully qualified hostname or IP address of the remote system
Supports Expression Language: true
Port22The port to connect to on the remote host to fetch the data from
Supports Expression Language: true
UsernameUsername
Supports Expression Language: true
PasswordPassword for the user account
Sensitive Property: true
Supports Expression Language: true
Private Key PathThe fully qualified path to the Private Key file
Supports Expression Language: true
Private Key PassphrasePassword for the private key
Sensitive Property: true
Supports Expression Language: true
Remote Path.The path on the remote system from which to pull or push files
Supports Expression Language: true
Distributed Cache ServiceController Service API:
DistributedMapCacheClient
Implementations: RedisDistributedMapCacheClientService
DistributedMapCacheClientService
HBase_1_1_2_ClientMapCacheService		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 Recursivelyfalse
  • true
  • false
If true, will pull files from arbitrarily nested subdirectories; otherwise, will not traverse subdirectories
File Filter RegexProvides 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 RegexWhen Search Recursively is true, then only subdirectories whose path matches the given Regular Expression will be scanned
Ignore Dotted Filestrue
  • true
  • false
If true, files whose names begin with a dot (".") will be ignored
Strict Host Key Checkingfalse
  • true
  • false
Indicates whether or not strict enforcement of hosts keys should be applied
Host Key FileIf supplied, the given file will be used as the Host Key; otherwise, no use host key file will be used
Connection Timeout30 secAmount of time to wait before timing out while creating a connection
Data Timeout30 secWhen 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 Timeouttrue
  • true
  • false
Indicates whether or not to send a single Keep Alive message when SSH socket times out
Target System Timestamp Precisionauto-detect
  • Auto Detect Automatically detect time unit deterministically based on candidate entries timestamp. Please note that this option may take longer to list entities unnecessarily, if none of entries has a precise precision timestamp. E.g. even if a target system supports millis, if all entries only have timestamps without millis, such as '2017-06-16 09:06:34.000', then its precision is determined as 'seconds'.
  • Milliseconds This option provides the minimum latency for an entry from being available to being listed if target system supports millis, if not, use other options.
  • Seconds For a target system that does not have millis precision, but has in seconds.
  • Minutes For a target system that only supports precision in minutes.
Specify timestamp precision at the target system. Since this processor uses timestamp of entities to decide which should be listed, it is crucial to use the right timestamp precision.

Relationships:

NameDescription
successAll FlowFiles that are received are routed to success

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
sftp.remote.hostThe hostname of the SFTP Server
sftp.remote.portThe port that was connected to on the SFTP Server
sftp.listing.userThe username of the user that performed the SFTP Listing
file.ownerThe numeric owner id of the source file
file.groupThe numeric group id of the source file
file.permissionsThe read/write/execute permissions of the source file
file.sizeThe number of bytes in the source file
file.lastModifiedTimeThe timestamp of when the file in the filesystem waslast modified as 'yyyy-MM-dd'T'HH:mm:ssZ'
filenameThe name of the file on the SFTP Server
pathThe fully qualified name of the directory on the SFTP Server from which the file was pulled

State management:

ScopeDescription
CLUSTERAfter performing a listing of files, the timestamp of the newest file is stored. This allows the Processor to list only files that have been added or modified after this date the next time that the Processor is run. State is stored across the cluster so that this Processor can be run on Primary Node only and if a new Primary Node is selected, the new node will not duplicate the data that was listed by the previous Primary Node.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.

See Also:

FetchSFTP, GetSFTP, PutSFTP