Skip to content

xRDServer

dscbot edited this page Oct 15, 2025 · 1 revision

Parameters

Parameter Attribute DataType Description Allowed Values
Role Key String RDS-Connection-Broker, RDS-Virtualization, RDS-RD-Server, RDS-Web-Access, RDS-Gateway, RDS-Licensing
Server Key String
ConnectionBroker Write String
GatewayExternalFqdn Write String

Description

This resource is used to configure the Remote Desktop Server.

Examples

Example 1

This example shows how to join a RDSH host to a deployment.

configuration Example
{
    Import-DscResource -ModuleName 'xRemoteDesktopSessionHost'

    node localhost {

        xRDServer RemoteDesktopSessionHost {
            ConnectionBroker = 'connectionbroker.server.fqdn'
            Server           = 'sessionhost.server.fqdn'
            Role             = 'RDS-RD-Server'
        }
    }
}
Clone this wiki locally