Citrix Virtual Apps and Desktops SDK

Group-BrokerDesktop

March 11, 2024

Contributed by:

Groups and counts desktops with the same value for a specified property.

Syntax

Group-BrokerDesktop [-Uid] <Int32> -Property <String> [-AdminAddress <String>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

Group-BrokerDesktop -Property <String> [[-MachineName] <String>] [-AgentVersion <String>] [-ApplicationInUse <String>] [-AssignedClientName <String>] [-AssignedIPAddress <String>] [-AssociatedUserFullName <String>] [-AssociatedUserName <String>] [-AssociatedUserUPN <String>] [-AutonomouslyBrokered <Boolean>] [-CatalogName <String>] [-CatalogUid <Int32>] [-ClientAddress <String>] [-ClientName <String>] [-ClientVersion <String>] [-ColorDepth <ColorDepth>] [-ConnectedViaHostName <String>] [-ConnectedViaIP <String>] [-ControllerDNSName <String>] [-DeliveryType <DeliveryType>] [-Description <String>] [-DesktopCondition <String>] [-DesktopGroupName <String>] [-DesktopGroupUid <Int32>] [-DesktopKind <DesktopKind>] [-DeviceId <String>] [-DNSName <String>] [-FunctionalLevel <FunctionalLevel>] [-HardwareId <String>] [-HostedMachineId <String>] [-HostedMachineName <String>] [-HostingServerName <String>] [-HypervisorConnectionName <String>] [-HypervisorConnectionUid <Int32>] [-IconUid <Int32>] [-ImageOutOfDate <Boolean>] [-InMaintenanceMode <Boolean>] [-IPAddress <String>] [-IsAssigned <Boolean>] [-IsPhysical <Boolean>] [-LastConnectionFailure <ConnectionFailureReason>] [-LastConnectionTime <DateTime>] [-LastConnectionUser <String>] [-LastDeregistrationReason <DeregistrationReason>] [-LastDeregistrationTime <DateTime>] [-LastErrorReason <String>] [-LastErrorTime <DateTime>] [-LastHostingUpdateTime <DateTime>] [-LaunchedViaHostName <String>] [-LaunchedViaIP <String>] [-MachineInternalState <MachineInternalState>] [-MachineUid <Int32>] [-OSType <String>] [-OSVersion <String>] [-PersistUserChanges <PersistUserChanges>] [-PowerActionPending <Boolean>] [-PowerState <PowerState>] [-Protocol <String>] [-ProvisioningType <ProvisioningType>] [-PublishedApplication <String>] [-PublishedName <String>] [-PvdStage <PvdStage>] [-RegistrationState <RegistrationState>] [-SecureIcaActive <Boolean>] [-SecureIcaRequired <Boolean>] [-SessionHidden <Boolean>] [-SessionId <Int32>] [-SessionState <SessionState>] [-SessionStateChangeTime <DateTime>] [-SessionUid <Int64>] [-SessionUserName <String>] [-SessionUserSID <String>] [-SID <String>] [-SmartAccessTag <String>] [-StartTime <DateTime>] [-SummaryState <DesktopSummaryState>] [-Tag <String>] [-WillShutdownAfterUse <Boolean>] [-ApplicationUid <Int32>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

This cmdlet is now deprecated, please use Group-BrokerMachine.

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

<!--NeedCopy-->

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.

Parameters

Name	Description	Required?	Pipeline Input
Uid	Gets desktops with a specific UID.	true	false
Property	Selects the property by which matching desktops are grouped.	true	false
MachineName	Gets desktops with a specific machine name (in the form ‘domain\machine’).	false	false
AgentVersion	Gets desktops with a specific Citrix Virtual Delivery Agent version.	false	false
ApplicationInUse	Gets desktops running a specified published application (identified by browser name).
String comparisons are case-insensitive.	false	false
AssignedClientName	Gets desktops assigned to a specific client name.	false	false
AssignedIPAddress	Gets desktops assigned to a specific IP address.q	false	false
AssociatedUserFullName	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.	false	false
CatalogName	Gets desktops from the catalog with the specific name.	false	false
CatalogUid	Gets desktops from a catalog with a specific UID.	false	false
ClientAddress	Gets desktops with a specific client IP address.	false	false
ClientName	Gets desktops with a specific client name.	false	false
ClientVersion	Gets desktops with a specific client version.	false	false
ColorDepth	Gets desktops configured with a specific color depth.
Valid values are FourBit, EightBit, SixteenBit, and TwentyFourBit.	false	false
ConnectedViaHostName	Gets desktops with a specific host name of the incoming connection. This is usually a proxy or Citrix Access Gateway server.	false	false
ConnectedViaIP	Gets desktops with a specific IP address of the incoming connection.	false	false
ControllerDNSName	Gets desktops with a specific DNS name of the controller they are registered with.	false	false
DeliveryType	Gets desktops of a particular delivery type.
Valid values are AppsOnly, DesktopsOnly, DesktopsAndApps	false	false
Description	Get desktops with a specific description.	false	false
DesktopCondition	Gets desktop with an outstanding desktop condition condition.

Input Type

None

You cannot pipe input into this cmdlet.

Return Values

Citrix.Broker.Admin.Sdk.Groupinfo

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.

Notes

To compare dates or times, use -Filter and relative comparisons. For more information, see about_Broker_Filtering and the examples.

Examples

Example 1

C:\PS> Group-BrokerDesktop -Property SummaryState -DesktopGroupName dg1

<!--NeedCopy-->

Description

Group desktops from the dg1 group by summary state.

Example 2

C:\PS> Group-BrokerDesktop -Property LastConnectionFailure -Filter { LastConnectionFailure -ne "None" -and LastConnectionTime -ge '-7' } -MaxRecordCount 1

<!--NeedCopy-->

Description

For desktops where the last connection attempt failed, list the most common reason for failure, ignoring connections that failed over a week ago.

Example 3

C:\PS> Group-BrokerDesktop -Property HostingServerName -DesktopCondition ICALatency -SortBy Name

<!--NeedCopy-->

Description

List alphabetically the hypervisor servers hosting desktops that are currently experiencing high network latency.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Group-BrokerDesktop

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Group-BrokerDesktop

Syntax

Detailed Description

Related Commands

Parameters

Input Type

None

Return Values

Citrix.Broker.Admin.Sdk.Groupinfo

Notes

Examples

Example 1

Description

Example 2

Description

Example 3

Description

In this article