Sends FlowFiles to an SFTP Server
remote, copy, egress, put, sftp, archive, files
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.
| Name | Default Value | Allowable Values | Description |
|---|---|---|---|
| Hostname | The fully qualified hostname or IP address of the remote system Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) | ||
| Port | 22 | The 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) | |
| Username | Username Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) | ||
| Password | Password for the user account Sensitive Property: true Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) | ||
| Private Key Path | The fully qualified path to the Private Key file This property requires exactly one file to be provided.. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) | ||
| Private Key Passphrase | Password for the private key Sensitive Property: true Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) | ||
| Remote Path | The path on the remote system from which to pull or push files Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Create Directory | false |
| Specifies whether or not the remote directory should be created if it does not exist. |
| Disable Directory Listing | 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 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. |
| Batch Size | 500 | The maximum number of FlowFiles to send in a single connection | |
| Connection Timeout | 30 sec | Amount of time to wait before timing out while creating a connection | |
| Data Timeout | 30 sec | 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 | |
| Conflict Resolution | NONE |
| Determines how to handle the problem of filename collisions |
| Reject Zero-Byte Files | true |
| Determines whether or not Zero-byte files should be rejected without attempting to transfer |
| Dot Rename | true |
| 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 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. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) | ||
| 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 This property requires exactly one file to be provided.. | ||
| 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. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) | ||
| 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. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) | ||
| 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. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) | ||
| 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. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) | ||
| Strict Host Key Checking | false |
| Indicates whether or not strict enforcement of hosts keys should be applied |
| Send Keep Alive On Timeout | true |
| Send a Keep Alive message every 5 seconds up to 5 times for an overall timeout of 25 seconds. |
| Use Compression | false |
| Indicates whether or not ZLIB compression should be used when transferring files |
| Proxy Configuration Service | Controller 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 Type | DIRECT |
| Proxy type used for file transfers |
| Proxy Host | The fully qualified hostname or IP address of the proxy server Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Proxy Port | The port of the proxy server Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Http Proxy Username | Http Proxy Username Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Http Proxy Password | Http Proxy Password Sensitive Property: true Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Ciphers Allowed | 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 Supports Expression Language: true (will be evaluated using variable registry only) | ||
| 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 Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Key Exchange Algorithms Allowed | 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 Supports Expression Language: true (will be evaluated using variable registry only) | ||
| 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 Supports Expression Language: true (will be evaluated using variable registry only) |
Dynamic Properties allow the user to specify both the name and value of a property.
| Name | Value | Description |
|---|---|---|
| Disable Directory Listing | true or false | Disables directory listings before operations which might fail, such as configurations which create directory structures. Supports Expression Language: false |
| 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 |