XOAPRemoteDesktopServicesDSC

This repository contains a PowerShell DSC module for the deployment of a complete Remote Desktop Services environment.

Code of Conduct

This project has adopted this Code of Conduct.

Contributing

Please check out common DSC Community contributing guidelines.

Change log

A full list of changes in each version can be found in the Releases.

Prerequisites

Be sure that the following DSC modules are installed on your system:

• xRemoteDesktopSessionHost (2.1.0)

Documentation

The XOAP Remote Desktop Services DSC module contains the following resources:

XOAP_AddServerToCollection

XOAP_AddServerToCollection [String] #ResourceName
    {
        [DependsOn = [String[]]]
        [PsDscRunAsCredential = [PSCredential]]
        [ConnectionBrokerName = [String]]
        [CollectioNname = [String]]
        [ServerName = [String]]
    }

XOAP_AddServerToDeployment

XOAP_AddServerToDeployment [String] #ResourceName
    {
        [DependsOn = [String[]]]
        [PsDscRunAsCredential = [PSCredential]]
        [ConnectionBrokerName = [String]]
        [ServerName = [String]]
        [ServerRole = [String]] #'RDS-Virtualization','RDS-RD-Server','RDS-Connection-Broker','RDS-Web-Access','RDS-Gateway','RDS-Licensing'
    }

XOAP_ConfigureCertificateConfiguration

XOAP_ConfigureCertificateConfiguration [String] #ResourceName
    {
        [DependsOn = [String[]]]
        [PsDscRunAsCredential = [PSCredential]]
        [ConnectionBrokerName = [String]]
        [ImportPath = [String]]
        [Role = [String]] #'RDRedirector', 'RDPublishing', 'RDWebAccess', 'RDGateway'
    }

XOAP_ConfigureLicenseServer

XOAP_ConfigureLicenseServer [String] #ResourceName
    {
        [DependsOn = [String[]]]
        [PsDscRunAsCredential = [PSCredential]]
        [ConnectionBrokerName = [String]]
        [LicenseServer = [String]]
        [LicenseMode = [String]] #'PerUser', 'PerDevice','NotConfigured
    }

XOAP_ConfigureSessionHostCollection

XOAP_ConfigureSessionHostCollection [String] #ResourceName
    {
        [DependsOn = [String[]]]
        [PsDscRunAsCredential = [PSCredential]]
        [ColletionName = [String]]
        [AuthenticateUsingNLA = [boolean]]
        [ActiveSessionLimit = [Int32]]
        [AutomaticReconnectionEnabled = [boolean]]
        [BrokenConnectionAction = [String]] #'None', 'Disconnect', 'LogOff'
        [ClientDeviceRedirectionOptions = [String]] #'None','AudioVideoPlayBack', 'AudioRecording', 'COMPort', 'PlugAndPlayDevice', 'SmartCard', 'Clipboard', 'LPTPort', 'Drive', 'TimeZone'
        [ClientPrinterAsDefault = [boolean]]
        [ClientPrinterRedirected = [boolean]]
        [CollectionDescription = [String]]
        [ConnectionBroker = [String]]
        [DisconnectedSessionLimit = [Int32]]
        [EncryptionLevel = [String]] #'None', 'Low', 'ClientCompatible', 'High', 'FipsCompliant'
        [IdleSessionLimit = [Int32]]
        [MaxRedirectedMonitors = [Int32]] #from 1 to 16
        [RDEasyPrintDriverEnabled = [boolean]]
        [SecurityLayer = [String]] #'RDP', 'Negotiate', 'SSL'
        [TemporaryFoldersDeletedOnExit = [boolean]]
        [UserGroup = [String]]
        [DiskPath = [String]]
        [EnableUserProfileDisk = [boolean]]
        [ExcludeFilePath = [String]]
        [ExcludeFolderPath = [String]]
        [IncludeFilePath = [String]]
        [IncludeFolderPath = [String]]
        [MaxUserProfileDiskSizeGB = [Int32]]
    }

XOAP_NewRDSDeployment

XOAP_NewRDSDeployment [String] #ResourceName
    {
        [DependsOn = [String[]]]
        [PsDscRunAsCredential = [PSCredential]]
        [XOAP_NewRDSDeployment = [String]]
        [SessionHostName = [String]]
        [WebAccessServerName = [String]]
    }

XOAP_NewRemoteApp

