> 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-port-forward.md).

# SSH port forward

This article lists all the settings and options pertaining to the ***SSH port forward*** entry type, each header representing a tab in the entry's creation/edit window.

<table data-header-hidden><thead><tr><th width="144.39996337890625"></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. A folder can be selected by clicking the arrow or the three dots to open the <strong>Folder</strong> window. To create a new folder, click on the plus (<strong>+</strong>) icon.</td></tr><tr><td><strong>Display</strong></td><td>How the session is displayed. <strong>Embedded (tabbed)</strong> means that the remote connection is open within the same window as the other tabs or entries. Each connection has its own tab, making it easy to switch between them. An <strong>undocked</strong> display refers to the session window being detached from the main application. It allows you to move and resize the remote session window freely on your desktop.</td></tr><tr><td><strong>Host</strong></td><td><strong>Host configured</strong> lets you select the host. <strong>Linked (vault)</strong> indicates that the host for the entry is linked to a host entry. <strong>Inherited</strong> is used when the host is inherited from a higher-level or parent entry.</td></tr><tr><td><strong>Credentials</strong></td><td><ul><li><strong>Username and password</strong>: You will set the username and password in the <strong>General</strong> tab.</li><li><strong>Linked (vault)</strong>: Links to credentials available in the current shared vault. To use this feature, users must have the <strong>View</strong>permission on the entry.</li><li><strong>Inherited</strong>: Inheritance means that credentials will automatically be passed down from a higher-level entry to lower-level entries that inherit from it.</li><li><strong>My personal credentials</strong>: These credentials are not entry specific but are instead taken from the option under <strong>File</strong> – <strong>My account settings</strong> – <strong>Local credentials</strong> – <strong>My personal credentials</strong>.</li><li><strong>None</strong>: Remote Desktop Manager will not send credentials to the entry.</li><li><strong>Find by name (user vault)</strong>: Searches for the name of an entry in the user vault.</li><li><strong>My privileged account</strong>: These credentials are not entry specific but are instead taken from the option under <strong>File</strong> – <strong>My account settings</strong> – <strong>Local credentials</strong> – <strong>My privileged account</strong>.</li></ul></td></tr></tbody></table>

### General

The ***General*** tab allows you to add, edit, delete, import and export port forward data. Added port forwards appear in the tab's box.

