DSCResources/MSFT_xRDConnectionBrokerHAMode/en-US/about_xRDConnectionBrokerHAMode.help.txt

.NAME
    xRDConnectionBrokerHAMode
 
.DESCRIPTION
    This resource is used to configure the Remote Desktop Connection Broker HA.
 
.PARAMETER ClientAccessName
    Key - String
    Specifies the FQDN of client access name.
 
.PARAMETER DatabaseConnectionString
    Required - String
    Specifies the primary connection string to the database.
 
.PARAMETER DatabaseSecondaryConnectionString
    Write - String
    Specifies the secondary connection string to the database.
 
.PARAMETER ConnectionBroker
    Write - String
    Specifies the FQDN of a server to host the RD Connection Broker role service.
 
.PARAMETER DatabaseFilePath
    Write - String
    Specifies the database file path of SQL Server.
 
.EXAMPLE 1
 
This example shows how to configure HA mode on a connection broker.
 
configuration Example
{
    Import-DscResource -ModuleName 'xRemoteDesktopSessionHost'
 
    node localhost {
 
        xRDConnectionBrokerHAMode 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'
        }
    }
}