Set-RDSessionCollectionConfiguration PowerShell Get-Help Output

This is the built-in help made by Microsoft for the command 'Set-RDSessionCollectionConfiguration', in PowerShell version 5 - as retrieved from Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

SYNOPSIS

SYNTAX

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

Search powershellhelp.space

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 (RDSession Host) servers. Users can connect to RDSession 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.

RELATED LINKS

REMARKS

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 RDConnection 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 RDConnection 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 RDConnection 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 RDSession 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 RDConnection Broker server named
RDCB.Contoso.com. The command uses the array stored in the $LoadBalanceObjectsArray variable to specify load balancing behavior.