XOAP_NewRemoteApp [String] #ResourceName
    {
        [DependsOn = [String[]]]
        [PsDscRunAsCredential = [PSCredential]]
        [Alias = [String]]
        [CollectionName = [String]]
        [Ensure = [String]] #'Present','Absent'
        [DisplayName = [String]]
        [FilePath = [String]]
        [FileVirtualPath = [String]]
        [FolderName = [String]]
        [CommandLineSetting = [String]] #'Allow','DoNotAllow','Require'
        [RequiredCommandLine = [String]]
        [IconIndex = [String]]
        [IconPath = [String]]
        [UserGroups = [String]]
        [ShowInWebAccess = [boolean]]
    }

XOAP_NewSessionHostCollection

XOAP_NewSessionHostCollection [String] #ResourceName
    {
        [DependsOn = [String[]]]
        [PsDscRunAsCredential = [PSCredential]]
        [CollectionName = [String]]
        [SessionHosts = [String]]
        [CollectionDescription = [String]]
        [ConnectionBrokerName = [String]]
    }

XOAP_QuickConfiguration

XOAP_QuickConfiguration [String] #ResourceName
    {
        [DependsOn = [String[]]]
        [PsDscRunAsCredential = [PSCredential]]
        [ConnectionBrokerServerName = [String]]
        [SessionHostServerName = [String]]
        [AllowedUserGroup = [String]]
    }

Configuration examples for each resource

To implement the Remote Desktop Services DSC module, add the following resources to your DSC configuration and adjust the parameters accordingly:

Add server to a collection

Configuration 'XOAP_AddServerToCollection'
{
    Import-DscResource -ModuleName 'XOAPRemoteDesktopServicesDSC' -Name 'XOAP_AddServerToCollection' -ModuleVersion '0.0.1'
    
    XOAP_AddServerToCollection 'Example'
    {
	    ConnectionBrokerName [String]= 'connectionbroker.domain.com'
	    CollectionName [String]= 'Example'
	    ServerName [String]= 'hostname.domain.com'
    }
}
XOAP_AddServerToCollection

Add a server to the RDS deployment

Configuration 'XOAP_AddServerToDeployment'
{
    Import-DscResource -ModuleName 'XOAPRemoteDesktopServicesDSC' -Name 'XOAP_AddServerToDeployment' -ModuleVersion '0.0.1'
    
    XOAP_AddServerToDeployment 'Example'
    {
	    ConnectionBrokerName [String]= 'connectionbroker.domain.com'
	    Servername [String]= 'hostname.domain.com'
	    ServerRole [String]= 'RDS-Virtualization'
    }
}
XOAP_AddServerToDeployment

Certificate configuration

Configuration 'XOAP_ConfigureCertificateConfiguration'
{
    Import-DscResource -ModuleName 'XOAPRemoteDesktopServicesDSC' -Name 'XOAP_ConfigureCertificateConfiguration' -ModuleVersion '0.0.1'

    XOAP_ConfigureCertificateConfiguration 'Example'
    {
	    ConnectionBrokerName [String]= 'connectionbroker.domain.com'
	    ImportPath [String]= 'hostname.domain.com'
	    Role [String]= 'RDWebAccess'
    }
}
XOAP_ConfigureCertificateConfiguration

Configure license server

Configuration 'XOAP_ConfigureLicenseServer'
{
    Import-DscResource -ModuleName 'XOAPRemoteDesktopServicesDSC' -Name 'XOAP_ConfigureLicenseServer' -ModuleVersion '0.0.1'

    XOAP_ConfigureLicenseServer 'Example'
    {
        ConnectionBrokerName [String]= 'connectionbroker.domain.com'
        LicenseServer [String]= 'licenseserver.domain.com'
        LicenseMode [String]= 'PerUser'
    }
}
XOAP_ConfigureLicenseServer

Configure Session Host Collection

