PutSFTP

The maximum number of FlowFiles to send in a single connection

Display Name: Batch Size
Description: The maximum number of FlowFiles to send in a single connection
API Name: Batch Size
Default Value: 500
Expression Language Scope: Not Supported
Sensitive: false
Required: true

A comma-separated list of Ciphers allowed for SFTP connections. Leave unset to allow all. Available options are: 3des-cbc, 3des-ctr, aes128-cbc, aes128-ctr, aes128-gcm@openssh.com, aes192-cbc, aes192-ctr, aes256-cbc, aes256-ctr, aes256-gcm@openssh.com, arcfour, arcfour128, arcfour256, blowfish-cbc, blowfish-ctr, cast128-cbc, cast128-ctr, chacha20-poly1305@openssh.com, idea-cbc, idea-ctr, serpent128-cbc, serpent128-ctr, serpent192-cbc, serpent192-ctr, serpent256-cbc, serpent256-ctr, twofish-cbc, twofish128-cbc, twofish128-ctr, twofish192-cbc, twofish192-ctr, twofish256-cbc, twofish256-ctr

Display Name: Ciphers Allowed
Description: A comma-separated list of Ciphers allowed for SFTP connections. Leave unset to allow all. Available options are: 3des-cbc, 3des-ctr, aes128-cbc, aes128-ctr, aes128-gcm@openssh.com, aes192-cbc, aes192-ctr, aes256-cbc, aes256-ctr, aes256-gcm@openssh.com, arcfour, arcfour128, arcfour256, blowfish-cbc, blowfish-ctr, cast128-cbc, cast128-ctr, chacha20-poly1305@openssh.com, idea-cbc, idea-ctr, serpent128-cbc, serpent128-ctr, serpent192-cbc, serpent192-ctr, serpent256-cbc, serpent256-ctr, twofish-cbc, twofish128-cbc, twofish128-ctr, twofish192-cbc, twofish192-ctr, twofish256-cbc, twofish256-ctr
API Name: Ciphers Allowed
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

Conflict Resolution

Determines how to handle the problem of filename collisions

Display Name

Conflict Resolution

Description

Determines how to handle the problem of filename collisions

API Name

Conflict Resolution

Default Value

NONE

Allowable Values

REPLACE
IGNORE
RENAME
REJECT
FAIL
NONE

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Connection Timeout

Amount of time to wait before timing out while creating a connection

Display Name: Connection Timeout
Description: Amount of time to wait before timing out while creating a connection
API Name: Connection Timeout
Default Value: 30 sec
Expression Language Scope: Not Supported
Sensitive: false
Required: true

Create Directory

Specifies whether or not the remote directory should be created if it does not exist.

Display Name

Create Directory

Description

Specifies whether or not the remote directory should be created if it does not exist.

API Name

Create Directory

Default Value

false

Allowable Values

true
false

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Data Timeout

When 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

Display Name: Data Timeout
Description: When 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
API Name: Data Timeout
Default Value: 30 sec
Expression Language Scope: Not Supported
Sensitive: false
Required: true

Disable Directory Listing

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 the following. 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.

Display Name

Disable Directory Listing

Description

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 the following. 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.

API Name

Disable Directory Listing

Default Value

false

Allowable Values

true
false

Expression Language Scope

Not Supported

Sensitive

false

Required

false

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.

Display Name

Dot Rename

Description

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.

API Name

Dot Rename

Default Value

true

Allowable Values

true
false

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Host Key File

If supplied, the given file will be used as the Host Key; otherwise, if 'Strict Host Key Checking' property is applied (set to true) then uses the 'known_hosts' and 'known_hosts2' files from ~/.ssh directory else no host key file will be used

Display Name: Host Key File
Description: If supplied, the given file will be used as the Host Key; otherwise, if 'Strict Host Key Checking' property is applied (set to true) then uses the 'known_hosts' and 'known_hosts2' files from ~/.ssh directory else no host key file will be used
API Name: Host Key File
Expression Language Scope: Not Supported
Sensitive: false
Required: false

