en-US/about_RDConnectionBrokerHAMode.help.txt
|
.NAME
RDConnectionBrokerHAMode .SYNOPSIS The RDConnectionBrokerHAMode DSC resource is used to configure the Remote Desktop Connection Broker HA. .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 https://github.com/dsccommunity/RemoteDesktopServicesDsc/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+RDConnectionBrokerHAMode. .PARAMETER ClientAccessName Key - System.String Specifies the Client Access Name for the RD Connection Broker HA deployment. .PARAMETER DatabaseConnectionString Required - System.String Specifies the primary database connection string for the RD Connection Broker HA deployment. .PARAMETER ConnectionBroker Write - System.String Specifies the FQDN of a server to host the RD Connection Broker role service. .PARAMETER DatabaseSecondaryConnectionString Write - System.String Specifies the secondary database connection string for the RD Connection Broker HA deployment. .PARAMETER DatabaseFilePath Write - System.String Specifies the file path for the RD Connection Broker HA database. .PARAMETER ActiveManagementServer Read - System.String Returns the FQDN of the server that is currently active for management tasks. .PARAMETER Reasons Read - RDSReason[] Returns the reason a property is not in desired state. .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' } } } |