< Back

Get-RDVirtualDesktop

Thu Apr 04, 2019 5:42 am

NAME Get-RDVirtualDesktop



SYNOPSIS

Gets a list of virtual desktops in the remote desktop deployment.





SYNTAX

Get-RDVirtualDesktop [[-CollectionName] <String[]>] [-ConnectionBroker <String>] [<CommonParameters>]





DESCRIPTION

The Get-RDVirtualDesktop cmdlet gets a list of virtual desktops in the remote desktop deployment.





PARAMETERS

-CollectionName [<String[]>]

Specifies an array of names of personal virtual desktop collections.



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

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







Example 1: Retrieve a list of Virtual Desktops



PS C:\\> Get-RDVirtualDesktop -ConnectionBroker "rdcb.contoso.com" | sort-object VirtualDesktopName



This command lists virtual desktops in the collections associated with the connection broker server named rdcb.contoso.com. The command uses the

pipeline operator to send the results to the Sort-Object cmdlet, which sorts the objects in order of the VirtualDesktopName property.





Example 2: Retrieve a list of Virtual Desktops in a Collection



PS C:\\> Get-RDVirtualDesktop -ConnectionBroker "rdcb.contoso.com" -CollectionName @("Virtual Desktop pool")



This command lists virtual desktops in the collection named Virtual Desktop pool that is associated with the connection broker server named

rdcb.contoso.com.







RELATED LINKS

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

Move-RDVirtualDesktop

Get-RDVirtualDesktopCollection