> 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-vpn.md).

# SSH (VPN)

Configure SSH VPN entries in Remote Desktop Manager to open an SSH tunnel before a session, in simple or advanced configuration, with its VPN settings.

This article details the settings available for ***SSH*** VPN entries in Remote Desktop Manager. An ***SSH*** VPN entry opens an SSH tunnel with the built-in SSH client of Remote Desktop Manager, so that the sessions linked to it connect through the SSH server. It is a different entry type from [SSH gateway](https://docs.devolutions.net/rdm/knowledge-base/knowledge-base-articles/entry-settings/ssh-gateway.md).

<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>How the entry opens. This entry type only supports <em><strong>External</strong></em>, so the display mode cannot be changed.</td></tr><tr><td><strong>Host</strong></td><td>Where the host of the SSH server comes from. When the host comes from another entry, the <em><strong>Host</strong></em> field of the <em><strong>Connection</strong></em> tab is disabled.</td></tr><tr><td><strong>Credentials</strong></td><td>How the credentials of the entry are provided. When the credentials do not come from the entry itself, the <em><strong>Username</strong></em> and <em><strong>Password</strong></em> fields of the <em><strong>Connection</strong></em> tab are disabled.</td></tr><tr><td><strong>VPN type</strong></td><td>The type of VPN the entry opens. Select another type from the list to change the VPN client used by the entry.</td></tr></tbody></table>

### Connection

The ***Connection*** tab contains the ***General***, ***SSH key***, ***Proxy***, ***SSH gateway***, ***Logs*** and ***Advanced*** tabs of the SSH connection. Except for the settings below, they are the same as for [SSH tunnel](https://docs.devolutions.net/rdm/knowledge-base/knowledge-base-articles/entry-settings/ssh-tunnel.md) entries.

**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. Disabled when the host comes from another entry.</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>Set host public key</strong></td><td>Saves the expected public key of the SSH server.</td></tr><tr><td><strong>Username</strong></td><td>The SSH username. Disabled when the credentials do not come from the entry.</td></tr><tr><td><strong>Password</strong></td><td>The SSH password. Disabled when the credentials do not come from the entry, when <em><strong>Always ask for password</strong></em> is selected, 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>Prompts for the password each time the VPN opens.</td></tr><tr><td><strong>Password prompt string</strong></td><td>The text of the server prompt that asks for the password.</td></tr><tr><td><strong>OTP prompt string</strong></td><td>The text of the server prompt that asks for a one-time password.</td></tr><tr><td><strong>Use smart card</strong></td><td>Signs in with a smart card. When selected, choose the <em><strong>Certificate method</strong></em> and enter the <em><strong>PIN code</strong></em>.</td></tr><tr><td><strong>Configuration</strong></td><td><p>How the tunnel is configured:</p><ul><li><strong>Simple</strong> — Remote Desktop Manager forwards a local port to the host and port of each session that uses the VPN. New entries use this value.</li><li><strong>Advanced</strong> — the tunnel is defined in <em><strong>Outgoing tunnel settings</strong></em>.</li></ul></td></tr><tr><td colspan="2"><strong>Outgoing tunnel settings</strong> (shown with the <em><strong>Advanced</strong></em> configuration)</td></tr><tr><td><strong>Mode</strong></td><td>The type of port forwarding: <em><strong>Local</strong></em> (default), <em><strong>Remote</strong></em> or <em><strong>Dynamic</strong></em>.</td></tr><tr><td><strong>Source</strong></td><td>The source address of the tunnel. The default value is <code>127.0.0.1</code>. Required.</td></tr><tr><td><strong>Source port</strong></td><td>The source port of the tunnel. The default port is 3390. Hidden when <em><strong>Use dynamic port</strong></em> is selected.</td></tr><tr><td><strong>Destination</strong></td><td>The destination host and port of the tunnel. The default port is 3389. Disabled with the <em><strong>Dynamic</strong></em> mode; required with the other modes.</td></tr><tr><td><strong>Use dynamic port</strong></td><td>Uses a free local port chosen when the VPN opens, instead of <em><strong>Source port</strong></em>.</td></tr><tr><td><strong>Force "localhost"</strong></td><td>Whether the sessions that use the VPN connect to <code>localhost</code>: <em><strong>Default</strong></em>, <em><strong>Yes</strong></em> or <em><strong>No</strong></em>. Enabled when <em><strong>Use dynamic port</strong></em> is selected.</td></tr></tbody></table>

### Advanced

<table><thead><tr><th width="220">SETTINGS</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Go offline on connection</strong></td><td>Switch Remote Desktop Manager to offline mode when the VPN connects.</td></tr><tr><td><strong>Close connection after</strong></td><td>Close the VPN automatically after the number of minutes entered in the field, from 0 to 4320.</td></tr><tr><td><strong>Detect reachable host in wait</strong></td><td>Detect whether the host can be reached while waiting for the VPN to connect.</td></tr><tr><td><strong>VPN reconnect mode</strong></td><td><p>How Remote Desktop Manager handles the VPN when it reconnects:</p><ul><li><strong>Default</strong></li><li><strong>Reconnect VPN</strong></li><li><strong>Leave VPN open</strong></li></ul></td></tr><tr><td><strong>Go online on disconnect after</strong></td><td>Switch Remote Desktop Manager back to online mode after the VPN disconnects, once the number of seconds entered in the field has elapsed, from 0 to 180.</td></tr><tr><td><strong>Use adapter to detect connection</strong></td><td>Use the network adapter to detect whether the VPN is connected.</td></tr><tr><td><strong>After execution, wait</strong></td><td><p>What Remote Desktop Manager waits for after starting the VPN:</p><ul><li><strong>Delay</strong> — Wait for the number of seconds entered in the field, from -1 to 180.</li><li><strong>For IP on adapter</strong> — Wait for the network adapter entered in the field to obtain an IP address. Enter an adapter name or a device name, or leave the field blank. Click the browse button to select an adapter.</li></ul></td></tr><tr><td><strong>Wait a maximum of</strong></td><td>With <em><strong>For IP on adapter</strong></em>, the maximum number of seconds to wait for the adapter to obtain an IP address, from -1 to 180.</td></tr><tr><td><strong>Then delay</strong></td><td>With <em><strong>For IP on adapter</strong></em>, an additional delay in milliseconds once the adapter has an IP address, from -1 to 180000 in increments of 100.</td></tr><tr><td><strong>Commands</strong></td><td>The list of VPN commands, with their <em><strong>Name</strong></em>, <em><strong>After connection command</strong></em>, and <em><strong>Before disconnecting command</strong></em>. Use <em><strong>Add</strong></em>, <em><strong>Edit</strong></em>, <em><strong>Delete</strong></em>, <em><strong>Move up</strong></em>, and <em><strong>Move down</strong></em> to manage the list. The commands are available only when <em><strong>After execution, wait</strong></em> is set to <em><strong>For IP on adapter</strong></em>, and are not supported on macOS.</td></tr><tr><td><strong>After connecting, VPN command enabled</strong></td><td>Run the <em><strong>After connection command</strong></em> of the listed commands once the VPN is connected. Available only when <em><strong>After execution, wait</strong></em> is set to <em><strong>For IP on adapter</strong></em>. Not supported on macOS.</td></tr><tr><td><strong>Before disconnecting, VPN command enabled</strong></td><td>Run the <em><strong>Before disconnecting command</strong></em> of the listed commands before the VPN disconnects. Available only when <em><strong>After execution, wait</strong></em> is set to <em><strong>For IP on adapter</strong></em>. Not supported on macOS.</td></tr><tr><td><strong>Run routes in batch (forces elevated privileges)</strong></td><td>Run the commands as a batch. This option requires elevated privileges. Available only when <em><strong>After execution, wait</strong></em> is set to <em><strong>For IP on adapter</strong></em>. Not supported on macOS.</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 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-vpn.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.
