Filters desktops using the specified criteria, then groups and counts matching desktops with the same value for a particular property. The number of desktops in the group, and the property value for the group, is output. For example:

C:\PS> Group-BrokerDesktop -Property SummaryState

Count Name ----- ---- 43 Available 17 InUse 3 Disconnected

Filtering supports the same options as the Get-BrokerDesktop cmdlet, and allows filtering on both desktop and session properties.

Group-BrokerDesktop is similar to the standard PowerShell Group-Object, but is faster than piping the output of Get-BrokerDesktop into Group-Object when working with many desktops.

Note that all session information properties for multi-session desktops is always \$null, this means that is is not possible to group these desktops by session information using this command. Use Get-BrokerSession to get information on all current sessions.

Also note that the MaxRecordCount, ReturnTotalRecordCount, Skip, and SortBy parameters apply to GroupInfo records output rather than the filtered desktops.

Gets desktops with an associated user identified by their full name (usually in the form 'first-name last-name').Associated users are the current user for shared desktops, and the assigned users for private desktops.

false

false

AssociatedUserName

Gets desktops with an associated user identified by their user name (in the form 'domain\user').Associated users are the current user for shared desktops, and the assigned users for private desktops.

false

false

AssociatedUserUPN

Gets desktops with an associated user identified by their User Principle Name (in the form 'user@domain').Associated users are the current user for shared desktops, and the assigned users for private desktops.

false

false

AutonomouslyBrokered

Gets desktops according to whether their current session is autonomously brokered or not. Autonomously brokered sessions are HDX sessions established by direct connection without being brokered.Session properties are always null for multi-session desktops.

Gets desktop with an outstanding desktop condition condition.Valid values are:o CPU: Indicates the machine has high CPU usageo ICALatency: Indicates the network latency is higho UPMLogonTime: Indicates that the profile load time was high

false

false

DesktopGroupName

Gets desktops from a desktop group with the specified name.

false

false

DesktopGroupUid

Gets desktops from a desktop group with the specified UID.

false

false

DesktopKind

Deprecated: Use AllocationType parameter.Gets desktops of a particular kind.Valid values are Private, Shared.

Gets desktops with a specific name of the hosting hypervisor connection.

false

false

HypervisorConnectionUid

Gets desktops with a specific UID of the hosting hypervisor connection.

false

false

IconUid

Gets desktops with a specific configured icon. Note that desktops with a null IconUid use the icon of the desktop group.

false

false

ImageOutOfDate

Gets desktops if they have an ImageOutOfDate flag.

false

false

InMaintenanceMode

Gets desktops with a specific InMaintenanceMode setting.

false

false

IPAddress

Gets desktops with a specific IP address.

false

false

IsAssigned

Gets desktops according to whether they are assigned or not. Desktops may be assigned to one or more users or groups, a client IP address or a client endpoint name.

false

false

IsPhysical

Specifies if machines in the catalog can be power managed by the Citrix Broker Service. Where the power state of the machine cannot be controlled, specify \$true, otherwise \$false. Can only be specified together with a provisioning type of Pvs or Manual, or if used with the deprecated CatalogKind parameter only with Pvs or PvsPvd catalog kinds.

false

false

LastConnectionFailure

Gets desktops with a specific reason for the last recorded connection failure. This value is None if the last connection was successful or if there has been no attempt to connect to the desktop yet.Valid values are None, SessionPreparation, RegistrationTimeout, ConnectionTimeout, Licensing, Ticketing, and Other.

false

false

LastConnectionTime

Gets desktops that last connected at a specific time. This is the time that the broker detected that the connection attempt either succeeded or failed.

false

false

LastConnectionUser

Gets desktops where a specific user name last attempted a connection (in the form 'domain\user').

Gets desktops depending on whether the current session uses SecureICA or not.Session properties are always null for multi-session desktops.

false

false

SecureIcaRequired

Gets desktops configured with a particular SecureIcaRequired setting. Note that the desktop setting of \$null indicates that the desktop group value is used.Session properties are always null for multi-session desktops.

false

false

SessionHidden

Gets desktops by whether their sessions are hidden or not. Hidden sessions are treated as though they do not exist when launching sessions; a hidden session cannot be reconnected to, but a new session may be launched using the same entitlement.Session properties are always null for multi-session desktops.

false

false

SessionId

Deprecated.Gets desktops by session ID, a unique identifier that Remote Desktop Services uses to track the session but it is only unique on that machine.

Gets desktops with a specific published application (identified by its UID).

false

false

ReturnTotalRecordCount

When specified, this causes the cmdlet to output an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Broker_Filtering for details.

false

false

False

MaxRecordCount

Specifies the maximum number of records to return.

false

false

250

Skip

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.

false

false

0

SortBy

Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.

false

false

The default sort order is by name or unique identifier.

Filter

Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details.

false

false

AdminAddress

Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address.

false

false

Localhost. Once a value is provided by any cmdlet, this value will become the default.

Each GroupInfo object represents one group, and contains the following properties:-- Count: The count of desktops in this group.-- Name: The value of the property the desktops were grouped by (as a string).If you do not specify -SortBy, groups are sorted with the largest count first.