Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-RDConnectionBrokerHighAvailability

Set-RDConnectionBrokerHighAvailability

remotedesktop.psm1

Synopsis

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

Syntax

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

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

Parameters

-ClientAccessName <String>

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.

Aliases

None

Required?

true

Position

4

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-ConnectionBroker <String>

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.

Aliases

None

Required?

false

Position

1

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-DatabaseConnectionString <String>

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

Aliases

None

Required?

true

Position

2

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-DatabaseFilePath <String>

Specifies a path to the database supplied by the DatabaseConnectionString parameter.

Aliases

None

Required?

true

Position

3

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

Null

Notes

None

Examples

Example 1: Set high availability settings

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.

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"

Online Version
Get-RDConnectionBrokerHighAvailability