Export (0) Print
Expand All
Expand Minimize

Set-RDConnectionBrokerHighAvailability

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Set-RDConnectionBrokerHighAvailability

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

Syntax

Parameter Set: Default
Set-RDConnectionBrokerHighAvailability [[-ConnectionBroker] <String> ] [-DatabaseConnectionString] <String> [-DatabaseFilePath] <String> [-ClientAccessName] <String> [ <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

none

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

none

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

none

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

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Null

    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"

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft