Export (0) Print
Expand All
Expand Minimize

Get-RDServer

Updated: August 12, 2013

Applies To: Windows Server 2012

Get-RDServer

Gets RDS servers in a Remote Desktop deployment.

Syntax

Parameter Set: Default
Get-RDServer [[-ConnectionBroker] <String> ] [[-Role] <String[]> ] [ <CommonParameters>]




Detailed Description

The Get-RDServer cmdlet gets the Remote Desktop Services (RDS) servers in a Remote Desktop deployment. You can get servers by role, or all servers in a deployment.

Parameters

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

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Role<String[]>

Specifies an array of names of RDS service roles. The acceptable values for this parameter are: 

-- RDS-VIRTUALIZATION. Remote Desktop Virtualization Host (RD Virtualization Host).
-- RDS-RD-SERVER. Remote Desktop Session Host (RD Session Host).
-- RDS-CONNECTION-BROKER. RD Connection Broker.
-- RDS-WEB-ACCESS. Remote Desktop Web Access (RD Web Access).
-- RDS-GATEWAY. Remote Desktop Gateway (RD Gateway).
-- RDS-LICENSING. Remote Desktop Licensing (RD Licensing).


Aliases

none

Required?

false

Position?

2

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.

  • System.Object

    Server. FQDN of an RD Connection Broker.
    Roles. Names of RDS role services.


Examples

Example 1: Get all servers

This command gets all servers and the server roles installed in the Remote Desktop deployment on the local computer.


PS C:\> Get-RDserver

Example 2: Get servers that have a specified role

This command gets the servers that have the RD Virtualization Host server role for the local computer. The Role parameter has the value RDS-VIRTUALIZATION.


PS C:\> Get-RDserver -Role "RDS-VIRTUALIZATION"

Example 3: Get all servers for an RD Connection Broker

This command gets the servers and the server roles installed in the Remote Desktop deployment for the RD Connection Broker, named RDCB.Contoso.com.


PS C:\> Get-RDServer -ConnectionBroker "RDCB.Contoso.com"

Related topics

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