RemoteDesktopHAMode.adoc

DSC Resource 'RemoteDesktopHAMode'

RemoteDesktopHAMode configures the Remote Desktop Connection Broker for high availability mode with a SQL Server backend.

When to use 'RemoteDesktopHAMode'

Use this resource when you need to configure RDS Connection Broker high availability for fault-tolerant session brokering. HA mode requires a shared SQL Server database and allows multiple Connection Brokers to share the load. This is necessary for production RDS deployments that require resilience.

Source	https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/RemoteDesktopHAMode
DSC Resource	xRemoteDesktopSessionHost
Documentation	xRDConnectionBrokerHAMode

Table 1. Attributes of category 'RemoteDesktopHAMode'

Parameter	Attribute	DataType	Description	Allowed Values
ConnectionBroker	Mandatory	string	Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for a Remote Desktop deployment.
ClientAccessName	Mandatory	string	Specifies the FQDN of client access name.
DatabaseConnectionString	Mandatory	string	Specifies the primary connection string to the database.
DatabaseSecondaryConnectionString		string	Specifies the secondary connection string to the database.
DatabaseFilePath		string	Specifies the database file path of SQL Server.
Config		hashtable

Example

RemoteDesktopHAMode:
  ConnectionBroker: RDCB01
  ClientAccessName: CONTOSOFARM
  DatabaseConnectionString: "DRIVER=ODBC Driver 17 for SQL Server;Server=DB01;Trusted_Connection=Yes;APP=Remote Desktop Services Connection Broker;DATABASE=RDS"

See also

• RemoteDesktopDeployment

• RemoteDesktopCollections

• RemoteDesktopServers