PutFTP

Description:

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. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
HostnameHostnameThe fully qualified hostname or IP address of the remote system
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
PortPort21The port that the remote system is listening on for file transfers
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
UsernameUsernameUsername
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
PasswordPasswordPassword for the user account
Sensitive Property: true
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Remote PathRemote PathThe path on the remote system from which to pull or push files
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Create DirectoryCreate Directoryfalse
  • true
  • false
Specifies whether or not the remote directory should be created if it does not exist.
Batch SizeBatch Size500The maximum number of FlowFiles to send in a single connection
Connection TimeoutConnection Timeout30 secAmount of time to wait before timing out while creating a connection
Data TimeoutData 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
Conflict ResolutionConflict ResolutionNONE
  • REPLACE
  • IGNORE
  • RENAME
  • REJECT
  • FAIL
  • NONE
Determines how to handle the problem of filename collisions
Dot RenameDot Renametrue
  • true
  • false
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 FilenameTemporary FilenameIf 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 (will be evaluated using flow file attributes and variable registry)
Transfer ModeTransfer ModeBinary
  • Binary
  • ASCII
The FTP Transfer Mode
Connection ModeConnection ModePassive
  • Active
  • Passive
The FTP Connection Mode
Reject Zero-Byte FilesReject Zero-Byte Filestrue
  • true
  • false
Determines whether or not Zero-byte files should be rejected without attempting to transfer
Last Modified TimeLast Modified TimeThe 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 (will be evaluated using flow file attributes and variable registry)
PermissionsPermissionsThe 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 (will be evaluated using flow file attributes and variable registry)
Use CompressionUse Compressionfalse
  • true
  • false
Indicates whether or not ZLIB compression should be used when transferring files
Proxy Configuration Serviceproxy-configuration-serviceController 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 TypeProxy TypeDIRECT
  • DIRECT
  • HTTP
  • SOCKS
Proxy type used for file transfers
Proxy HostProxy HostThe fully qualified hostname or IP address of the proxy server
Supports Expression Language: true (will be evaluated using variable registry only)
Proxy PortProxy PortThe port of the proxy server
Supports Expression Language: true (will be evaluated using variable registry only)
Http Proxy UsernameHttp Proxy UsernameHttp Proxy Username
Supports Expression Language: true (will be evaluated using variable registry only)
Http Proxy PasswordHttp Proxy PasswordHttp Proxy Password
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)
Internal Buffer SizeInternal Buffer Size16KBSet the internal buffer size for buffered data streams
Use UTF-8 Encodingftp-use-utf8false
  • true
  • false
Tells the client to use UTF-8 encoding when processing files and filenames. If set to true, the server must also support UTF-8 encoding.

Dynamic Properties:

Supports Sensitive Dynamic Properties: No

Dynamic Properties allow the user to specify both the name and value of a property.

NameValueDescription
pre.cmd._____Not usedThe command specified in the key will be executed before doing a put. You may add these optional properties to send any commands to the FTP server before the file is actually transferred (before the put command). This option is only available for the PutFTP processor, as only FTP has this functionality. This is essentially the same as sending quote commands to an FTP server from the command line. While this is the same as sending a quote command, it is very important that you leave off the .
Supports Expression Language: false
post.cmd._____Not usedThe command specified in the key will be executed after doing a put. You may add these optional properties to send any commands to the FTP server before the file is actually transferred (before the put command). This option is only available for the PutFTP processor, as only FTP has this functionality. This is essentially the same as sending quote commands to an FTP server from the command line. While this is the same as sending a quote command, it is very important that you leave off the .
Supports Expression Language: false

Relationships:

NameDescription
successFlowFiles that are successfully sent will be routed to success
rejectFlowFiles that were rejected by the destination system
failureFlowFiles that failed to send to the remote system; failure is usually looped back to this processor

Reads Attributes:

None specified.

Writes Attributes:

None specified.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.

See Also:

GetFTP