Skip to content

RDSessionDeployment

dscbot edited this page Apr 2, 2026 · 2 revisions

Parameters

Parameter Attribute DataType Description Allowed Values
ConnectionBroker Key System.String Specifies the FQDN of a server to host the RD Connection Broker role service.
SessionHost Required System.String[] Specifies the FQDNs of the servers to host the RD Session Host role service.
WebAccessServer Write System.String[] Specifies the FQDN of a server to host the RD Web Access role service.
Reasons Read RDSReason[] Returns the reason a property is not in desired state.

Description

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

Requirements

  • Target machine must be running Windows Server 2012 or later.

Known issues

All issues are not listed here, see all open issues.

Examples

Example 1

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

configuration Example
{
    Import-DscResource -ModuleName RemoteDesktopServicesDsc

    node localhost
    {
        RDSessionDeployment RDSDeployment
        {
            SessionHost      = 'rdsessionhost.server.fqdn'
            ConnectionBroker = 'connectionbroker.server.fqdn'
            WebAccessServer  = 'webaccess.server.fqdn'
        }
    }
}

Example 2

configuration RDSessionDeployment_Full
{
    Import-DscResource -ModuleName RemoteDesktopServicesDsc

    node localhost
    {
        RDSessionDeployment TheBigDeployment
        {
            ConnectionBroker = 'RDBC1.contoso.com'
            WebAccessServer  = 'RDWA1.contoso.com'
            SessionHost      = 'RDSH1.contoso.com', 'RDSH2.contoso.com'
        }
    }
}

Clone this wiki locally