Group-BrokerDesktop
Groups and counts desktops with the same value for a specified property.
Syntax
Group-BrokerDesktop
[[-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>]
-Property <String>
[-ReturnTotalRecordCount]
[-MaxRecordCount <Int32>]
[-Skip <Int32>]
[-SortBy <String>]
[-Filter <String>]
[-FilterScope <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Group-BrokerDesktop
[-Uid] <Int32>
-Property <String>
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
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:
Group-BrokerDesktop -Property SummaryState
Count Name
----- ----
43 Available
17 InUse
3 Disconnected
<!--NeedCopy-->
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.
Examples
EXAMPLE 1
Group desktops from the dg1 group by summary state.
Group-BrokerDesktop -Property SummaryState -DesktopGroupName dg1
<!--NeedCopy-->
EXAMPLE 2
For desktops where the last connection attempt failed, list the most common reason for failure, ignoring connections that failed over a week ago.
Group-BrokerDesktop -Property LastConnectionFailure -Filter { LastConnectionFailure -ne "None" -and LastConnectionTime -ge '-7' } -MaxRecordCount 1
<!--NeedCopy-->
EXAMPLE 3
List alphabetically the hypervisor servers hosting desktops that are currently experiencing high network latency.
Group-BrokerDesktop -Property HostingServerName -DesktopCondition ICALatency -SortBy Name
<!--NeedCopy-->
Parameters
-Uid
Gets desktops with a specific UID.
| Type: | Int32 |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Property
Selects the property by which matching desktops are grouped.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MachineName
Gets desktops with a specific machine name (in the form ‘domain\machine’).
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AgentVersion
Gets desktops with a specific Citrix Virtual Delivery Agent version.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ApplicationInUse
Gets desktops running a specified published application (identified by browser name).
String comparisons are case-insensitive.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AssignedClientName
Gets desktops assigned to a specific client name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AssignedIPAddress
Gets desktops assigned to a specific IP address.q
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CatalogName
Gets desktops from the catalog with the specific name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CatalogUid
Gets desktops from a catalog with a specific UID.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ClientAddress
Gets desktops with a specific client IP address.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ClientName
Gets desktops with a specific client name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ClientVersion
Gets desktops with a specific client version.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ColorDepth
Gets desktops configured with a specific color depth.
Valid values are FourBit, EightBit, SixteenBit, and TwentyFourBit.
| Type: | ColorDepth |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ConnectedViaHostName
Gets desktops with a specific host name of the incoming connection. This is usually a proxy or Citrix Access Gateway server.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ConnectedViaIP
Gets desktops with a specific IP address of the incoming connection.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ControllerDNSName
Gets desktops with a specific DNS name of the controller they are registered with.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeliveryType
Gets desktops of a particular delivery type.
Valid values are AppsOnly, DesktopsOnly, DesktopsAndApps
| Type: | DeliveryType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Get desktops with a specific description.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DesktopCondition
Gets desktop with an outstanding desktop condition condition.
Valid values are:
- CPU: Indicates the machine has high CPU usage
- ICALatency: Indicates the network latency is high
- UPMLogonTime: Indicates that the profile load time was high
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DesktopGroupName
Gets desktops from a desktop group with the specified name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DesktopGroupUid
Gets desktops from a desktop group with the specified UID.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DesktopKind
Deprecated: Use AllocationType parameter.
Gets desktops of a particular kind.
Valid values are Private, Shared.
| Type: | DesktopKind |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeviceId
Gets desktops with a specific client device ID.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DNSName
Get desktops with a specific DNS name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FunctionalLevel
Gets desktops with a specific FunctionalLevel.
Valid values are L5, L7, L7_6, L7_7, L7_8, L7_9, L7_20, L7_25
| Type: | FunctionalLevel |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HardwareId
Gets desktops with a specific client hardware ID.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HostedMachineId
Gets desktops with a specific machine ID known to the hypervisor.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HostedMachineName
Gets desktops with a specific machine name known to the hypervisor.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HostingServerName
Gets desktops with a specific name of the hosting hypervisor server.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HypervisorConnectionName
Gets desktops with a specific name of the hosting hypervisor connection.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HypervisorConnectionUid
Gets desktops with a specific UID of the hosting hypervisor connection.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IconUid
Gets desktops with a specific configured icon. Note that desktops with a null IconUid use the icon of the desktop group.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ImageOutOfDate
Gets desktops if they have an ImageOutOfDate flag.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InMaintenanceMode
Gets desktops with a specific InMaintenanceMode setting.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IPAddress
Gets desktops with a specific IP address.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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 a Pvs catalog kind.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | ConnectionFailureReason |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LastConnectionUser
Gets desktops where a specific user name last attempted a connection (in the form ‘domain\user’).
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LastDeregistrationReason
Gets desktops whose broker last recorded a specific deregistration reason.
Valid values are $null, AgentShutdown, AgentSuspended, AgentRequested, IncompatibleVersion, AgentAddressResolutionFailed, AgentNotContactable, AgentWrongActiveDirectoryOU, EmptyRegistrationRequest, MissingRegistrationCapabilities, MissingAgentVersion, InconsistentRegistrationCapabilities, NotLicensedForFeature, UnsupportedCredentialSecurityVersion, InvalidRegistrationRequest, SingleMultiSessionMismatch, FunctionalLevelTooLowForCatalog, FunctionalLevelTooLowForDesktopGroup, PowerOff, DesktopRestart, DesktopRemoved, AgentRejectedSettingsUpdate, SendSettingsFailure, SessionAuditFailure, SessionPrepareFailure, ContactLost, SettingsCreationFailure, UnknownError and BrokerRegistrationLimitReached.
| Type: | DeregistrationReason |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LastDeregistrationTime
Gets desktops that were last deregistered by a specific time.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LastErrorReason
Gets desktops with the specified last error reason.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LastErrorTime
Gets desktops with the specified last error time.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LastHostingUpdateTime
Gets desktops with a specific time that the hosting information was last updated.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LaunchedViaHostName
Gets desktops with a specific host name of the StoreFront server from which the user launched the session.
Session properties are always null for multi-session desktops.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LaunchedViaIP
Gets desktops with a specific IP address of the StoreFront server from which the user launched the session.
Session properties are always null for multi-session desktops.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MachineInternalState
Gets desktops with the specified internal machine state.
| Type: | MachineInternalState |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MachineUid
Gets desktops with a specific machine UID.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OSType
Gets desktops by the type of operating system they are running.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OSVersion
Gets desktops by the version of the operating system they are running.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PersistUserChanges
Gets desktops by the location where the user changes are persisted.
- OnLocal - User changes are persisted locally.
- Discard - User changes are discarded.
| Type: | PersistUserChanges |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PowerActionPending
Gets desktops with a specific power action pending state.
Valid values are $true or $false.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PowerState
Gets desktops with a specific power state.
Valid values are Unmanaged, Unknown, Unavailable, Off, On, Suspended, TurningOn, TurningOff, Suspending, and Resuming.
| Type: | PowerState |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Protocol
Gets desktops with connections using a specific protocol, for example HDX, RDP, or Console.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProvisioningType
Specifies the provisioning type for the catalog. Values can be:
- Manual - No provisioning.
- PVS - Machine provisioned by PVS (machine may be physical, blade, VM,…).
- MCS - Machine provisioned by MCS (machine must be VM).
| Type: | ProvisioningType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PublishedApplication
Gets desktops with a specific application published on them (identified by its browser name).
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PublishedName
Gets desktops with a specific published name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PvdStage
This property is no longer supported.
| Type: | PvdStage |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RegistrationState
Gets desktops with a specific registration state.
Valid values are Unregistered, Initializing, Registered and AgentError.
| Type: | RegistrationState |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SecureIcaActive
Gets desktops depending on whether the current session uses SecureICA or not.
Session properties are always null for multi-session desktops.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SessionState
Gets desktops with a specific session state.
Valid values are $null, Other, PreparingSession, Connected, Active, Disconnected, Reconnecting, NonBrokeredSession, and Unknown.
Session properties are always null for multi-session desktops.
| Type: | SessionState |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SessionStateChangeTime
Gets desktops whose sessions last changed state at a specific time.
Session properties are always null for multi-session desktops.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SessionUid
Gets desktops with a specific session UID ($null for no session).
Session properties are always null for multi-session desktops.
| Type: | Int64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SessionUserName
Gets desktops with a specific user name for the current session (in the form ‘domain\user’).
Session properties are always null for multi-session desktops.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SessionUserSID
Gets desktops with a specific SID of the current session user.
Session properties are always null for multi-session desktops.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SID
Gets desktops with a specific machine SID.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SmartAccessTag
Gets desktops where the session has the specific SmartAccess tag.
Session properties are always null for multi-session desktops.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StartTime
Gets desktops with a specific session start time.
Session properties are always null for multi-session desktops.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SummaryState
Gets desktops with a specific summary state.
Valid values are Off, Unregistered, Available, Disconnected, and InUse.
| Type: | DesktopSummaryState |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Tag
Gets desktops with a specific tag.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WillShutdownAfterUse
Gets desktops depending on whether they shut down after use or not.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ApplicationUid
Gets desktops with a specific published application (identified by its UID).
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaxRecordCount
Specifies the maximum number of records to return.
| Type: | Int32 |
| Position: | Named |
| Default value: | 250 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Skip
Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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.
| Type: | String |
| Position: | Named |
| Default value: | The default sort order is by name or unique identifier. |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Filter
Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FilterScope
Gets only results allowed by the specified scope id.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
You cannot pipe input into this cmdlet.
Outputs
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.