Configuration 'XOAP_ConfigureSessionHostCollection'
{
    Import-DscResource -ModuleName 'XOAPRemoteDesktopServicesDSC' -Name 'XOAP_ConfigureSessionHostCollection' -ModuleVersion '0.0.1'
    
    XOAP_ConfigureSessionHostCollection 'Example'
    {
        CollectionName = 'Example'
        AuthenticateUsingNLA = $true
        ActiveSessionLimit = 0
        AutomaticReconnectionEnabled = $true
        BrokenConnectionAction = 'None'
        ClientDeviceRedirectionOptions = 'None'
        ClientPrinterAsDefault = $true
        ClientPrinterRedirected = $true
        CollectionDescription = 'Example'
        ConnectionBroker = 'connectionbroker.domain.com'
        DisconnectedSessionLimit = 0
        EncryptionLevel = 'High'
        IdleSessionLimit = 0
        MaxRedirectedMonitors = 1
        RDEasyPrintDriverEnabled = $true
        SecurityLayer = 'SSL'
        TemporaryFoldersDeletedOnExit = $true
        UserGroup = 'domain\group'
        DiskPath = 'C:\'
        EnableUserProfileDisk = $true
        ExcludeFilePath = 'C:\'
        ExcludeFolderPath = 'C:\'
        IncludeFilePath = 'C:\'
        IncludeFolderPath = 'C:\'
        MaxUserProfileDiskSizeGB = 10
    }
}
XOAP_ConfigureSessionHostCollection

New RDS deployment

Configuration 'XOAP_NewRDSDeployment'
{
    Import-DscResource -ModuleName 'XOAPRemoteDesktopServicesDSC' -Name 'XOAP_NewRDSDeployment' -ModuleVersion '0.0.1'
    
    XOAP_NewRDSDeployment 'Example'
    {
        XOAP_NewRDSDeployment = 'Example'
        SessionHostName = 'hostname.domain.com'
        WebAccessServerName = 'webaccess.domain.com'
    }
}
XOAP_NewRDSDeployment

New Remote App

Configuration 'XOAP_NewRemoteApp'
{
    Import-DscResource -ModuleName 'XOAPRemoteDesktopServicesDSC' -Name 'XOAP_NewRemoteApp' -ModuleVersion '0.0.1'
    
    XOAP_NewRemoteApp 'Example'
    {
        Alias = 'Example'
        CollectionName = 'Example'
        Ensure = 'Present'
        DisplayName = 'Example'
        FilePath = 'C:\'
        FileVirtualPath = 'C:\'
        FolderName = 'Example'
        CommandLineSetting = 'Allow'
        RequiredCommandLine = 'C:\'
        IconIndex = '0'
        IconPath = 'C:\'
        UserGroups = 'domain\group'
        ShowInWebAccess = $true
    }
}
XOAP_NewRemoteApp

New Session Host Collection

Configuration 'XOAP_NewSessionHostCollection'
{
    Import-DscResource -ModuleName 'XOAPRemoteDesktopServicesDSC' -Name 'XOAP_NewSessionHostCollection' -ModuleVersion '0.0.1'
    
    XOAP_NewSessionHostCollection 'Example'
    {
        CollectionName = 'Example'
        SessionHosts = 'hostname.domain.com'
        CollectionDescription = 'Example'
        ConnectionBrokerName = 'connectionbroker.domain.com'
    }
}
XOAP_NewSessionHostCollection

Quick configuration

Configuration 'XOAP_QuickConfiguration'
{
Import-DSCResource -Module 'XOAPRemoteDesktopServicesDSC' -Name 'XOAP_QuickStartConfiguration' -ModuleVersion '0.0.1'
    
    XOAP_QuickStartConfiguration 'Example'
    {
        ConnectionBrokerServerName = 'connectionbroker.domain.com'
        SessionHostServerName = 'hostname.domain.com'
        AllowedUserGroup = 'domain\group'
    }
}
XOAP_QuickStartConfiguration

Example DSC configuration

Configuration 'XOAPRemoteDesktopServicesDSC'
{
	Import-DSCResource -Module 'XOAPRemoteDesktopServicesDSC' -Name 'XOAP_QuickStartConfiguration' -ModuleVersion '0.0.1'

    param
    (
        [string[]]$ConnectionBrokerServerName = 'connectionbroker.domain.com'
        [string[]]$SessionHostServerName = 'sessionhost.domain.com'
        [string[]]$AllowedUserGroup = 'domain\group'
    )
    
	Node 'XOAPRemoteDesktopServicesDSC'
	{
        XOAP_QuickConfiguration 'Example'
            {
                ConnectionBrokerServerName = 'connectionbroker.domain.com'
                SessionHostServerName = 'hostname.domain.com'
                AllowedUserGroup = 'domain\group'
            }
    } 
}
XOAPRemoteDesktopServicesDSC -OutputPath 'C:\XOAPRemoteDesktopServicesDSC'