Edit

Share via

Get-RDConnectionBrokerHighAvailability

Module:
RemoteDesktop Module

Gets high availability settings for the RD Connection Broker server in a Remote Desktop deployment.

Syntax

Default (Default) 

Get-RDConnectionBrokerHighAvailability
    [[-ConnectionBroker] <String>]
    [<CommonParameters>]

Description

The Get-RDConnectionBrokerHighAvailability cmdlet gets high availability settings for the Remote Desktop Connection Broker (RD Connection Broker) server in a Remote Desktop deployment. The cmdlet displays the following settings:

  • ActiveManagementServer. Current active management server in the highly available RD Connection Broker server list.
  • ConnectionBroker. List of RD Connection Broker servers.
  • ClientAccessName. Client access name for the group of RD Connection Broker servers.
  • DatabaseConnectionString. Database connection string of the central database that stores the configuration.
  • DatabaseSecondaryConnectionString. Database secondary connection string of the central database that stores the configuration. This setting is displayed if the high availability configuration is on a shared database server.
  • DatabaseFilePath. File path for the database specified by the database connection string.

Examples

Example 1: Get High Availability Settings

PS C:\> Get-RDConnectionBrokerHighAvailability -ConnectionBroker "RDCB.Contoso.com"

This command gets the high availability settings for the RD Connection Broker server named RDCB.Contoso.com.

Parameters

-ConnectionBroker

Specifies the RD Connection Broker server for a Remote Desktop deployment. If you do not specify a value, the cmdlet uses the fully qualified domain name (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

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

RDCBHADetails