Set-RDSessionCollectionConfiguration

Syntax

Set-RDSessionCollectionConfiguration
   [-CollectionName] <String>
   [-CollectionDescription <String>]
   [-UserGroup <String[]>]
   [-ClientDeviceRedirectionOptions <RDClientDeviceRedirectionOptions>]
   [-MaxRedirectedMonitors <Int32>]
   [-ClientPrinterRedirected <Boolean>]
   [-RDEasyPrintDriverEnabled <Boolean>]
   [-ClientPrinterAsDefault <Boolean>]
   [-TemporaryFoldersPerSession <Boolean>]
   [-BrokenConnectionAction <RDBrokenConnectionAction>]
   [-TemporaryFoldersDeletedOnExit <Boolean>]
   [-AutomaticReconnectionEnabled <Boolean>]
   [-ActiveSessionLimitMin <Int32>]
   [-DisconnectedSessionLimitMin <Int32>]
   [-IdleSessionLimitMin <Int32>]
   [-AuthenticateUsingNLA <Boolean>]
   [-EncryptionLevel <RDEncryptionLevel>]
   [-SecurityLayer <RDSecurityLayer>]
   [-LoadBalancing <RDSessionHostCollectionLoadBalancingInstance[]>]
   [-CustomRdpProperty <String>]
   [-ConnectionBroker <String>]
   [<CommonParameters>]

Set-RDSessionCollectionConfiguration
   [-CollectionName] <String>
   [-DisableUserProfileDisk]
   [-ConnectionBroker <String>]
   [<CommonParameters>]

Set-RDSessionCollectionConfiguration
   [-CollectionName] <String>
   [-EnableUserProfileDisk]
   [-IncludeFolderPath <String[]>]
   [-ExcludeFolderPath <String[]>]
   [-IncludeFilePath <String[]>]
   [-ExcludeFilePath <String[]>]
   -MaxUserProfileDiskSizeGB <Int32>
   -DiskPath <String>
   [-ConnectionBroker <String>]
   [<CommonParameters>]

Description

The Set-RDSessionCollectionConfiguration cmdlet modifies configuration options for an existing session collection. A session collection consists of one or more Remote Desktop Session Host (RD Session Host) servers. Users can connect to RD Session Host servers in a session collection to run programs, save files, and use resources on those servers.

You can use the New-RDSessionCollection cmdlet to create a session collection.

Examples

Example 1: Disable user profile disk

PS C:\> Set-RDSessionCollectionConfiguration -CollectionName "Session Collection 02" -DisableUserProfileDisk -ConnectionBroker "RDCB.Contoso.com"

This command configures a session collection to not use a user profile disk for a session collection named Session Collection 02 that has an RD Connection Broker named RDCB.Contoso.com.

Example 2: Specify a user profile disk with included file and folder

PS C:\> Set-RDSessionCollectionConfiguration -CollectionName "Session Collection 09" -EnableUserProfileDisk -MaxUserProfileDiskSizeGB 40 -DiskPath "C:\UserVHDs" -IncludeFolderPath "C:\Resources Folder" -IncludeFileFolderPath "C:\Required Text File.txt" -ConnectionBroker "RDCB.Contoso.com"

This command configures a session collection to use a user profile disk for a session collection named Session Collection 09 that has an RD Connection Broker named RDCB.Contoso.com. The command specifies the maximum size of the user profile disk and its disk path. The command specifies a path and file to include in the user profile.

Example 3: Specify a user profile disk with excluded file and folder

PS C:\> Set-RDSessionCollectionConfiguration -CollectionName "Session Collection 19" -EnableUserProfileDisk -MaxUserProfileDiskSizeGB 40 -DiskPath "C:\UserVHDs" -ExcludeFolderPath "C:\Local Resources Folder" -ExcludeFilePath "C:\Local Text File.txt" -ConnectionBroker "RDCD.Contoso.com"

This command configures a session collection to use a user profile disk for a session collection named Session Collection 19 that has an RD Connection Broker named RDCB.Contoso.com. The command specifies the maximum size of the user profile disk and its disk path. The command specifies a path and file to exclude from the user profile.

Example 4: Configure load balancing

PS C:\> $LoadBalanceObjectsArray = New-Object System.Collections.Generic.List[Microsoft.RemoteDesktopServices.Management.RDSessionHostCollectionLoadBalancingInstance]
PS C:\>$LoadBalanceSessionHost1 = New-Object Microsoft.RemoteDesktopServices.Management.RDSessionHostCollectionLoadBalancingInstance( "SessionHostCollection", 50, 200, "RDSH-1.Contoso.com" )
PS C:\> $LoadBalanceObjectsArray.Add($LoadBalanceSessionHost1)
PS C:\> $LoadBalanceSessionHost2 = New-Object Microsoft.RemoteDesktopServices.Management.RDSessionHostCollectionLoadBalancingInstance( "SessionHostCollection", 50, 300, "RDSH-2Contoso.com" )
PS C:\> $LoadBalanceObjectsArray.Add($LoadBalanceSessionHost2)
PS C:\> Set-RDSessionCollectionConfiguration -CollectionName "Session Collection 07" -LoadBalancing $LoadBalanceObjectsArray -ConnectionBroker "RDCB.Contoso.com"

This example configures load balancing for a session collection named Session Collection 07 that has an RD Connection Broker server named RDCB.Contoso.com.

The first five commands use standard Windows PowerShell® syntax to create an array of objects to define load balancing guidelines, and store those guidelines in the $LoadBalanceObjectsArray variable. This example configuration uses two RD Session Host servers named RDSH-1.Contoso.com and RDSH-2.Contoso.com

The final command specifies load balancing settings for the session collection that has the name Session Collection 07 and the RD Connection Broker server named RDCB.Contoso.com. The command uses the array stored in the $LoadBalanceObjectsArray variable to specify load balancing behavior.

Parameters

-ActiveSessionLimitMin

-AuthenticateUsingNLA

-AutomaticReconnectionEnabled

-BrokenConnectionAction

-ClientDeviceRedirectionOptions

-ClientPrinterAsDefault

-ClientPrinterRedirected

-CollectionDescription

-CollectionName

-ConnectionBroker

-CustomRdpProperty

-DisableUserProfileDisk

-DisconnectedSessionLimitMin

-DiskPath

-EnableUserProfileDisk

-EncryptionLevel

-ExcludeFilePath

-ExcludeFolderPath

-IdleSessionLimitMin

-IncludeFilePath

-IncludeFolderPath

-LoadBalancing

-MaxRedirectedMonitors

-MaxUserProfileDiskSizeGB

-RDEasyPrintDriverEnabled

-SecurityLayer

-TemporaryFoldersDeletedOnExit

-TemporaryFoldersPerSession

-UserGroup

Outputs

Null

Notes

• The IncludeFolderPath and IncludeFilePath parameters are mutually exclusive with the ExcludeFolderPath and ExcludeFilePath parameters.

Related Links

• Get-RDSessionCollectionConfiguration
• Get-RDSessionCollection
• New-RDSessionCollection
• Remove-RDSessionCollection