The SFTP Connection Manager contains the following three pages to connect to your SFTP server.

  • General
  • Proxy Settings
  • Advanced Settings

General page

The General page on the SFTP Connection Manager allows you to specify general settings for the connection.

SFTP Connection Manager

Host Name

The Host Name represents the Server containing your SFTP server.

Port

The Port contains a default value 22.

Authentication Method

The Authentication Method contains two allows options:

  • Password: Provide a password in the password parameter.
  • Key: Fill in the location of the key for your SFTP server in the Path to Key File parameter.
Path to Key File

When the Authentication Method selected is Key, you would select the Browse button for the Path to Key File parameter to find the location of the Key for the Username account of your SFTP server.

User Name

Enter User Name for the SFTP server.

Password

Enter Password for the SFTP server. Enabled when the Authentication Method selected is Password.

File Phrase

Enter the File Passphrase information. Enabled when the Authentication Method is Key.

Timeout (secs)

The Timeout (secs) option allows you to specify a timeout value in seconds for the connection. The default value is 120 seconds.

Test Connection

After all the connection information has been provided, you may click the Test Connection button to test if the connection settings entered are valid.

Proxy Settings

The Proxy Settings page on the SFTP Connection Manager allows you to specify the proxy settings for the connection.

SFTP Connection Manager - Proxy

Proxy Type

The Proxy Type option lets you select if you are using a Proxy, and if so, what type.

  • None
  • Socks4
  • Socks4a
  • Socks5
  • HttpConnect
  • FtpSite
  • FtpUser
  • FtpOpen
  • FtpDoubleLogin
Proxy Server

Using Proxy Server option allows you to specify the name of the proxy server for the connection.

Port

The Port option allows you to specify port number of the proxy server for the connection.

Username

The Username option allows you to specify the proxy user account.

Password

Using Password option (under Proxy Server Authentication) allows you to specify the proxy user's password.

Note: The Proxy Password is not included in the SFTP connection manager's ConnectionString property by default. This is done by design for security reasons. However you can include it in your ConnectionString if you want to parameterize your connection manager. The format would be ProxyPassword=myProxyPassword; (make sure you have a semicolon as the last character). It can be anywhere in the ConnectionString. 

Data Transfer Settings

SFTP Connection Manager - Data Transfer Settings

Use Large Buffers

Specify whether you want to use large receive buffer for incoming and outgoing data.

Use Small Packets

Use small data packets (4KB each) during upload and never split them.

Use Compression

Specifies whether to use communication compression if supported by the server.

Download Buffer Size

Sets the maximum allowed download speed. For unlimited speed, set this to zero. Default value is 49152.

Download Queue Length

Sets the length of packed queue for downloads. Default value is 8.

Use Streamed Download (since v8.0)

Enable this option to download large files from SFTP server.

Upload Buffer Size

Sets the size of data packets used during upload. Supported sizes are 4 KB to 48 KB. Default value is 49152.

Upload Queue Length

Sets the length of packed queue for uploads.

Key Settings

SFTP Connection Manager - Key Settings

Key Exchange Algorithms

Specify the list of key exchange algorithms in order of preference. 

Supported algorithms are: "diffie-hellman-group1-sha1", "diffie-hellman-group14-sha1", "diffie-hellman-group-exchange-sha1", "diffie-hellman-group-exchange-sha256", "diffie-hellman-group14-sha256", "diffie-hellman-group15-sha512", "diffie-hellman-group16-sha512", "ecdh-sha2-nistp256", "ecdh-sha2-nistp384", "ecdh-sha2-nistp521", "[email protected]"

Encryption Algorithms

Specify the list of acceptable symmetric encryption algorithms in order of preference.

Supported algorithms are: "aes256-ctr", "aes192-ctr", "aes128-ctr", "aes256-cbc", "aes192-cbc", "aes128-cbc", "3des-ctr", "3des-cbc", "twofish256-ctr", "twofish192-ctr", "twofish128-ctr", "twofish256-cbc", "twofish192-cbc", "twofish128-cbc", "twofish-cbc", "blowfish-ctr", "blowfish-cbc", "arcfour256", "arcfour128", "arcfour"

Host Key Algorithm (since v8.0)

Sets the preferred host key (server key) algorithm.

Minimum RSA Key Size

Sets the minimum allowed size of the RSA key. Default size is 1024.

Misc. Settings

SFTP Connection Manager - Misc Settings

Timeout (secs)

The Timeout (secs) option allows you to specify a timeout value in seconds for the connection. The default value is 120 seconds.

Keep Alive Interval

The Keep Alive Interval option allows you to specify the interval of sending empty packet to prevent connection from being closed by SSH-unfriendly routers along the way during no activity. Default is 0, which means no empty package will be sent.

Encoding (since v8.0)

The Encoding option allows you to specify the encoding code to read the file system information on SFTP server.

Path To Log File

The Path To Log File option allows you to specify the file path to write SFTP communication log to.

Log Level

There are several options available:

  • Off: default
  • Error: logs error messages only
  • Info: logs important informative messages as well
  • Debug: logs all messages useful for debugging purposes
  • Verbose: very detailed log for advanced analysis; logs content of communication packets