Get-RDSessionCollection
Gets session collections in a Remote Desktop deployment.
Syntax
Default (Default)
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.