Get-RDSessionCollection

  • Reference
Module:
RemoteDesktop

Gets session collections in a Remote Desktop deployment.

Syntax

Get-RDSessionCollection
   [[-CollectionName] <String>]
   [-ConnectionBroker <String>]
   [<CommonParameters>]

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. The user needs to be a member of the local computer Administrator group to run this command.

Examples

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

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

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

Parameters

-CollectionName

Specifies the name of a session collection.

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:True
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

Outputs

Microsoft.RemoteDesktopServices.Management.RDSessionCollection