PowerShell Logo Small

Get-RDSessionCollectionConfiguration



This is the built-in help made by Microsoft for the command 'Get-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

Gets configuration information for a session collection.

SYNTAX


Get-RDSessionCollectionConfiguration [-CollectionName] <String> [-ConnectionBroker <String>] [<CommonParameters>]
Get-RDSessionCollectionConfiguration [-CollectionName] <String> [-ConnectionBroker <String>] -Client [<CommonParameters>]
Get-RDSessionCollectionConfiguration [-CollectionName] <String> [-ConnectionBroker <String>] -Connection [<CommonParameters>]
Get-RDSessionCollectionConfiguration [-CollectionName] <String> [-ConnectionBroker <String>] -LoadBalancing [<CommonParameters>]
Get-RDSessionCollectionConfiguration [-CollectionName] <String> [-ConnectionBroker <String>] -Security [<CommonParameters>]
Get-RDSessionCollectionConfiguration [-CollectionName] <String> [-ConnectionBroker <String>] -UserGroup [<CommonParameters>]
Get-RDSessionCollectionConfiguration [-CollectionName] <String> [-ConnectionBroker <String>] -UserProfileDisk [<CommonParameters>]



Search powershellhelp.space

DESCRIPTION


The Get-RDSessionCollectionConfiguration cmdlet gets configuration information for a specified 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 specify whether to get configuration resources for connection settings, load balancing settings, security settings, or user profile disk settings. You can also see
the domain groups and users authorized to connect to the session.



<

RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=294222
Set-RDSessionCollectionConfiguration
Get-RDSessionCollection
New-RDSessionCollection
Remove-RDSessionCollection

REMARKS

<

Examples


Example 1: Get domain groups authorized to connection to a session collection

PS C:\> Get-RDSessionCollectionConfiguration -CollectionName "Session Collection 22" -UserGroup -ConnectionBroker "RDCB.Contoso.com"



This command gets settings for the session collection named Session Collection 22 that has the RDConnection Broker server named RDCB.Contoso.com. The command includes the
UserGroup parameter, therefore the command gets the domain groups authorized to connect to the session collection.




Example 2: Get connection settings for a session collection

PS C:\> Get-RDSessionCollectionConfiguration -CollectionName "Session Collection 22" -Connection -ConnectionBroker "RDCB.Contoso.com"



This command gets settings for the session collection named Session Collection 22 that has the RDConnection Broker server named RDCB.Contoso.com. This command includes the
Connection parameter, therefore the command gets connection settings.




Example 3: Get user profile disk settings for a session collection

PS C:\> Get-RDSessionCollectionConfiguration -CollectionName "Session Collection 22" -UserProfileDisk -ConnectionBroker "RDCB.Contoso.com"



This command gets settings for the session collection named Session Collection 22 that has the RDConnection Broker server named RDCB.Contoso.com. This command includes the
UserProfileDisk parameter, therefore the command gets settings for the user profile disk.




Example 4: Get security settings for a session collection

PS C:\> Get-RDSessionCollectionConfiguration -CollectionName "Session Collection 22" -Security -ConnectionBroker "RDCB.Contoso.com"



This command gets settings for the session collection named Session Collection 22 that has the RDConnection Broker server named RDCB.Contoso.com. This command includes the
Security parameter, therefore the command gets security settings.




Example 5: Get load balancing settings for a session collection

PS C:\> Get-RDSessionCollectionConfiguration -CollectionName "Session Collection 22" -LoadBalancing -ConnectionBroker "RDCB.Contoso.com"



This command gets settings for the session collection named Session Collection 22 that has the RDConnection Broker server named RDCB.Contoso.com. This command includes the
LoadBalancing parameter, therefore the command gets load balancing settings.




Example 6: Get client settings for a session collection

PS C:\> Get-RDSessionCollectionConfiguration -CollectionName "Session Collection 22" -Client -ConnectionBroker "RDCB.Contoso.com"



This command gets settings for the session collection named Session Collection 22 that has the RDConnection Broker server named RDCB.Contoso.com. This command includes the
Client parameter, therefore the command gets client settings.