Sends FlowFiles to an FTP Server
Tags: remote, copy, egress, put, ftp, archive, files
Properties:
In the list below, the names of required properties appear in bold. Anyother properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the NiFi Expression Language (or simply EL), 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 | Description | Default Value | Valid Values | EL | Sensitive |
|---|---|---|---|---|---|
| Hostname | The fully qualified hostname or IP address of the remote system | Yes | No | ||
| Port | The port that the remote system is listening on for file transfers | 21 | No | No | |
| Username | Username | No | No | ||
| Password | Password for the user account | No | Yes | ||
| Remote Path | The path on the remote system from which to pull or push files | Yes | No | ||
| Create Directory | Specifies whether or not the remote directory should be created if it does not exist. | false |
| No | No |
| Batch Size | The maximum number of FlowFiles to send in a single connection | 500 | No | No | |
| Connection Timeout | Amount of time to wait before timing out while creating a connection | 30 sec | No | No | |
| Data Timeout | Amount of time to wait before timing out while transferring data | 30 sec | No | No | |
| Conflict Resolution | Determines how to handle the problem of filename collisions | NONE |
| No | No |
| Dot Rename | 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. | true |
| No | No |
| 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. | Yes | No | ||
| Transfer Mode | The FTP Transfer Mode | Binary |
| No | No |
| Connection Mode | The FTP Connection Mode | Passive |
| No | No |
| Reject Zero-Byte Files | Determines whether or not Zero-byte files should be rejected without attempting to transfer | true |
| No | No |
| 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. | Yes | No | ||
| 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. | Yes | No | ||
| Use Compression | Indicates whether or not ZLIB compression should be used when transferring files | false |
| No | No |
Relationships:
| 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 |