< Back
Get-RDSessionCollectionConfiguration
Post
NAME Get-RDSessionCollectionConfiguration
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>]
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.
PARAMETERS
-Client <SwitchParameter>
Indicates that the cmdlet gets client settings for the session collection, such as those specified by the values of the
ClientDeviceRedirectionOptions, ClientPrinterAsDefault, and ClientPrinterRedirected parameters in the Set-RDSessionCollectionConfiguration
cmdlet.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-CollectionName <String>
Specifies the name of a session collection.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Connection <SwitchParameter>
Indicates that the cmdlet displays connection settings for the session collection.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ConnectionBroker [<String>]
Specifies the Remote Desktop Connection Broker (RDConnection Broker) server for a Remote Desktop deployment. If you do not specify a value,
the cmdlet uses the fully qualified domain name (FQDN) of the local computer.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-LoadBalancing <SwitchParameter>
Indicates that the cmdlet gets load balancing settings for the session collection, such as those set by the LoadBalancing parameter in the
Set-RDSessionCollectionConfiguration cmdlet.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Security <SwitchParameter>
Indicates that the parameter gets the security protocol in use for the session collection.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-UserGroup <SwitchParameter>
Indicates that the cmdlet gets the list of domain groups and users authorized to connect to the session.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-UserProfileDisk <SwitchParameter>
Indicates that the cmdlet gets settings for the user profile disk for the session collection.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Object
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294222
Set-RDSessionCollectionConfiguration
Get-RDSessionCollection
New-RDSessionCollection
Remove-RDSessionCollection
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>]
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.
PARAMETERS
-Client <SwitchParameter>
Indicates that the cmdlet gets client settings for the session collection, such as those specified by the values of the
ClientDeviceRedirectionOptions, ClientPrinterAsDefault, and ClientPrinterRedirected parameters in the Set-RDSessionCollectionConfiguration
cmdlet.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-CollectionName <String>
Specifies the name of a session collection.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Connection <SwitchParameter>
Indicates that the cmdlet displays connection settings for the session collection.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ConnectionBroker [<String>]
Specifies the Remote Desktop Connection Broker (RDConnection Broker) server for a Remote Desktop deployment. If you do not specify a value,
the cmdlet uses the fully qualified domain name (FQDN) of the local computer.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-LoadBalancing <SwitchParameter>
Indicates that the cmdlet gets load balancing settings for the session collection, such as those set by the LoadBalancing parameter in the
Set-RDSessionCollectionConfiguration cmdlet.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Security <SwitchParameter>
Indicates that the parameter gets the security protocol in use for the session collection.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-UserGroup <SwitchParameter>
Indicates that the cmdlet gets the list of domain groups and users authorized to connect to the session.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-UserProfileDisk <SwitchParameter>
Indicates that the cmdlet gets settings for the user profile disk for the session collection.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Object
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294222
Set-RDSessionCollectionConfiguration
Get-RDSessionCollection
New-RDSessionCollection
Remove-RDSessionCollection