Hostname

The fully qualified hostname or IP address of the remote system

Display Name: Hostname
Description: The fully qualified hostname or IP address of the remote system
API Name: Hostname
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: false
Required: true

Key Algorithms Allowed

A comma-separated list of Key Algorithms allowed for SFTP connections. Leave unset to allow all. Available options are: ecdsa-sha2-nistp256, ecdsa-sha2-nistp256-cert-v01@openssh.com, ecdsa-sha2-nistp384, ecdsa-sha2-nistp384-cert-v01@openssh.com, ecdsa-sha2-nistp521, ecdsa-sha2-nistp521-cert-v01@openssh.com, rsa-sha2-256, rsa-sha2-512, ssh-dss, ssh-dss-cert-v01@openssh.com, ssh-ed25519, ssh-ed25519-cert-v01@openssh.com, ssh-rsa, ssh-rsa-cert-v01@openssh.com

Display Name: Key Algorithms Allowed
Description: A comma-separated list of Key Algorithms allowed for SFTP connections. Leave unset to allow all. Available options are: ecdsa-sha2-nistp256, ecdsa-sha2-nistp256-cert-v01@openssh.com, ecdsa-sha2-nistp384, ecdsa-sha2-nistp384-cert-v01@openssh.com, ecdsa-sha2-nistp521, ecdsa-sha2-nistp521-cert-v01@openssh.com, rsa-sha2-256, rsa-sha2-512, ssh-dss, ssh-dss-cert-v01@openssh.com, ssh-ed25519, ssh-ed25519-cert-v01@openssh.com, ssh-rsa, ssh-rsa-cert-v01@openssh.com
API Name: Key Algorithms Allowed
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

Key Exchange Algorithms Allowed

Display Name: Key Exchange Algorithms Allowed
Description: A comma-separated list of Key Exchange Algorithms allowed for SFTP connections. Leave unset to allow all. Available options are: curve25519-sha256, curve25519-sha256@libssh.org, diffie-hellman-group-exchange-sha1, diffie-hellman-group-exchange-sha256, diffie-hellman-group1-sha1, diffie-hellman-group14-sha1, diffie-hellman-group14-sha256, diffie-hellman-group14-sha256@ssh.com, diffie-hellman-group15-sha256, diffie-hellman-group15-sha256@ssh.com, diffie-hellman-group15-sha384@ssh.com, diffie-hellman-group15-sha512, diffie-hellman-group16-sha256, diffie-hellman-group16-sha384@ssh.com, diffie-hellman-group16-sha512, diffie-hellman-group16-sha512@ssh.com, diffie-hellman-group17-sha512, diffie-hellman-group18-sha512, diffie-hellman-group18-sha512@ssh.com, ecdh-sha2-nistp256, ecdh-sha2-nistp384, ecdh-sha2-nistp521, ext-info-c
API Name: Key Exchange Algorithms Allowed
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: 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.

Display Name: Last Modified Time
Description: 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.
API Name: Last Modified Time
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: false
Required: false

Message Authentication Codes Allowed

A comma-separated list of Message Authentication Codes allowed for SFTP connections. Leave unset to allow all. Available options are: hmac-md5, hmac-md5-96, hmac-md5-96-etm@openssh.com, hmac-md5-etm@openssh.com, hmac-ripemd160, hmac-ripemd160-96, hmac-ripemd160-etm@openssh.com, hmac-ripemd160@openssh.com, hmac-sha1, hmac-sha1-96, hmac-sha1-96@openssh.com, hmac-sha1-etm@openssh.com, hmac-sha2-256, hmac-sha2-256-etm@openssh.com, hmac-sha2-512, hmac-sha2-512-etm@openssh.com

