Sends FlowFiles to an SFTP Server
remote, copy, egress, put, sftp, archive, files
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.
| Name | Default Value | Valid Values | Description |
|---|---|---|---|
| Hostname | The fully qualified hostname or IP address of the remote system Supports Expression Language: true | ||
| Port | 22 | The port that the remote system is listening on for file transfers | |
| Username | Username | ||
| 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 | ||
| Create Directory | false |
| Specifies whether or not the remote directory should be created if it does not exist. |
| Batch Size | 500 | The maximum number of FlowFiles to send in a single connection | |
| Connection Timeout | 30 sec | Amount of time to wait before timing out while creating a connection | |
| Data Timeout | 30 sec | Amount of time to wait before timing out while transferring data | |
| Conflict Resolution | NONE |
| Determines how to handle the problem of filename collisions |
| Reject Zero-Byte Files | true |
| Determines whether or not Zero-byte files should be rejected without attempting to transfer |
| Dot Rename | true |
| If true, then the filename of the sent file is prepended with a "." and then renamed back to the original once the file is completely sent. Otherwise, there is no rename. This property is ignored if the Temporary Filename property is set. |
| Temporary Filename | If set, the filename of the sent file will be equal to the value specified during the transfer and after successful completion will be renamed to the original filename. If this value is set, the Dot Rename property is ignored. Supports Expression Language: true | ||
| Host Key File | If supplied, the given file will be used as the Host Key; otherwise, no use host key file will be used | ||
| Last Modified Time | The lastModifiedTime to assign to the file after transferring it. If not set, the lastModifiedTime will not be changed. Format must be yyyy-MM-dd'T'HH:mm:ssZ. You may also use expression language such as ${file.lastModifiedTime}. If the value is invalid, the processor will not be invalid but will fail to change lastModifiedTime of the file. Supports Expression Language: true | ||
| Permissions | The permissions to assign to the file after transferring it. Format must be either UNIX rwxrwxrwx with a - in place of denied permissions (e.g. rw-r--r--) or an octal number (e.g. 644). If not set, the permissions will not be changed. You may also use expression language such as ${file.permissions}. If the value is invalid, the processor will not be invalid but will fail to change permissions of the file. Supports Expression Language: true | ||
| Remote Owner | Integer value representing the User ID to set on the file after transferring it. If not set, the owner will not be set. You may also use expression language such as ${file.owner}. If the value is invalid, the processor will not be invalid but will fail to change the owner of the file. Supports Expression Language: true | ||
| Remote Group | Integer value representing the Group ID to set on the file after transferring it. If not set, the group will not be set. You may also use expression language such as ${file.group}. If the value is invalid, the processor will not be invalid but will fail to change the group of the file. Supports Expression Language: true | ||
| Strict Host Key Checking | false |
| Indicates whether or not strict enforcement of hosts keys should be applied |
| Send Keep Alive On Timeout | true |
| Indicates whether or not to send a single Keep Alive message when SSH socket times out |
| Use Compression | false |
| Indicates whether or not ZLIB compression should be used when transferring files |
| Name | Description |
|---|---|
| failure | FlowFiles that failed to send to the remote system; failure is usually looped back to this processor |
| reject | FlowFiles that were rejected by the destination system |
| success | FlowFiles that are successfully sent will be routed to success |