> 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/getting-started/workspaces/workspace-types/alternative-workspaces/microsoft-sql-server.md).

# Microsoft SQL Server

Explore Microsoft SQL Server as an advanced Remote Desktop Manager workspace, covering supported versions, features, and configuration settings.

Remote Desktop Manager leverages Microsoft SQL Server as an advanced workspace to store and manage entries.

Supported Microsoft SQL Server:

* Microsoft SQL Server 2017/[2019](https://www.microsoft.com/en-us/sql-server/sql-server-2019)/[2022](https://www.microsoft.com/en-us/sql-server/sql-server-2022)/2025 (including Express edition. See [limitations](https://learn.microsoft.com/en-us/sql/sql-server/editions-and-components-of-sql-server-2019?view=sql-server-ver16#Cross-BoxScaleLimits).)

The following features are also supported:

* Always on availability group
* Clustering
* Log shipping
* Database mirroring

### Highlights

* Supports user management with a superior security model.
* Supports the [offline mode](/rdm/getting-started/workspaces/offline-mode.md) for when the server or network is unavailable.
* Supports full entry logs and attachments.
* Supports vaults to organize thousands of entries.

{% hint style="danger" %}
Key points to consider:- A proper database backup strategy should be implemented to prevent possible data loss.

* Depending on the recovery model of the underlying database, some maintenance operations may have to be scheduled to run regularly to maintain the health of the database.
* Using either Database Login or Integrated Security is inherently less secure because it means that the end user can connect directly to the database using any tool available. We do have table and column level security, but security conscious organizations will consider this unacceptable. It is recommended to use our Custom login model.
* Creating contained database users as mentioned in Microsoft's Contained Databases is the supported method with SQL always on availability groups.
  {% endhint %}

### Configuration

Consult [Configure SQL server](/rdm/getting-started/workspaces/workspace-types/alternative-workspaces/microsoft-sql-server/configure-a-microsoft-sql-server-workspace.md) for more information on the configuration.

### Settings

{% tabs %}
{% tab title="Windows" %}

#### General

<table><thead><tr><th width="214">OPTION</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Name</strong></td><td>Enter a name for the workspace.</td></tr><tr><td><strong>Host</strong></td><td>Enter the server hostname or IP address.</td></tr><tr><td><strong>Login mode</strong></td><td><p>Specify the authentication mode to use. Select between:</p><ul><li><strong>Database login</strong></li><li><strong>Integrated security (Active Directory)</strong></li><li><strong>Custom login</strong></li></ul></td></tr><tr><td><strong>Username</strong></td><td>Enter the username to access the SQL server.</td></tr><tr><td><strong>Password</strong></td><td>Enter the password to access the SQL server.</td></tr><tr><td><strong>Always ask password</strong></td><td>Prompt for the password when a user connects to the workspace.</td></tr><tr><td><strong>Allow change username</strong></td><td>Allow the username to be edited when connecting to the workspace (only with <strong>Always ask password</strong> enabled).</td></tr><tr><td><strong>Database</strong></td><td>Name of the database on the SQL server for the utilization of Remote Desktop Manager.</td></tr><tr><td><strong>Test host</strong></td><td>Test the connection with the host to validate if the proper information has been provided.</td></tr><tr><td><strong>Test database</strong></td><td>Test the connection with the database to validate if the proper information has been provided.</td></tr></tbody></table>

#### Settings

<table><thead><tr><th width="227">OPTION</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Ping online method</strong></td><td><p>Indicate the preferred ping online method. Select between:</p><ul><li>None</li><li>Ping</li><li>Port scan</li></ul></td></tr><tr><td><strong>Automatically go offline on offline prompt</strong></td><td>Use the workspace in offline mode when the ping method does not respond.</td></tr></tbody></table>

#### Upgrade

<table><thead><tr><th width="222">OPTION</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Test host</strong></td><td>Test the connection to the host to validate if the proper information has been provided.</td></tr><tr><td><strong>Create database</strong></td><td>Create the database on the SQL server to use Remote Desktop Manager.</td></tr><tr><td><strong>Update database</strong></td><td>Update the database on the SQL server, if required to use Remote Desktop Manager.</td></tr><tr><td><strong>Validate database</strong></td><td>Validate the content of the database.</td></tr><tr><td><strong>Test database</strong></td><td>Test the connection with the database to validate if the proper information has been provided.</td></tr><tr><td><strong>Email schema to support</strong></td><td>Send your schema to our customer support team.</td></tr><tr><td><strong>View upgrade script</strong></td><td>If you wish to process database upgrade by hand instead of automatically you may use the upgrade script to do so.</td></tr></tbody></table>

#### User vault

<table><thead><tr><th width="174">OPTION</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Connection type</strong></td><td><p>Select the type of user vault to use. Select between:</p><ul><li>Default: use the default user vault, which is stored in the database.</li><li>None: disable the user vault for all users.</li></ul></td></tr></tbody></table>

#### VPN

<table><thead><tr><th width="204">OPTION</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Type</strong></td><td><p>Select between:</p><ul><li><strong>None</strong></li><li><strong>On first connect</strong></li><li><strong>Connect if unable to ping/port scan</strong></li></ul></td></tr><tr><td><strong>RDM file</strong></td><td>Open a <strong>VPN entry type</strong> from a <strong>RDM file</strong> before connecting to the workspace.</td></tr><tr><td><strong>Override credentials</strong></td><td>Override credentials such as <strong>Username, Domain</strong>, and <strong>Password</strong>.</td></tr></tbody></table>

#### Advanced

<table><thead><tr><th width="262">OPTION</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Caching mode</strong></td><td>Determines how the entries will be reloaded in the workspace. For more information, please consult <a href="/rdm/getting-started/workspaces/caching.md">Caching</a>.</td></tr><tr><td><strong>Sync all vaults (background)</strong></td><td>Synchronization ensures that any changes made to a vault, such as updating passwords or adding new sessions, are propagated across all connected devices and users in real-time.</td></tr><tr><td><strong>Trust certificate</strong></td><td>Set how the workspace handles certificates.</td></tr><tr><td><strong>Connection timeout</strong></td><td>Waiting time before a connection timeout.</td></tr><tr><td><strong>Command timeout</strong></td><td>Waiting time before a command timeout.</td></tr><tr><td><strong>Auto refresh</strong></td><td>Set the interval for the automatic refresh.</td></tr><tr><td><strong>Prompt for offline mode on startup</strong></td><td>Ask to use the workspace in offline mode when the user connects to the workspace.</td></tr><tr><td><strong>Allow beta database upgrade</strong></td><td>Allow beta upgrade of the database (when using a beta version of Remote Desktop Manager).</td></tr><tr><td><strong>Manage cache</strong></td><td>Manage your cache on your computer to analyse, vacuum, repair or delete it. This can be very helpful if you have offline issues.</td></tr><tr><td><strong>More settings</strong></td><td>Edit the connection string values directly.</td></tr></tbody></table>
{% endtab %}

{% tab title="macOS" %}
{% hint style="danger" %}
Microsoft SQL Server is a deprecated workspace for Remote Desktop Manager macOS.
{% endhint %}

#### General

<table><thead><tr><th width="214">OPTION</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Name</strong></td><td>Display name of the workspace.</td></tr><tr><td><strong>Host</strong></td><td>Name of the server where the workspace will be stored.</td></tr><tr><td><strong>SQL Server</strong></td><td><p>Select your workspace between:</p><ul><li><strong>Microsoft SQL Server</strong></li><li><strong>Microsoft Azure SQL</strong></li><li><strong>Microsoft SQL Server on AWS</strong></li></ul></td></tr><tr><td><strong>Login mode</strong></td><td><p>Specify the authentication mode to use. Select between:</p><ul><li><strong>Database login</strong></li><li><strong>Integrated security (Active Directory)</strong></li><li><strong>Custom login</strong></li></ul></td></tr><tr><td><strong>Username</strong></td><td>Username to access the SQL server.</td></tr><tr><td><strong>Password</strong></td><td>Password to access the SQL server. Can be randomly generated with the help of the <strong>Password generator</strong>button next to the field.</td></tr><tr><td><strong>Always ask password</strong></td><td>Prompt for the password when a user connects to the workspace.</td></tr><tr><td><strong>Allow change username</strong></td><td>Allow the username to be edited when connecting to the workspace (only with <strong>Always ask password</strong> enabled).</td></tr><tr><td><strong>Database</strong></td><td>Name of the database on the SQL server for the utilization of Remote Desktop Manager macOS.</td></tr><tr><td><strong>Test server</strong></td><td>Test the connection with the server to validate if the proper information has been provided.</td></tr><tr><td><strong>Test database</strong></td><td>Test the connection with the database to validate if the proper information has been provided.</td></tr></tbody></table>

#### Settings

<table><thead><tr><th width="216">OPTION</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Ping online method</strong></td><td><p>Indicate the preferred ping online method. Select between:</p><ul><li>None</li><li>Ping</li><li>Port scan</li></ul></td></tr><tr><td><strong>Automatically go offline on offline prompt</strong></td><td>Use the workspace in offline mode when the ping method does not respond.</td></tr></tbody></table>

#### Upgrade

<table><thead><tr><th width="222">OPTION</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Test server</strong></td><td>Test the connection with the server to validate if the proper information has been provided.</td></tr><tr><td><strong>Create database</strong></td><td>Create the database on the SQL server to use Remote Desktop Manager.</td></tr><tr><td><strong>Update database</strong></td><td>Update the database on the SQL server, if required to use Remote Desktop Manager.</td></tr><tr><td><strong>Validate database</strong></td><td>Validate the content of the database.</td></tr><tr><td><strong>Test database</strong></td><td>Test the connection with the database to validate if the proper information has been provided.</td></tr><tr><td><strong>Email schema to support</strong></td><td>Send your schema to our customer support team.</td></tr></tbody></table>

#### User vault

<table><thead><tr><th width="170">OPTION</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Connection type</strong></td><td><p>Select the type of user vault to use. Select between:</p><ul><li>Default: use the default user vault, which is stored in the database.</li><li>None: disable the user vault for all users.</li></ul></td></tr></tbody></table>

#### VPN

<table><thead><tr><th width="191">OPTION</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Type</strong></td><td><p>Select between:</p><ul><li><strong>None</strong></li><li><strong>On first connect</strong></li><li><strong>Connect if unable to ping/port scan</strong></li></ul></td></tr><tr><td><strong>RDM file</strong></td><td>Open a <strong>VPN entry type</strong> from a <strong>RDM file</strong> before connecting to the workspace.</td></tr><tr><td><strong>Override credentials</strong></td><td>Override credentials such as <strong>Username, Domain</strong>, and <strong>Password</strong>.</td></tr></tbody></table>

#### Advanced

<table><thead><tr><th width="257">OPTION</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><strong>Caching mode</strong></td><td>Determines how the entries will be reloaded in the workspace. For more information, please consult <a href="/rdm/getting-started/workspaces/caching.md">Caching</a>.</td></tr><tr><td><strong>Sync all vaults (background)</strong></td><td>Synchronization ensures that any changes made to a vault, such as updating passwords or adding new sessions, are propagated across all connected devices and users in real-time.</td></tr><tr><td><strong>Trust certificate</strong></td><td>Set how the workspace handles certificates.</td></tr><tr><td><strong>Connection timeout</strong></td><td>Waiting time before a connection timeout.</td></tr><tr><td><strong>Command timeout</strong></td><td>Waiting time before a command timeout.</td></tr><tr><td><strong>Auto refresh</strong></td><td>Set the interval for the automatic refresh.</td></tr><tr><td><strong>Prompt for offline mode on startup</strong></td><td>Ask to use the workspace in offline mode when the user connects to the workspace.</td></tr><tr><td><strong>Allow beta database upgrade</strong></td><td>Allow beta upgrade of the database (when using a beta version of Remote Desktop Manager).</td></tr><tr><td><strong>Manage cache</strong></td><td>Manage your cache on your computer to analyse, vacuum, repair or delete it. This can be very helpful if you have offline issues.</td></tr><tr><td><strong>Advanced settings</strong></td><td>Edit the connection string values directly.</td></tr></tbody></table>
{% endtab %}
{% endtabs %}


---

# 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/getting-started/workspaces/workspace-types/alternative-workspaces/microsoft-sql-server.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.