Get-RDSessionCollection
Updated: September 14, 2012
Applies To: Windows Server 2012
Get-RDSessionCollection
Syntax
Parameter Set: __AllParameterSets Get-RDSessionCollection [[-CollectionName] <String> ] [-ConnectionBroker <String> ] [ <CommonParameters>]
Detailed Description
The Get-RDSessionCollection cmdlet gets a list of all session collections, and their associated details, in the remote desktop deployment.
Parameters
-CollectionName<String>
Specifies the name of the 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 this remote desktop deployment. If not supplied, defaults to the fully qualified domain name (FQDN) of the local host.
|
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.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.RemoteDesktopServices.Management.RDSessionCollection
Examples
Example1: Retrieve a list of the Session Collections in the Remote Desktop Deployment
This command lists details of the session collection named Session Collection, as specified by the CollectionName parameter. The session collections are associated with a specific RD Connection Broker, as specified by the rdcb.contoso.com value, by using the ConnectionBroker parameter.
PS C:\> Get-RDSessionCollection -CollectionName “Session Collection” -ConnectionBroker rdcb.contoso.com
Example 2: Duplicate Example
This command lists details of the session collection named Session Collection, as specified by the CollectionName parameter. The session collections are associated with a specific RD Connection Broker, as specified by the rdcb.contoso.com value, by using the ConnectionBroker parameter.
PS C:\> Get-RDSessionCollection -CollectionName “Session Collection” -ConnectionBroker rdcb.contoso.com