Display Name: Message Authentication Codes Allowed
Description: A comma-separated list of Message Authentication Codes allowed for SFTP connections. Leave unset to allow all. Available options are: hmac-md5, hmac-md5-96, hmac-md5-96-etm@openssh.com, hmac-md5-etm@openssh.com, hmac-ripemd160, hmac-ripemd160-96, hmac-ripemd160-etm@openssh.com, hmac-ripemd160@openssh.com, hmac-sha1, hmac-sha1-96, hmac-sha1-96@openssh.com, hmac-sha1-etm@openssh.com, hmac-sha2-256, hmac-sha2-256-etm@openssh.com, hmac-sha2-512, hmac-sha2-512-etm@openssh.com
API Name: Message Authentication Codes Allowed
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

Password

Password for the user account

Display Name: Password
Description: Password for the user account
API Name: Password
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: true
Required: false

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.

Display Name: Permissions
Description: 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.
API Name: Permissions
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: false
Required: false

Port

The port that the remote system is listening on for file transfers

Display Name: Port
Description: The port that the remote system is listening on for file transfers
API Name: Port
Default Value: 22
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: false
Required: true

Private Key Passphrase

Password for the private key

Display Name: Private Key Passphrase
Description: Password for the private key
API Name: Private Key Passphrase
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: true
Required: false

Private Key Path

The fully qualified path to the Private Key file

Display Name: Private Key Path
Description: The fully qualified path to the Private Key file
API Name: Private Key Path
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: false
Required: false

Proxy Configuration Service

Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: SOCKS + AuthN, HTTP + AuthN

Display Name: Proxy Configuration Service
Description: Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: SOCKS + AuthN, HTTP + AuthN
API Name: proxy-configuration-service
Service Interface: org.apache.nifi.proxy.ProxyConfigurationService
Service Implementations: org.apache.nifi.proxy.StandardProxyConfigurationService
Expression Language Scope: Not Supported
Sensitive: false
Required: false

Reject Zero-Byte Files

Determines whether or not Zero-byte files should be rejected without attempting to transfer

Display Name

Reject Zero-Byte Files

Description

Determines whether or not Zero-byte files should be rejected without attempting to transfer

API Name

Reject Zero-Byte Files

Default Value

true

Allowable Values

true
false

Expression Language Scope

Not Supported

Sensitive

false

Required

false

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.

Display Name: Remote Group
Description: 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.
API Name: Remote Group
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: false
Required: false

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.

Display Name: Remote Owner
Description: 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.
API Name: Remote Owner
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: false
Required: false

Remote Path

The path on the remote system from which to pull or push files

Display Name: Remote Path
Description: The path on the remote system from which to pull or push files
API Name: Remote Path
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: false
Required: false

Send Keep Alive On Timeout

Send a Keep Alive message every 5 seconds up to 5 times for an overall timeout of 25 seconds.

Display Name

Send Keep Alive On Timeout

Description

Send a Keep Alive message every 5 seconds up to 5 times for an overall timeout of 25 seconds.

API Name

Send Keep Alive On Timeout

Default Value

true

Allowable Values

true
false

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Strict Host Key Checking

Indicates whether or not strict enforcement of hosts keys should be applied

Display Name

Strict Host Key Checking

Description

Indicates whether or not strict enforcement of hosts keys should be applied

API Name

Strict Host Key Checking

Default Value

false

Allowable Values

true
false

Expression Language Scope

Not Supported

Sensitive

false

Required

true

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.

Display Name: Temporary Filename
Description: 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.
API Name: Temporary Filename
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: false
Required: false

Use Compression

Indicates whether or not ZLIB compression should be used when transferring files

Display Name

Use Compression

Description

Indicates whether or not ZLIB compression should be used when transferring files

API Name

Use Compression

Default Value

false

Allowable Values

true
false

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Username

Display Name: Username
Description: Username
API Name: Username
Expression Language Scope: Environment variables and FlowFile Attributes
Sensitive: false
Required: true

Name	Description
success	FlowFiles that are successfully sent will be routed to success
reject	FlowFiles that were rejected by the destination system
failure	FlowFiles that failed to send to the remote system; failure is usually looped back to this processor

PutSFTP 2.0.0