Set-RDConnectionBrokerHighAvailability

Module:

RemoteDesktop

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

Syntax

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

Description

The Set-RDConnectionBrokerHighAvailability cmdlet sets high availability settings for Remote Desktop Connection Broker (RD Connection Broker) servers for a Remote Desktop deployment. You can use the Get-RDConnectionBrokerHighAvailability cmdlet to see current settings.

Examples

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

PS C:\> 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.

Example 2: Set high availability settings for a shared database server

PS C:\>Set-RDConnectionBrokerHighAvailability -ConnectionBroker "RDCB.Contoso.com" -DatabaseConnectionString "Driver={SQL Server Native Client 11.0};Server= sqlserver.contoso.com;Database= RemoteDesktopDeployment;Uid=admin1@wxm56whnww;Pwd=Password!;Encrypt=yes;Connection Timeout=30;" -DatabaseSecondaryConnectionString "Driver={SQL Server Native Client 11.0};Server= sqlserver.contoso.com;Database= RemoteDesktopDeployment;Uid=admin;Pwd=OtherPassword!;Encrypt=yes;Connection Timeout=30;"'-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 a secondary connection string. The command specifies the client access name as RemoteResources.Contoso.com.

Parameters

-ClientAccessName

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.

Type:	String
Position:	4
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-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.

Type:	String
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DatabaseConnectionString

Specifies a connection string for the database that stores the high availability settings.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DatabaseFilePath

Specifies a path to the database supplied by the DatabaseConnectionString parameter. This parameter is optional.

Type:	String
Position:	3
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

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

Type:	String
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Outputs

Null

Related Links

• Get-RDConnectionBrokerHighAvailability