Description:
This processor sends FlowFiles via SFTP to an SFTP server.
Properties:
In the list below, the names of required properties appear in bold.
Any other properties (not in bold) are considered optional. If a
property has a default value, it is indicated. If a property supports
the use of the NiFi Expression Language (or simply,
"expression language"), that is also indicated.
-
Hostname
- The fully qualified hostname or IP address of the remote
system.
- Default value: no default
- Supports expression language: true
-
Port
- The port that the remote system is listening on for file transfers.
- Default value: 22
- Supports expression language: false
-
Username
- The username for the user account.
- Default value: no default
- Supports expression language: false
-
Password
- The password for the user account.
- Default value: no default
- Supports expression language: false
-
Private Key Path
- The fully qualified path for the private key file.
- Default value: no default
- Supports expression language: false
-
Private Key Passphrase
- The password for the private key.
- Default value: no default
- Supports expression language: false
-
Remote Path
- The path on the remote system to which files should be transferred. If not specified, the user's home directory will be used. You may use expression language such as /aa/bb/${path}.
- Default value: no default
- Supports expression language: true
- Create Directory
- Specifies whether or not the remote directory should be created if it does not exist. Recommend setting to true when Remote Path uses expression language.
- Default value: false
- Supports expression language: false
- Batch Size
- The maximum number of FlowFiles to send in a single connection.
- Default value: 500
- Supports expression language: false
-
Connection Timeout
- The amount of time to wait before timing out while creating a
connection.
- Default value: 30 sec
- Supports expression language: false
-
Data Timeout
- The amount of time to wait before timing out while transferring
data.
- Default value: 30 sec
- Supports expression language: false
-
Conflict Resolution
- Specifies what action the processor should take if a conflict
prevents it from delivering the files. Valid options are:
- replace
- ignore
- rename
- reject
- fail
- NONE
- Default value: NONE
- Supports expression language: false
-
Reject Zero-Byte Files
- A Boolean value (true/false), indicating whether to reject
files that have zero bytes of content rather than transferring
them.
- Default value: true
- Supports expression language: false
-
Dot Rename
- A Boolean value (true/false), indicating whether to prepend the
filename of the file with a dot (.) while the file is transferring
and remove the dot when the file is completely transferred.
- Default value: true
- Supports expression language: false
- 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.
- Default value: no default
- Supports expression language: true
-
Host Key File
- The local file path to the host key file; if not supplied, no
host key file will be used.
- Default value: no default
- Supports expression language: false
- 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.
- Default value: no default
- 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.
- Default value: no default
- 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 changed. 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.
- Default value: no default
- 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 changed. 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.
- Default value: no default
- Supports expression language: true
-
Strict Host Key Checking
- A Boolean value (true/false), indicating whether to apply
strict enforcement of host keys.
- Default value: false
- Supports expression language: false
-
Use Compression
- A Boolean value (true/false), indicating whether to use ZLIB
compression when transferring files.
- Default value: false
- Supports expression language: false
Relationships:
-
failure
- If FlowFiles fail to be transferred, then they follow this
relationship.
-
reject
- If the property Reject Zero-Byte Files is set to true and
incoming FlowFiles meet this criteria, then they follow this
relationship.
-
success
- If FlowFiles are successfully transferred, then they follow
this relationship.
See Also: