Description:
Fetches the content of a file from a remote SFTP server and overwrites the contents of an incoming FlowFile with the content of the remote file.
Tags:
sftp, get, retrieve, files, fetch, remote, ingest, source, input
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 host to fetch the data from 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 File |
The fully qualified filename on the remote system Supports Expression Language: true |
||
Completion Strategy | None |
* None ![]() * Move File ![]() * Delete File ![]() |
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. |
Move Destination Directory |
The directory on the remote server to the 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, or the rename will fail. Supports Expression Language: true |
||
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 * false |
Indicates whether or not to send a single Keep Alive message when SSH socket times out |
Host Key File | If supplied, the given file will be used as the Host Key; otherwise, no use host key file will be used | ||
Strict Host Key Checking | false |
* true * false |
Indicates whether or not strict enforcement of hosts keys should be applied |
Use Compression | false |
* true * false |
Indicates whether or not ZLIB compression should be used when transferring files |
Relationships:
Name | Description |
not.found | Any FlowFile for which we receive a 'Not Found' message from the remote server will be transferred to this Relationship. |
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. |
success | All FlowFiles that are received are routed to success |
Reads Attributes:
None specified.
Writes Attributes:
Name | Description |
sftp.remote.host | The hostname or IP address from which the file was pulled |
sftp.remote.port | The port that was used to communicate with the remote SFTP server |
sftp.remote.filename | The name of the remote file that was pulled |
filename | The filename is updated to point to the filename fo the remote file |
path | If the Remote File contains a directory name, that directory name will be added to the FlowFile using the 'path' attribute |
See Also:
GetSFTP,PutSFTP,GetFTP,PutFTP