Get-RDServer

NAME Get-RDServer



SYNOPSIS

Gets RDS servers in a Remote Desktop deployment.





SYNTAX

Get-RDServer [[-ConnectionBroker] <String>] [[-Role] {RDS-VIRTUALIZATION | RDS-RD-SERVER | RDS-CONNECTION-BROKER | RDS-WEB-ACCESS | RDS-GATEWAY |

RDS-LICENSING}] [<CommonParameters>]





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 (RDConnection 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.



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).



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, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS









OUTPUTS

System.Object



Server. FQDN of an RD?? Connection Broker.

Roles. Names of RDS role services.





Example 1: Get all servers



PS C:\\> Get-RDserver



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





Example 2: Get servers that have a specified role



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



This command gets the servers that have the RDVirtualization Host server role for the local computer. The Role parameter has the value

RDS-VIRTUALIZATION.





Example 3: Get all servers for an RD?? Connection Broker



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



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







RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=294220

Add-RDServer

Remove-RDServer