en-US/about_RDSessionDeployment.help.txt

.NAME
    RDSessionDeployment
 
.SYNOPSIS
    The RDSessionDeployment DSC resource is used to configure the Remote Desktop Session Deployment.
 
.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 https://github.com/dsccommunity/RemoteDesktopServicesDsc/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+RDSessionDeployment.
 
.PARAMETER ConnectionBroker
    Key - System.String
    Specifies the FQDN of a server to host the RD Connection Broker role service.
 
.PARAMETER SessionHost
    Required - System.String[]
    Specifies the FQDNs of the servers to host the RD Session Host role service.
 
.PARAMETER WebAccessServer
    Write - System.String[]
    Specifies the FQDN of a server to host the RD Web Access role service.
 
.PARAMETER Reasons
    Read - RDSReason[]
    Returns the reason a property is not in desired state.
 
.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'
        }
    }
}