COMMAND EVERYTHING.

Set-RDConnectionBrokerHighAvailability

Sets high availability settings for RD Connection Broker servers for a Remote Desktop deployment.

PowerShell · Risk: High · Documentation Verified

Last verified: 2026-10-26

Microsoft RemoteDesktop reference: Sets high availability settings for RD Connection Broker servers for a Remote Desktop deployment. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.

Set-RDConnectionBrokerHighAvailability [[-ConnectionBroker] <String>] [-DatabaseConnectionString] <String>
 [[-DatabaseSecondaryConnectionString] <String>] [[-DatabaseFilePath] <String>] [-ClientAccessName] <String>
 [<CommonParameters>]

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for Set-RDConnectionBrokerHighAvailability. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.

Supported environments

Windows / RemoteDesktop · Windows Server 2025 documentation; feature/module prerequisites apply

Parameters

-ClientAccessName (required): Specifies a Domain Name System (DNS) name for clients to use to connect to a Remote Desktop deployment. This is the DNS round-robin name that contains fully qualified domain names (FQDNs) of the RD Connection Broker servers.
-ConnectionBroker: Specifies the RD Connection Broker server for a Remote Desktop deployment. If you do not specify a value, the cmdlet uses the FQDN of the local computer.
-DatabaseConnectionString (required): Specifies a connection string for the database that stores the high availability settings.
-DatabaseFilePath: Specifies a path to the database supplied by the *DatabaseConnectionString* parameter. This parameter is optional.
-DatabaseSecondaryConnectionString: Specifies the secondary database connection string optionally used to support password expiration. This string is used when the high availability configuration uses a shared database server (that is, where the method of authentication to the database server requires a user name and password).

Prerequisites

Windows with the RemoteDesktop module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.

Security considerations

This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.

Examples

Example 1: Set high availability settings for a dedicated database server

Set-RDConnectionBrokerHighAvailability -ConnectionBroker "RDCB.Contoso.com" -DatabaseConnectionString "DRIVER=SQL Server Native Client 10.0;SERVER=sqlserver.contoso.com;Trusted_Connection=Yes;APP=Remote Desktop Services Connection Broker;Database=RemoteDesktopDeployment" -DatabaseFilePath "C:\RDFiles\RemoteDesktopDeployment.mdf" -ClientAccessName "RemoteResources.Contoso.com"

This command sets high availability settings for an RD Connection Broker server named RDCB.Contoso.com. The command specifies a database connection string, and includes the path to the database. The command specifies the client access name as RemoteResources.Contoso.com. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.

Sources

https://github.com/MicrosoftDocs/windows-powershell-docs/blob/b7645dd8c687139b28e845119da30ec670526507/docset/winserver2025-ps/RemoteDesktop/Set-RDConnectionBrokerHighAvailability.md

https://learn.microsoft.com/powershell/module/remotedesktop/set-rdconnectionbrokerhighavailability?view=windowsserver2025-ps

Personal collections

Explain or customize this command with AI

Related commands