RDConnectionBrokerHAMode

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
ClientAccessName	Key	System.String	Specifies the Client Access Name for the RD Connection Broker HA deployment.
DatabaseConnectionString	Required	System.String	Specifies the primary database connection string for the RD Connection Broker HA deployment.
ConnectionBroker	Write	System.String	Specifies the FQDN of a server to host the RD Connection Broker role service.
DatabaseFilePath	Write	System.String	Specifies the file path for the RD Connection Broker HA database.
DatabaseSecondaryConnectionString	Write	System.String	Specifies the secondary database connection string for the RD Connection Broker HA deployment.
ActiveManagementServer	Read	System.String	Returns the FQDN of the server that is currently active for management tasks.
Reasons	Read	RDSReason[]	Returns the reason a property is not in desired state.

Description

This resource is used to configure the Remote Desktop Connection Broker HA.

Requirements

• Target machine must be running Windows Server 2012 or later.

Known issues

All issues are not listed here, see all open issues.

Examples

Example 1

This example shows how to configure HA mode on a connection broker.

configuration Example
{
    Import-DscResource -ModuleName 'RemoteDesktopServicesDsc'

    node localhost {

        RDConnectionBrokerHAMode MyGateway {
            ConnectionBroker         = 'RDCB1'
            DatabaseConnectionString = 'DRIVER=SQL Server Native Client 11.0;SERVER=RDDB1;Trusted_Connection=Yes;APP=Remote Desktop Services Connection Broker;Database=RDS'
            ClientAccessName         = 'rdsfarm.contoso.com'
        }
    }
}