RemoteDesktopCollections.adoc

DSC Resource 'RemoteDesktopCollections'

RemoteDesktopCollections creates and configures Remote Desktop Session Collections with user experience and security settings.

When to use 'RemoteDesktopCollections'

Use this resource when you need to create RDS session collections that group session hosts and define connection settings. Session collections control which servers host user sessions and the user experience settings (e.g., client device redirection, timeouts, and security). Apply this after RemoteDesktopDeployment.

Source	https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/RemoteDesktopCollections
DSC Resource	xRemoteDesktopSessionHost
Documentation	xRDSessionCollection xRDSessionCollectionConfiguration

Table 1. Attributes of category 'RemoteDesktopCollections'

Parameter	Attribute	DataType	Description	Allowed Values
Collections	Mandatory	Hashtable[]	set of remote desktop collections

Table 2. Attributes of category 'RemoteDesktopCollections/Collections'

Parameter	Attribute	DataType	Description	Allowed Values
CollectionName	Key	String	Specifies the name of the RD session collection.
SessionHost	Mandatory	String[]	Specifies the RD Session Host servers for this collection.
CollectionDescription		String	Specifies the description of the RD session collection.
ConnectionBroker		String	Specifies the RD Connection Broker server for this collection.
Settings		Hashtable	Optional collection configuration settings (splatted to xRDSessionCollectionConfiguration). Supported keys: ActiveSessionLimitMin, AuthenticateUsingNLA, AutomaticReconnectionEnabled, BrokenConnectionAction, ClientDeviceRedirectionOptions, ClientPrinterAsDefault, ClientPrinterRedirected, CollectionDescription, CustomRdpProperty, DisconnectedSessionLimitMin, EncryptionLevel, IdleSessionLimitMin, MaxRedirectedMonitors, RDEasyPrintDriverEnabled, SecurityLayer, TemporaryFoldersDeletedOnExit, UserGroup, DiskPath, EnableUserProfileDisk, MaxUserProfileDiskSizeGB, IncludeFolderPath, ExcludeFolderPath, IncludeFilePath, ExcludeFilePath.

Example

RemoteDesktopCollections:
  Collections:
    - CollectionName: My first Collection
      SessionHost:
        - SH1
        - SH2
      CollectionDescription: This is my super awesome collection
      ConnectionBroker: CB1
    - CollectionName: My second Collection
      SessionHost:
        - SH1
        - SH2
      CollectionDescription: This is my super awesome collection number 2
      ConnectionBroker: CB1
      Settings:
        ActiveSessionLimitMin : 10
        AuthenticateUsingNLA: true
        AutomaticReconnectionEnabled: true

See also

• RemoteDesktopDeployment

• RemoteDesktopLicensing

• RemoteDesktopCertificates

• RemoteDesktopServers