MySQL Workbench Manual  /  ...  /  Standard TCP/IP over SSH Connection Method

5.3.3 Standard TCP/IP over SSH Connection Method

This connection method enables MySQL Workbench to connect to MySQL Server using TCP/IP over an SSH connection.


Because TLSv1.2 requires OpenSSL, support for this protocol is available for MySQL Workbench Commercial Editions, and not for the Community Edition (which is compiled using yaSSL and supports TLSv1.1 only).

Parameters Tab

In addition to a number of parameters that are in common with Standard TCP/IP connections, this connection method features a number of specialized parameters. These options are:

  • SSH Hostname: The name of the SSH server. An optional port number can also be provided. For example, localhost:22.

  • SSH Username: The name of the SSH user to use to make a connection.

  • SSH Password: The SSH password. It is recommended that an SSH key file is also used.

  • SSH Key File: A path to the SSH key file.

If a remote host is missing from the system's list of known hosts, a prompt requires you to confirm the host's fingerprint before storing it. If your stored host fingerprint is different than the host's current fingerprint, then an error is generated and you will be required to handle the discrepancy from outside of MySQL Workbench before creating the connection. Prior to MySQL Workbench 6.1.6, the host SSH fingerprint was not saved by MySQL Workbench.

On Linux and macOS, SSH host fingerprints are stored in ~/.ssh/known_hosts. On Microsoft Windows, they are stored in a file created by MySQL Workbench under the user's application data folder (%appdata%), such as C:\Users\[username]\AppData\Roaming\MySQL\Workbench\known_hosts.

The following figure shows the SSH connection settings.

Figure 5.15 Manage Server Connections - Standard TCP/IP over SSH Parameters

Content is described in the surrounding text.


The SSL options for this connection method are the same as the options described in Section 5.3.1, “Standard TCP/IP Connection Method”.

Advanced Tab

The advanced options for this connection method are the same as the options described in Section 5.3.1, “Standard TCP/IP Connection Method”, except the Timeout option does not apply.

User Comments
User comments in this section are, as the name implies, provided by MySQL users. The MySQL documentation team is not responsible for, nor do they endorse, any of the information provided here.
Sign Up Login You must be logged in to post a comment.