Set-RDConnectionBrokerHighAvailability
Sets high availability settings for RD Connection Broker servers for a Remote Desktop deployment.
Syntax
Default (Default)
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 4 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DatabaseConnectionString
Specifies a connection string for the database that stores the high availability settings.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DatabaseFilePath
Specifies a path to the database supplied by the DatabaseConnectionString parameter. This parameter is optional.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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).
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Outputs
undefined