Get-RDSessionCollectionConfiguration

  • Reference
Module:
RemoteDesktop

Gets configuration information for a session collection.

Syntax

Get-RDSessionCollectionConfiguration
   [-CollectionName] <String>
   [-ConnectionBroker <String>]
   [<CommonParameters>]
Get-RDSessionCollectionConfiguration
   [-CollectionName] <String>
   [-UserGroup]
   [-ConnectionBroker <String>]
   [<CommonParameters>]
Get-RDSessionCollectionConfiguration
   [-CollectionName] <String>
   [-Connection]
   [-ConnectionBroker <String>]
   [<CommonParameters>]
Get-RDSessionCollectionConfiguration
   [-CollectionName] <String>
   [-UserProfileDisk]
   [-ConnectionBroker <String>]
   [<CommonParameters>]
Get-RDSessionCollectionConfiguration
   [-CollectionName] <String>
   [-Security]
   [-ConnectionBroker <String>]
   [<CommonParameters>]
Get-RDSessionCollectionConfiguration
   [-CollectionName] <String>
   [-LoadBalancing]
   [-ConnectionBroker <String>]
   [<CommonParameters>]
Get-RDSessionCollectionConfiguration
   [-CollectionName] <String>
   [-Client]
   [-ConnectionBroker <String>]
   [<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 (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 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.

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 RD Connection 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 RD Connection 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 RD Connection 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 RD Connection 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 RD Connection 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 RD Connection Broker server named RDCB.Contoso.com. This command includes the Client parameter, therefore the command gets client settings.

Parameters

-Client

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.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-CollectionName

Specifies the name of a session collection.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Connection

Indicates that the cmdlet displays connection settings for the session collection.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ConnectionBroker

Specifies the Remote Desktop Connection Broker (RD Connection 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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LoadBalancing

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.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Security

Indicates that the parameter gets the security protocol in use for the session collection.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-UserGroup

Indicates that the cmdlet gets the list of domain groups and users authorized to connect to the session.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-UserProfileDisk

Indicates that the cmdlet gets settings for the user profile disk for the session collection.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Object