Get-RDConnectionBrokerHighAvailability

Get-RDConnectionBrokerHighAvailability

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

Syntax

Parameter Set: Default
Get-RDConnectionBrokerHighAvailability [[-ConnectionBroker] <String> ] [ <CommonParameters>]

Detailed 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.
-- DatabaseFilePath. File path for the database specified by the database connection string.

Parameters

-ConnectionBroker<String>

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.

Aliases

none

Required?

false

Position?

1

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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).

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.

  • RDCBHADetails

Examples

Example 1: Get High Availability Settings

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

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

Set-RDConnectionBrokerHighAvailability