PutSFTP

Description:

Sends FlowFiles to an SFTP Server

Tags:

remote, copy, egress, put, sftp, 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, 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.

NameDefault ValueAllowable ValuesDescription
HostnameThe fully qualified hostname or IP address of the remote system
Supports Expression Language: true
Port22The port that the remote system is listening on for file transfers
Supports Expression Language: true
UsernameUsername
Supports Expression Language: true
PasswordPassword for the user account
Sensitive Property: true
Supports Expression Language: true
Private Key PathThe fully qualified path to the Private Key file
Supports Expression Language: true
Private Key PassphrasePassword for the private key
Sensitive Property: true
Supports Expression Language: true
Remote PathThe path on the remote system from which to pull or push files
Supports Expression Language: true
Create Directoryfalse
  • true
  • false
Specifies whether or not the remote directory should be created if it does not exist.
Disable Directory Listingfalse
  • true
  • false
If set to 'true', directory listing is not performed prior to create missing directories. By default, this processor executes a directory listing command to see target directory existence before creating missing directories. However, there are situations that you might need to disable the directory listing such as followings. Directory listing might fail with some permission setups (e.g. chmod 100) on a directory. Also, if any other SFTP client created the directory after this processor performed a listing and before a directory creation request by this processor is finished, then an error is returned because the directory already exists.
Batch Size500The maximum number of FlowFiles to send in a single connection
Connection Timeout30 secAmount of time to wait before timing out while creating a connection
Data 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 ResolutionNONE
  • REPLACE
  • IGNORE
  • RENAME
  • REJECT
  • FAIL
  • NONE
Determines how to handle the problem of filename collisions
Reject Zero-Byte Filestrue
  • true
  • false
Determines whether or not Zero-byte files should be rejected without attempting to transfer
Dot 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 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
Host Key FileIf supplied, the given file will be used as the Host Key; otherwise, no use host key file will be used
Last 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
PermissionsThe 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 OwnerInteger 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 GroupInteger 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 Checkingfalse
  • true
  • false
Indicates whether or not strict enforcement of hosts keys should be applied
Send Keep Alive On Timeouttrue
  • true
  • false
Indicates whether or not to send a single Keep Alive message when SSH socket times out
Use Compressionfalse
  • true
  • false
Indicates whether or not ZLIB compression should be used when transferring files

Dynamic Properties:

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

NameValueDescription
Disable Directory Listingtrue or falseDisables directory listings before operations which might fail, such as configurations which create directory structures.

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.

See Also:

GetSFTP