Export (0) Print
Expand All
Expand Minimize

Get-RDSessionCollection

Updated: August 12, 2013

Applies To: Windows Server 2012

Get-RDSessionCollection

Gets session collections in a Remote Desktop deployment.

Syntax

Parameter Set: Default
Get-RDSessionCollection [[-CollectionName] <String> ] [-ConnectionBroker <String> ] [ <CommonParameters>]




Detailed Description

The Get-RDSessionCollection cmdlet gets session collections in a Remote Desktop deployment. 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.

Parameters

-CollectionName<String>

Specifies the name of a session collection.


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

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

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

  • Microsoft.RemoteDesktopServices.Management.RDSessionCollection

Examples

Example1: Get a list of the Session Collections in the Remote Desktop Deployment

This command gets the collection named Session Collection in the deployment that has the RD Connection Broker named RDCB.Contoso.com.


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

Related topics

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