.png)
Get-RDSessionHost
Updated: September 14, 2012
Applies To: Windows Server 2012
Get-RDSessionHost
Syntax
Parameter Set: __AllParameterSets Get-RDSessionHost [-CollectionName] <String> [-ConnectionBroker <String> ] [ <CommonParameters>]
Detailed Description
The Get-RDSessionHost cmdlet gets a list of RD Session Host servers in a session collection.
Parameters
-CollectionName<String>
Specifies the name of the virtual desktop collection. This parameter is required.
|
Aliases |
none |
|
Required? |
true |
|
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.RDServer
Examples
Example 1: Retrieve a list of RD Session Host Servers in the Session Collection
This command retrieves a list of the RD Session Host servers in the session collection named Session Collection, as specified by the CollectionName parameter associated with the Remote Desktop Connection Broker server named rdcb.contoso.com, as specified by the ConnectionBroker parameter.
PS C:\> Get-RDSessionHost -CollectionName “Session Collection” -ConnectionBroker rdcb.contoso.com
Example 2: Duplicate
This command retrieves a list of the RD Session Host servers in the session collection named Session Collection, as specified by the CollectionName parameter associated with the Remote Desktop Connection Broker server named rdcb.contoso.com, as specified by the ConnectionBroker parameter.
PS C:\> Get-RDSessionHost -CollectionName “Session Collection” -ConnectionBroker rdcb.contoso.com
