> For the complete documentation index, see [llms.txt](https://docs.devolutions.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.devolutions.net/rdm/knowledge-base/knowledge-base-articles/entry-settings/ssh-key-dashboard.md).

# SSH key dashboard

Configure SSH key dashboard entries in Remote Desktop Manager, including host, credentials, smart card, private key, certificate, proxy, SSH gateway, and logs.

This article details the many settings and options available for ***SSH key dashboard*** session entries in Remote Desktop Manager.

<table data-header-hidden><thead><tr><th width="200"></th><th></th></tr></thead><tbody><tr><td><strong>SETTINGS</strong></td><td><strong>DESCRIPTION</strong></td></tr><tr><td><strong>Name</strong></td><td>The name of the entry.</td></tr><tr><td><strong>Folder</strong></td><td>The folder where the entry is located.</td></tr><tr><td><strong>Display</strong></td><td><p>How the entry opens:</p><ul><li><strong>Embedded (tabbed)</strong> — Opens the entry in a tab of the main window.</li><li><strong>Undocked</strong> — Opens the entry in a separate window. Additional lists let you choose the monitor and the virtual desktop where the window opens.</li></ul><p>On Linux, the list also offers <em><strong>Default (inherited)</strong></em>, which uses the display mode of the nearest parent folder that sets one, otherwise the default of the entry type. The mode it resolves to is shown next to the list.</p></td></tr><tr><td><strong>Host</strong></td><td>Where the host of the entry comes from. <em><strong>Host configured</strong></em> uses the <em><strong>Host</strong></em> entered in the <em><strong>General</strong></em> tab. <em><strong>Linked</strong></em> uses a host entry from the vault selected in the <em><strong>Vault</strong></em> list. <em><strong>Inherited</strong></em> uses the host of a parent folder.</td></tr><tr><td><strong>Credentials</strong></td><td>How the credentials of the entry are provided. Select a credential mode from the list.</td></tr></tbody></table>

### General

<table><thead><tr><th width="220">SETTINGS</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Host</strong></td><td>The host name or IP address of the SSH server whose authorized keys are managed. This field is required unless the host comes from a linked or inherited host, in which case it is disabled. When the field is empty, the entry name is copied into it.</td></tr><tr><td><strong>Port</strong></td><td>The port of the SSH server. The default port is 22.</td></tr><tr><td><strong>Username</strong></td><td>The username used to connect to the SSH server. This field is disabled when the credentials come from another source than the entry itself.</td></tr><tr><td><strong>Password</strong></td><td>The password used to connect to the SSH server. This field is disabled when the credentials come from another source than the entry itself, when <em><strong>Always ask for password</strong></em> is enabled, or when the <em><strong>Disable password saving in vaults</strong></em> system setting is enabled.</td></tr><tr><td><strong>Always ask for password</strong></td><td>Prompt for the password each time the entry is opened instead of saving it in the entry. This option is disabled when the credentials come from another source than the entry itself.</td></tr><tr><td><strong>Use smart card</strong></td><td>Use a smart card to authenticate. Enables the <em><strong>Certificate method</strong></em> and <em><strong>PIN code</strong></em> fields.</td></tr><tr><td><strong>Certificate method</strong></td><td><p>How the certificate is read from the smart card. Available when <em><strong>Use smart card</strong></em> is enabled:</p><ul><li><strong>CAPI</strong></li><li><strong>PKCS</strong></li><li><strong>Try all modes</strong></li></ul></td></tr><tr><td><strong>PIN code</strong></td><td>The PIN code of the smart card. Available when <em><strong>Use smart card</strong></em> is enabled.</td></tr></tbody></table>

### SSH key

The ***SSH key*** tab contains a ***Key*** tab and a ***Certificate*** tab.

**Key**

<table><thead><tr><th width="220">SETTINGS</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Private key</strong></td><td><p>Where the private key comes from. The options offered depend on the data source and on system settings, for example:</p><ul><li><strong>No private key</strong> — No private key is used.</li><li><strong>File (local)</strong> — Uses a private key file stored on the local computer.</li><li><strong>Embedded data</strong> — Stores the private key data in the entry.</li><li><strong>Linked</strong> — Uses the private key of another entry. Select the vault in the <em><strong>Vault</strong></em> field, then select the entry.</li><li><strong>My personal SSH key</strong> — Uses the personal SSH key configured for the current user. Click the <em><strong>Edit</strong></em> button next to the list to edit it.</li></ul></td></tr><tr><td><strong>Vault</strong></td><td>The vault that contains the linked private key entry. Shown when <em><strong>Linked</strong></em> is selected.</td></tr><tr><td><strong>Entry</strong></td><td>The entry that contains the private key. Shown for linked private keys. Use the buttons in the field to browse for an entry, add a private key entry, or clear the selection.</td></tr><tr><td><strong>Search string</strong></td><td>The search string used to find the private key entry in the user vault. Shown when the private key is found by a search string.</td></tr><tr><td><strong>File</strong></td><td>The path of the private key file. Shown when <em><strong>File (local)</strong></em> is selected.</td></tr><tr><td><strong>Passphrase</strong></td><td>The passphrase of the private key. Shown when <em><strong>File (local)</strong></em> or <em><strong>Embedded data</strong></em> is selected, and disabled when <em><strong>Always prompt for passphrase</strong></em> is enabled.</td></tr><tr><td><strong>Always prompt for passphrase</strong></td><td>Prompt for the passphrase each time the private key is used instead of saving it in the entry. Shown when <em><strong>File (local)</strong></em> or <em><strong>Embedded data</strong></em> is selected.</td></tr><tr><td><strong>Private key data</strong></td><td>The private key data stored in the entry. Shown when <em><strong>Embedded data</strong></em> is selected. Use the buttons above the field to generate a key, view the data, paste it from the clipboard, browse for a key file, or clear the data.</td></tr></tbody></table>

**Certificate**

The ***Certificate*** tab is shown when a private key is selected and is either a ***File (local)*** or ***Embedded data*** key, or when a certificate is already configured.

<table><thead><tr><th width="220">SETTINGS</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Certificate type</strong></td><td><p>Where the SSH certificate comes from:</p><ul><li><strong>No certificate</strong></li><li><strong>File (local)</strong></li><li><strong>Embedded data</strong></li></ul><p>When the private key comes from another entry, an information icon indicates that a certificate configured on that linked SSH credential takes priority over the certificate specified here.</p></td></tr><tr><td><strong>File</strong></td><td>The path of the certificate file. Available when <em><strong>Certificate type</strong></em> is <em><strong>File (local)</strong></em>.</td></tr><tr><td><strong>Certificate</strong></td><td>The certificate data stored in the entry. Shown when <em><strong>Certificate type</strong></em> is <em><strong>Embedded data</strong></em>. Use the buttons above the field to view the data, clear it, paste it from the clipboard, or browse for a certificate file.</td></tr></tbody></table>

### Proxy

<table><thead><tr><th width="220">SETTINGS</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Proxy mode</strong></td><td><p>How the connection goes through a proxy:</p><ul><li><strong>None</strong> — No proxy is used.</li><li><strong>Link</strong> — Uses the proxy settings of another entry, selected in the <em><strong>Proxy</strong></em> field.</li><li><strong>Custom</strong> — Uses the proxy settings configured in this tab.</li></ul></td></tr><tr><td><strong>Proxy</strong></td><td>The entry that provides the proxy settings. Shown when <em><strong>Proxy mode</strong></em> is <em><strong>Link</strong></em>.</td></tr><tr><td><strong>Proxy type</strong></td><td><p>The type of proxy. Shown when <em><strong>Proxy mode</strong></em> is <em><strong>Custom</strong></em>:</p><ul><li><strong>Socks4</strong></li><li><strong>Socks5</strong></li><li><strong>HTTP</strong></li><li><strong>Local</strong></li></ul><p><em><strong>Telnet</strong></em> is also listed for an entry that already uses it.</p></td></tr><tr><td><strong>Host</strong></td><td>The host name or IP address of the proxy, and its <em><strong>Port</strong></em>. Not shown for a <em><strong>Local</strong></em> proxy.</td></tr><tr><td><strong>Credential mode</strong></td><td><p>How the proxy credentials are provided. The options offered depend on the vault and the data source, for example:</p><ul><li><strong>Username and password</strong> — Uses the <em><strong>Username</strong></em> and <em><strong>Password</strong></em> entered in this tab.</li><li><strong>Linked</strong> — Uses a credential entry. Select the vault in the <em><strong>Vault</strong></em> list, then select the entry in the <em><strong>Credential</strong></em> field. Selecting the user vault from an entry in a shared vault finds the credential entry in each user's user vault by the name entered in the field below the list.</li><li><strong>My personal credentials</strong></li><li><strong>My privileged account</strong></li></ul><p>For <em><strong>My personal credentials</strong></em> and <em><strong>My privileged account</strong></em>, a button next to the list opens <em><strong>My account settings</strong></em>.</p></td></tr><tr><td><strong>Credential</strong></td><td>The credential entry that provides the proxy credentials. Shown when <em><strong>Credential mode</strong></em> is <em><strong>Linked</strong></em>.</td></tr><tr><td><strong>Username</strong></td><td>The username used to authenticate on the proxy. Shown when <em><strong>Credential mode</strong></em> is <em><strong>Username and password</strong></em>.</td></tr><tr><td><strong>Password</strong></td><td>The password used to authenticate on the proxy. Disabled when <em><strong>Always ask for password</strong></em> is enabled.</td></tr><tr><td><strong>Always ask for password</strong></td><td>Prompt for the proxy password each time the entry is opened instead of saving it in the entry.</td></tr><tr><td><strong>Excluded hosts</strong></td><td>The hosts that are reached directly instead of through the proxy. Not shown for a <em><strong>Local</strong></em> proxy.</td></tr><tr><td><strong>Consider proxying localhost connections</strong></td><td>Send connections to the local computer through the proxy as well. Not shown for a <em><strong>Local</strong></em> proxy.</td></tr><tr><td><strong>DNS name lookup at the proxy end</strong></td><td><p>Whether host names are resolved by the proxy. Not shown for a <em><strong>Local</strong></em> proxy:</p><ul><li><strong>Automatic</strong></li><li><strong>Yes</strong></li><li><strong>No</strong></li></ul></td></tr></tbody></table>

### SSH gateway

<table><thead><tr><th width="220">SETTINGS</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Gateway mode</strong></td><td><p>How the connection goes through SSH gateways:</p><ul><li><strong>None</strong> — No SSH gateway is used.</li><li><strong>Custom</strong> — Uses the list of SSH gateways shown below the list, with the <em><strong>Host</strong></em> and <em><strong>Port</strong></em> of each gateway. Use the <em><strong>New</strong></em>, <em><strong>Edit</strong></em>, and <em><strong>Delete</strong></em> buttons to manage the gateways, and the up and down arrow buttons to change their order.</li><li><strong>Linked</strong> — Uses the SSH gateway of another entry, selected in the <em><strong>Gateway</strong></em> field.</li></ul></td></tr><tr><td><strong>Gateway</strong></td><td>The entry that provides the SSH gateway. Shown when <em><strong>Gateway mode</strong></em> is <em><strong>Linked</strong></em>.</td></tr></tbody></table>

### Logs

<table><thead><tr><th width="220">SETTINGS</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Enable logging</strong></td><td>Write the session output to a log file. Disabled when <em><strong>Log into terminal</strong></em> is enabled.</td></tr><tr><td><strong>Log path type</strong></td><td><p>Where the log file is written. Available when <em><strong>Enable logging</strong></em> is enabled and <em><strong>Log into terminal</strong></em> is cleared:</p><ul><li><strong>Custom</strong> — Writes the log to the file set in <em><strong>Log path</strong></em>.</li><li><strong>Global</strong> — Writes the log to the file named in <em><strong>Log filename</strong></em>, in the default log path set in the application settings.</li></ul></td></tr><tr><td><strong>Log path</strong></td><td>The full path of the log file. Shown when <em><strong>Log path type</strong></em> is <em><strong>Custom</strong></em>, and available when <em><strong>Enable logging</strong></em> is enabled.</td></tr><tr><td><strong>Log filename</strong></td><td>The name of the log file. Shown when <em><strong>Log path type</strong></em> is <em><strong>Global</strong></em>, and available when <em><strong>Enable logging</strong></em> is enabled. An information icon next to the field reminds you to set the default log path in the application settings.</td></tr><tr><td><strong>Log mode</strong></td><td><p>What is written to the log file. Available when <em><strong>Enable logging</strong></em> is enabled:</p><ul><li><strong>Event</strong></li><li><strong>Printable output</strong></li></ul></td></tr><tr><td><strong>Log overwrite mode</strong></td><td><p>What happens when the log file already exists. Available when <em><strong>Enable logging</strong></em> is enabled and <em><strong>Log mode</strong></em> is <em><strong>Printable output</strong></em>:</p><ul><li><strong>Default</strong> — Uses the mode set in the application settings. The item shows that mode in parentheses, for example <em><strong>Default (Prompt)</strong></em>.</li><li><strong>Prompt</strong></li><li><strong>Append</strong></li><li><strong>Overwrite</strong></li></ul></td></tr><tr><td><strong>Verbose</strong></td><td>The level of detail of the log, from 0 to 4.</td></tr><tr><td><strong>Log into terminal</strong></td><td>Display the log in the terminal instead of writing it to a file.</td></tr></tbody></table>

### See also

* [Create and use SSH key dashboard entry](https://docs.devolutions.net/rdm/knowledge-base/how-to-articles/create-and-use-ssh-key-dashboard-entry.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.devolutions.net/rdm/knowledge-base/knowledge-base-articles/entry-settings/ssh-key-dashboard.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
