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.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|
| Listing Strategy | listing-strategy | Tracking Timestamps | - Tracking Timestamps
 - Tracking Entities
- No Tracking
- Time Window
| Specify how to determine new/updated entities. See each strategy descriptions for detail. |
| Hostname | Hostname | | | The fully qualified hostname or IP address of the remote system
Supports Expression Language: true (will be evaluated using variable registry only) |
| Port | Port | 22 | | The port that the remote system is listening on for file transfers
Supports Expression Language: true (will be evaluated using variable registry only) |
| Username | Username | | | Username
Supports Expression Language: true (will be evaluated using variable registry only) |
| Password | Password | | | Password for the user account
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only) |
| Private Key Path | Private Key Path | | | The fully qualified path to the Private Key file
This property requires exactly one file to be provided..
Supports Expression Language: true (will be evaluated using variable registry only) |
| Private Key Passphrase | Private Key Passphrase | | | Password for the private key
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only) |
| Remote Path | Remote Path | . | | The path on the remote system from which to pull or push files
Supports Expression Language: true (will be evaluated using variable registry only) |
| Record Writer | record-writer | | Controller Service API:
RecordSetWriterFactory
Implementations: ScriptedRecordSetWriter
XMLRecordSetWriter
JsonRecordSetWriter
AvroRecordSetWriter
CSVRecordSetWriter
ParquetRecordSetWriter
FreeFormTextRecordSetWriter
RecordSetWriterLookup | Specifies the Record Writer to use for creating the listing. If not specified, one FlowFile will be created for each entity that is listed. If the Record Writer is specified, all entities will be written to a single FlowFile instead of adding attributes to individual FlowFiles. |
| Distributed Cache Service | Distributed Cache Service | | Controller Service API:
DistributedMapCacheClient
Implementations: HBase_1_1_2_ClientMapCacheService
DistributedMapCacheClientService
RedisDistributedMapCacheClientService
HazelcastMapCacheClient
CouchbaseMapCacheClient
HBase_2_ClientMapCacheService
CassandraDistributedMapCache | NOTE: This property is used merely for migration from old NiFi version before state management was introduced at version 0.5.0. The stored value in the cache service will be migrated into the state when this processor is started at the first time. The specified Controller Service was used to maintain state about what had 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 was not shared across the cluster. This property did not need to be set for standalone instances of NiFi but was supposed to be configured if NiFi had been running within a cluster. |
| Search Recursively | Search Recursively | false | | If true, will pull files from arbitrarily nested subdirectories; otherwise, will not traverse subdirectories |
| Follow symlink | follow-symlink | false | | If true, will pull even symbolic files and also nested symbolic subdirectories; otherwise, will not read symbolic files and will not traverse symbolic link subdirectories |
| File Filter Regex | 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 | Path Filter Regex | | | When Search Recursively is true, then only subdirectories whose path matches the given Regular Expression will be scanned |
| Ignore Dotted Files | Ignore Dotted Files | true | | If true, files whose names begin with a dot (".") will be ignored |
| Strict Host Key Checking | Strict Host Key Checking | false | | Indicates whether or not strict enforcement of hosts keys should be applied |
| 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
This property requires exactly one file to be provided..
|
| 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. |
| Target System Timestamp Precision | target-system-timestamp-precision | Auto Detect | - Auto Detect
- Milliseconds
- Seconds
- 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. |
| 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 API:
ProxyConfigurationService
Implementation: StandardProxyConfigurationService | Specifies the Proxy Configuration Controller Service to proxy network requests. If set, it supersedes proxy settings configured per component. Supported proxies: HTTP + AuthN, SOCKS + AuthN |
| Proxy Type | Proxy Type | DIRECT | | Proxy type used for file transfers |
| Proxy Host | Proxy Host | | | The fully qualified hostname or IP address of the proxy server
Supports Expression Language: true (will be evaluated using variable registry only) |
| Proxy Port | Proxy Port | | | The port of the proxy server
Supports Expression Language: true (will be evaluated using variable registry only) |
| Http Proxy Username | Http Proxy Username | | | Http Proxy Username
Supports Expression Language: true (will be evaluated using variable registry only) |
| Http Proxy Password | Http Proxy Password | | | Http Proxy Password
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only) |
| Entity Tracking State Cache | et-state-cache | | Controller Service API:
DistributedMapCacheClient
Implementations: HBase_1_1_2_ClientMapCacheService
DistributedMapCacheClientService
RedisDistributedMapCacheClientService
HazelcastMapCacheClient
CouchbaseMapCacheClient
HBase_2_ClientMapCacheService
CassandraDistributedMapCache | Listed entities are stored in the specified cache storage so that this processor can resume listing across NiFi restart or in case of primary node change. 'Tracking Entities' strategy require tracking information of all listed entities within the last 'Tracking Time Window'. To support large number of entities, the strategy uses DistributedMapCache instead of managed state. Cache key format is 'ListedEntities::{processorId}(::{nodeId})'. If it tracks per node listed entities, then the optional '::{nodeId}' part is added to manage state separately. E.g. cluster wide cache key = 'ListedEntities::8dda2321-0164-1000-50fa-3042fe7d6a7b', per node cache key = 'ListedEntities::8dda2321-0164-1000-50fa-3042fe7d6a7b::nifi-node3' The stored cache content is Gzipped JSON string. The cache key will be deleted when target listing configuration is changed. Used by 'Tracking Entities' strategy. |
| Entity Tracking Time Window | et-time-window | 3 hours | | Specify how long this processor should track already-listed entities. 'Tracking Entities' strategy can pick any entity whose timestamp is inside the specified time window. For example, if set to '30 minutes', any entity having timestamp in recent 30 minutes will be the listing target when this processor runs. A listed entity is considered 'new/updated' and a FlowFile is emitted if one of following condition meets: 1. does not exist in the already-listed entities, 2. has newer timestamp than the cached entity, 3. has different size than the cached entity. If a cached entity's timestamp becomes older than specified time window, that entity will be removed from the cached already-listed entities. Used by 'Tracking Entities' strategy.
Supports Expression Language: true (will be evaluated using variable registry only) |
| Entity Tracking Initial Listing Target | et-initial-listing-target | All Available | - Tracking Time Window
- All Available
| Specify how initial listing should be handled. Used by 'Tracking Entities' strategy. |
| Minimum File Age | Minimum File Age | 0 sec | | The minimum age that a file must be in order to be pulled; any file younger than this amount of time (according to last modification date) will be ignored |
| Maximum File Age | Maximum File Age | | | The maximum age that a file must be in order to be pulled; any file older than this amount of time (according to last modification date) will be ignored |
| Minimum File Size | Minimum File Size | 0 B | | The minimum size that a file must be in order to be pulled |
| Maximum File Size | Maximum File Size | | | The maximum size that a file can be in order to be pulled |
| 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: true (will be evaluated using variable registry only) |
| 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: true (will be evaluated using variable registry only) |
| 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: true (will be evaluated using variable registry only) |
| 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: true (will be evaluated using variable registry only) |