Export (0) Print
Expand All
Expand Minimize

Get-RDSessionCollectionConfiguration

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Get-RDSessionCollectionConfiguration

Gets configuration information for a session collection.

Syntax

Parameter Set: General
Get-RDSessionCollectionConfiguration [-CollectionName] <String> [-ConnectionBroker <String> ] [ <CommonParameters>]

Parameter Set: Client
Get-RDSessionCollectionConfiguration [-CollectionName] <String> -Client [-ConnectionBroker <String> ] [ <CommonParameters>]

Parameter Set: Connection
Get-RDSessionCollectionConfiguration [-CollectionName] <String> -Connection [-ConnectionBroker <String> ] [ <CommonParameters>]

Parameter Set: LoadBalancing
Get-RDSessionCollectionConfiguration [-CollectionName] <String> -LoadBalancing [-ConnectionBroker <String> ] [ <CommonParameters>]

Parameter Set: Security
Get-RDSessionCollectionConfiguration [-CollectionName] <String> -Security [-ConnectionBroker <String> ] [ <CommonParameters>]

Parameter Set: UserGroup
Get-RDSessionCollectionConfiguration [-CollectionName] <String> -UserGroup [-ConnectionBroker <String> ] [ <CommonParameters>]

Parameter Set: UserProfileDisk
Get-RDSessionCollectionConfiguration [-CollectionName] <String> -UserProfileDisk [-ConnectionBroker <String> ] [ <CommonParameters>]




Detailed 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.

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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CollectionName<String>

Specifies the name of a session collection.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Connection

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


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ConnectionBroker<String>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Security

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


Aliases

none

Required?

true

Position?

named

Default Value

none

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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UserProfileDisk

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


Aliases

none

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, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • System.Object

Examples

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

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.


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

Example 2: Get connection settings for a session collection

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.


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

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

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.


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

Example 4: Get security settings for a session collection

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.


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

Example 5: Get load balancing settings for a session collection

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.


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

Example 6: Get client settings for a session collection

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.


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

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft