Skip to content

xRDSessionDeployment

dscbot edited this page Oct 15, 2025 · 1 revision

Parameters

Parameter Attribute DataType Description Allowed Values
ConnectionBroker Key String Specifies the FQDN of a server to host the RD Connection Broker role service.
SessionHost Required StringArray[] Specifies the FQDNs of the servers to host the RD Session Host role service.
WebAccessServer Required StringArray[] Specifies the FQDN of a server to host the RD Web Access role service.

Description

This resource is used to configure the Remote Desktop Session Deployment.

Examples

Example 1

This example shows how to ensure a session deployment is created.

configuration Example
{
    Import-DscResource -ModuleName 'xRemoteDesktopSessionHost'

    node localhost {

        xRDSessionDeployment RDSDeployment {
            SessionHost      = 'rdsessionhost.server.fqdn'
            ConnectionBroker = 'connectionbroker.server.fqdn'
            WebAccessServer  = 'webaccess.server.fqdn'
        }
    }
}

Example 2

configuration xRDSessionDeployment_Full
{
    import-dscresource -modulename xRemoteDesktopSessionHost

    node localhost
    {
        xRDSessionDeployment TheBigDeployment
        {
            ConnectionBroker = 'RDBC1.contoso.com'
            WebAccessServer  = 'RDWA1.contoso.com'
            SessionHost      = 'RDSH1.contoso.com', 'RDSH2.contoso.com'
        }
    }
}
Clone this wiki locally