![](https://cdnweb.devolutions.net/docs/RDMW4387_2025_3.png)

### SSH settings

![](https://cdnweb.devolutions.net/docs/RDMW4388_2025_3.png)

<table><thead><tr><th width="215.5999755859375">SETTINGS</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Host</strong></td><td>The field contains the host name. Clicking on the ellipsis button opens the <em><strong>Computer list</strong></em> menu. Clicking on <em><strong>Default</strong></em> opens the <em><strong>Port</strong></em> menu. The <em><strong>Port generator...</strong></em> button can generate ports according to a list of parameters.</td></tr><tr><td><strong>Username</strong></td><td>This entry's login credentials.</td></tr><tr><td><strong>Password</strong></td><td>This entry's login credentials.</td></tr><tr><td><strong>Password prompt string</strong></td><td>A string used if a server has a different login process (this field is optional).</td></tr><tr><td><strong>OTP prompt string</strong></td><td>A string used to know when to send the OTP (this field is optional).</td></tr><tr><td><strong>Use smartcard</strong></td><td>Uses the smartcard.</td></tr><tr><td><strong>Certificate method</strong></td><td>The method used to fetch the smartcard credentials.</td></tr><tr><td><strong>PIN</strong></td><td>The smartcard PIN.</td></tr></tbody></table>

### SSH key

#### Key

![](https://cdnweb.devolutions.net/docs/RDMW4389_2025_3.png)

<table data-header-hidden><thead><tr><th width="129.20001220703125"></th><th></th></tr></thead><tbody><tr><td><strong>SETTINGS</strong></td><td><strong>DESCRIPTION</strong></td></tr><tr><td><strong>Entry type</strong></td><td><p>The source of the SSH key. Choose between:</p><ul><li><strong>No private key</strong></li><li><strong>File (local)</strong>, which lets you choose a path to a local <code>.key</code> file.</li><li><strong>Embedded data</strong>, which lets you manually enter a private key (or generate one via the <strong>SSH key generator</strong>).</li><li><strong>Linked (vault)</strong>, which lets you choose an SSH key entry from which to retrieve a key. To use this feature, users must have the <strong>View</strong>permission on the entry.</li><li><strong>Linked (external vault)</strong>, which lets you choose an SSH key entry in a external vault from which to retrieve a key. To use this feature, users must have the <strong>View</strong>permission on the entry.</li><li><strong>My personal SSH key</strong>, which uses the SSH key set in <strong>File</strong>– <strong>My account settings</strong> – <strong>My personal SSH key</strong>, under <strong>Local credentials</strong>.</li><li><strong>Find by name (user vault)</strong>, which lets you enter the name of a specific SSH key entry within the current user vault from which to retrieve a key.</li><li><strong>Privileged account</strong>, which lets you choose a PAM account from a list previously set up in Devolutions Server.</li></ul></td></tr><tr><td><strong>Vault</strong></td><td>The drop-down menu can be used to select an SSH key. The ellipsis button opens a window to browse the current vault for SSH keys (this field is only available if the <strong>Entry type</strong> is <strong>Linked (vault)</strong>).</td></tr><tr><td><strong>Passphrase</strong></td><td>The passphrase used to decrypt the key.</td></tr><tr><td><strong>File</strong></td><td>This field points to the SSH key file (this field is only available if the <strong>Entry type</strong> is <strong>File (local)</strong>).</td></tr><tr><td><strong>Private key</strong></td><td>Select or generate a private key file (this field is only for embedded data and the key is saved in Remote Desktop Manager).</td></tr></tbody></table>

#### Certificate

![](https://cdnweb.devolutions.net/docs/RDMW4390_2025_3.png)

| **SETTINGS**      | **DESCRIPTION**                         |
| ----------------- | --------------------------------------- |
| **File (local)**  | Select a local certificate file.        |
| **Embedded data** | Store the certificate in the SSH entry. |

### Proxy

![](https://cdnweb.devolutions.net/docs/RDMW4391_2025_3.png)

<table data-header-hidden><thead><tr><th width="178.79998779296875"></th><th></th></tr></thead><tbody><tr><td><strong>SETTING</strong></td><td><strong>DESCRIPTION</strong></td></tr><tr><td><strong>Proxy mode</strong></td><td>The <em><strong>Link</strong></em> mode points to a <em><strong>Proxy Tunnel</strong></em> entry. The <em><strong>Custom</strong></em> mode sets up a custom proxy with the same settings as a proxy tunnel.</td></tr></tbody></table>

* Wildcards, such as asterisks (\*), which are interpreted as any number of characters (including 0), and question marks, each of which represents a single character.
* Leading point notation, according to which ".domain.com" equals "\*.domain.com".

### Gateway

![](https://cdnweb.devolutions.net/docs/RDMW4392_2025_3.png)

<table data-header-hidden><thead><tr><th width="198.79998779296875"></th><th></th></tr></thead><tbody><tr><td><strong>SETTING</strong></td><td><strong>DESCRIPTION</strong></td></tr><tr><td><strong>Gateway mode</strong></td><td>The <em><strong>Custom</strong></em> mode lets you configure a gateway. The <em><strong>Linked</strong></em> mode picks from an already existing SSH gateway.</td></tr></tbody></table>

### Logs

![](https://cdnweb.devolutions.net/docs/RDMW4393_2025_3.png)

<table data-header-hidden><thead><tr><th width="197.2000732421875"></th><th></th></tr></thead><tbody><tr><td><strong>SETTINGS</strong></td><td><strong>DESCRIPTION</strong></td></tr><tr><td><strong>Enable logging</strong></td><td>The <em><strong>Custom</strong></em> mode requires the path and file name. The <em><strong>Global</strong></em> mode requires the file name and then to configure the global path in <em><strong>File</strong></em> – <em><strong>Settings</strong></em>.</td></tr><tr><td><strong>Log path</strong></td><td>Includes the path and the file for the log. The default log path can be configured in <em><strong>File</strong></em> – <em><strong>Settings</strong></em> – <em><strong>Entry types</strong></em> – <em><strong>Sessions</strong></em> – <em><strong>Terminal</strong></em>, under the <em><strong>Logging</strong></em> section.</td></tr><tr><td><strong>Log filename</strong></td><td>The name of the file at the location defined in <em><strong>File</strong></em> – <em><strong>Settings</strong></em> – <em><strong>Session</strong></em> – <em><strong>Terminal</strong></em> – <em><strong>Default path</strong></em>.</td></tr><tr><td><strong>Verbose</strong></td><td>This will set how in-depth logs are (only available for the <em><strong>Event</strong></em> mode).</td></tr></tbody></table>

### Advanced

![](https://cdnweb.devolutions.net/docs/RDMW4394_2025_3.png)

<table data-header-hidden><thead><tr><th width="288.39996337890625"></th><th></th></tr></thead><tbody><tr><td><strong>SETTINGS</strong></td><td><strong>DESCRIPTION</strong></td></tr><tr><td><strong>Internet protocol</strong></td><td>Choose between IPv4 or IPv6.</td></tr><tr><td><strong>Interactive authentication in terminal</strong></td><td>This option manages the behavior when the terminal asks you for interactive authentication. The <strong>No</strong> option makes Remote Desktop Manager manage it, while <strong>Yes</strong> makes the terminal manage it.</td></tr><tr><td><strong>Disconnect action</strong></td><td>What happens when the SSH terminal disconnects.</td></tr><tr><td><strong>Display error messages</strong></td><td>Choose to show error messages or not.</td></tr><tr><td><strong>Always accept fingerprint</strong></td><td>Always accept fingerprints or not.</td></tr><tr><td><strong>Mouse click mode</strong></td><td><p>Changes right-click behavior:</p><ul><li><strong>Windows</strong>: prompts a context menu.</li><li><strong>Compromise</strong>: pastes.</li><li><strong>XTerm</strong>: Selects text.</li></ul></td></tr><tr><td><strong>Algorithm support</strong></td><td>In the <strong>Custom</strong> mode, click the ellipsis button to select one or multiple <strong>Cipher</strong>, <strong>Host key</strong>, <strong>Kex</strong> and/or <strong>MAC</strong> algorithms.</td></tr><tr><td><strong>Minimum Diffie-Hellman key size</strong></td><td>Minimum key size in bits.</td></tr><tr><td><strong>Ignore Substitute character</strong></td><td>Ignores substitute characters or not.</td></tr><tr><td><strong>Enable TCP keepalives</strong></td><td>Enables TCP keepalives.</td></tr><tr><td><strong>Enable GSS API authentication</strong></td><td>Enables GSS API authentication.</td></tr><tr><td><strong>Skip environment variable setup</strong></td><td>Skips environment variable setup.</td></tr><tr><td><strong>Enable GSS API credential delegation</strong></td><td>Enable GSS API credential delegation.</td></tr><tr><td><strong>Allow SSH authentication agent forwarding</strong></td><td>Allow SSH authentication agent forwarding.</td></tr><tr><td><strong>Disable Nagle's algorithm</strong></td><td>Disable Nagle's algorithm.</td></tr><tr><td><strong>Use SSH authentication agent</strong></td><td>Uses the SSH authentication agent currently opened on your machine (including the Remote Desktop Manager SSH key agent).</td></tr><tr><td><strong>Ping interval</strong></td><td>A command is sent every X second to keep the connection alive.</td></tr><tr><td><strong>Ping string</strong></td><td>The string which is sent with the <strong>Ping interval</strong> option.</td></tr><tr><td><strong>Paste delay</strong></td><td>Added delay for pasting text.</td></tr><tr><td><strong>Environment variables</strong></td><td>Sets environment variables to be used by the terminal.</td></tr></tbody></table>


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.devolutions.net/rdm/knowledge-base/knowledge-base-articles/entry-settings/ssh-port-forward.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.