Using the SSH Connection Manager

Use the SSH Task can be used to create an SSH Connection and consists of four pages:

  • General
  • Proxy Settings
  • Key Settings
  • Miscellaneous Settings

General page

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

SSH Connection Manager - General

Host Name

The Host Name represents the Server containing your SSH server.

Port

The Port contains a default value 22.

Authentication
Username

Enter the username for the SSH connection.

Password

Enter the password for the SSH Connection.

Path to Key File

You could select the Browse button for the Path to Key File parameter to find the location of the Key for the Username account of your SSH server.

Key File Password

Specify the password for the key file.

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 SSH Connection Manager allows you to specify the proxy settings for the connection.

SSH Connection Manager - Proxy Settings

Proxy Type

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

  • None
  • Socks4
  • Socks4a
  • Socks5
  • HTTP Connect
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 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.

Key Settings

SSH Connection Manager - Key Settings

Key Exchange Algorithms

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

Use Legacy Group Exchange

This option can be unchecked to disable Use Legacy Group Exchange. By default this option would be enabled.

Encryption Algorithms

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

Host Key Algorithm

Sets the preferred host key (server key) algorithm.

Preferred Host Key Algorithm

You can choose the Host Key algorithm from the given list:

  • Certificate
  • DSS
  • ESDsaNistP256
  • ESDsaNistP384
  • ESDsaNistP521
  • ED25519
  • RSA
Minimum RSA Key Size

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

Miscellaneous Settings

SSH Connection Manager - Miscellaneous 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

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

Use Compression

Enable this option to use compression.

Path To Log File

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

Output Log

Enables this option to have output log.

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