Get-BrokerDesktop [-Uid] <Int32> [-Property <String[]>] [-AdminAddress <String>] [<CommonParameters>]

Get-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>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-Property <String[]>] [-AdminAddress <String>] [<CommonParameters>]

-- AgentVersion (System.String)
   Version of the Citrix Virtual Delivery Agent (VDA) installed on the desktop.

-- ApplicationsInUse (System.String[])
   List of applications in use on the desktop (in the form of browser name).

-- AssignedClientName (System.String)
   The name of the endpoint client device that the desktop has been assigned to.

-- AssignedIPAddress (System.String)
   The IP address of the endpoint client device that the desktop has been assigned to.

-- AssociatedUserFullNames (System.String[])
   Full names of the users that have been associated with the desktop (in the form "Firstname Lastname").
   Associated users are the current user(s) for shared desktops and the assigned users for private desktops.

-- AssociatedUserNames (System.String[])
   Usernames of the users that have been associated with the desktop (usually in the form "domain\user").
   Associated users are the current user(s) for shared desktops and the assigned users for private desktops.

-- AssociatedUserUPNs (System.String[])
   The user principal names of the users that have been associated with the desktop (in the form user@upndomain.com).
   Associated users are the current user(s) for shared desktops and the assigned users for private desktops.

-- AutonomouslyBrokered (System.Boolean?)
   Session property indicating if the current session is an HDX session established by direct connection without being brokered.
   Session properties are always null for multi-session desktops.

-- CatalogName (System.String)
   Name of the catalog the desktop is a member of.

-- CatalogUid (System.Int32)
   UID of the catalog the desktop is a member of.

-- ClientAddress (System.String)
   Session property indicating the IP address of the client connected to the desktop.
   Session properties are always null for multi-session desktops.

-- ClientName (System.String)
   Session property indicating the host name of the client connected to the desktop.
   Session properties are always null for multi-session desktops.

-- ClientVersion (System.String)
   Session property indicating the version of the Citrix Receiver running on the connected client.
   Session properties are always null for multi-session desktops.

-- ColorDepth (Citrix.Broker.Admin.SDK.ColorDepth?)
   The color depth setting configured on the desktop, possible values are:
   $null, FourBit, EightBit, SixteenBit, and TwentyFourBit.

-- ConnectedViaHostName (System.String)
   Session property indicating the host name of the connection gateway, router or client.
   Session properties are always null for multi-session desktops.

-- ConnectedViaIP (System.String)
   Session property indicating the IP address of the connection gateway, router or client.
   Session properties are always null for multi-session desktops.

-- ControllerDNSName (System.String)
   The DNS host name of the controller that the desktop is registered to.

-- DeliveryType (Citrix.Broker.Admin.SDK.DeliveryType)
   Denotes whether the desktop delivers desktops only, apps only or both.

-- Description (System.String)
   Description of the desktop.

-- DesktopConditions (System.String[])
   List of outstanding desktop conditions for the desktop.

-- DesktopGroupName (System.String)
   Name of the desktop group the desktop has been assigned to.

-- DesktopGroupUid (System.Int32)
   Uid of the desktop group the desktop has been assigned to.

-- DesktopKind (Citrix.Broker.Admin.SDK.DesktopKind)
   Deprecated.
   Denotes whether the desktop is private or shared. AllocationType should be used instead.

-- DeviceId (System.String)
   Session property indicating a unique identifier for the client device that has most recently been associated with the current session.
   Session properties are always null for multi-session desktops.

-- DNSName (System.String)
   The DNS host name of the desktop.

-- FunctionalLevel (Citrix.Broker.Admin.SDK.FunctionalLevel?)
   The functional level of the desktop, if known.

-- HardwareId (System.String)
   Session property indicating a unique identifier for the client hardware that has been most recently associated with the current session.
   Session properties are always null for multi-sesison desktops.

-- HostedMachineId (System.String)
   Unique ID within the hosting unit of the target managed desktop.

-- HostedMachineName (System.String)
   The friendly name of a hosted desktop as used by its hypervisor. This is not necessarily the DNS name of the desktop.

-- HostingServerName (System.String)
   DNS name of the hypervisor that is hosting the desktop if managed.

-- HypervisorConnectionName (System.String)
   The name of the hypervisor connection that the desktop's hosting server is accessed through, if managed.

-- HypervisorConnectionUid (System.Int32?)
   The UID of the hypervisor connection that the desktop's hosting server is accessed through, if managed.

-- IconUid (System.Int32?)
   The UID of the desktop's icon that is displayed in StoreFront.

-- ImageOutOfDate (System.Boolean?)
   Denotes whether the VM image for a hosted desktop is out of date.

-- InMaintenanceMode (System.Boolean)
   Denotes whether the desktop is in maintenance mode.

-- IPAddress (System.String)
   The IP address of the desktop.

-- IsAssigned (System.Boolean)
   Denotes whether a private desktop has been assigned to a user/users, or a client name/address. Users can be assigned explicitly or by assigning on first use of the desktop.

-- IsPhysical (System.Boolean)
   This value is true if the desktop is physical(ie not power managed by the Citrix Broker Service), and false otherwise.

-- LastConnectionFailure (Citrix.Broker.Admin.SDK.ConnectionFailureReason)
   The reason for the last failed connection between a client and the desktop.

-- LastConnectionTime (System.DateTime?)
   Time of the last detected connection attempt that either failed or succeeded.

-- LastConnectionUser (System.String)
   The SAM name (in the form DOMAIN\user) of the user that last attempted a connection with the desktop. If the SAM name is not available, the SID is used.

-- LastDeregistrationReason (Citrix.Broker.Admin.SDK.DeregistrationReason?)
   The reason for the last deregistration of the desktop with the broker. Possible values are:
   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.

-- LastDeregistrationTime (System.DateTime?)
   Time of the last deregistration of the desktop from the controller.

-- LastErrorReason (System.String)
   The reason for the last error detected in the desktop.

-- LastErrorTime (System.DateTime?)
   The time of the last detected error.

-- LastHostingUpdateTime (System.DateTime?)
   Time of last update to any hosting data (such as power state) for this desktop reported by the hypervisor connection.

-- LaunchedViaHostName (System.String)
   Session property that denotes the host name of the StoreFront server used to launch the current brokered session.
   Session properties are always null for multi-session desktops.

-- LaunchedViaIP (System.String)
   Session property that denotes the IP address of the StoreFront server used to launch the current brokered session.
   Session properties are always null for multi-session desktops.

-- MachineInternalState (Citrix.Broker.Admin.SDK.MachineInternalState)
   The internal state of the machine associated with the desktop; reported while the desktop is registered to a controller, plus some private Citrix Broker Service states while the machine is not registered.

-- MachineName (System.String)
   DNS host name of the machine associated with the desktop.

-- MachineUid (System.Int32)
   Uid of the associated machine.

-- OSType (System.String)
   A string that can be used to identify the operating system that is running on the desktop.

-- OSVersion (System.String)
   A string that can be used to identify the version of the operating system running on the desktop, if known

-- PersistUserChanges (Citrix.Broker.Admin.SDK.PersistUserChanges)
   Describes whether/how the user changes are persisted. Possible values are:
   o OnLocal - Persist the user changes on the local disk of the desktop.
   o Discard - Discard user changes.
   o OnPvd - Persist user changes on the Citrix Personal vDisk.

-- PowerActionPending (System.Boolean)
   Property indicating whether there are any pending power actions for the desktop.

-- PowerState (Citrix.Broker.Admin.SDK.PowerState)
   The current power state of the desktop. Possible values are: Unmanaged, Unknown, Unavailable, Off, On, Suspended, TurningOn, TurningOff, Suspending, resuming.

-- Protocol (System.String)
   Session property that denotes the protocol that the current session is using, can be either HDX, RDP or Console. Console sessions on XenDesktop 5 VDAs appear with a blank protocol.
   Session properties are always null for multi-session desktops.

-- ProvisioningType (Citrix.Broker.Admin.SDK.ProvisioningType)
   Describes how the machine associated with the desktop was provisioned, possible values are:
   o Manual: No automated provisioning.
   o PVS: Machine provisioned by PVS (may be physical, blade, VM,...)
   o MCS: Machine provisioned by MCS (machine must be VM)

-- PublishedApplications (System.String[])
   List of applications published by the desktop (displayed as browser names).

-- PublishedName (System.String)
   The name of the desktop that is displayed in StoreFront, if the desktop is published.

-- PvdStage (Citrix.Broker.Admin.SDK.PvdStage)
   For a desktop supporting Personal vDisk technology (PvD), indicates the stage of the PvD image preparation.

-- RegistrationState (Citrix.Broker.Admin.SDK.RegistrationState)
   Indicates the registration state of the desktop. Possible values are: Unregistered, Initializing, Registered, AgentError.

-- SecureIcaActive (System.Boolean?)
   Session property that indicates whether SecureICA is active on the current session.
   Session properties are always null for multi-session desktops.

-- SecureIcaRequired (System.Boolean?)
   Flag indicating whether SecureICA is required or not when starting a session on the desktop.

-- SessionHidden (System.Boolean?)
   Session property that indicates if a session is hidden.
   Session properties are always null for multi-session desktops.

-- SessionId (System.Int32?)
   Deprecated. A unique identifier that Remote Desktop Services uses to track the session but it is only unique on that machine and only unique at any one particular time.

-- SessionState (Citrix.Broker.Admin.SDK.SessionState?)
   Session property indicating the state of the current session.
   Session properties are always null for multi-session desktops, possible values are: Other, PreparingSession, Connected, Active, Disconnected, Reconnecting, NonBrokeredSession and Unknown.

-- SessionStateChangeTime (System.DateTime?)
   Session property indicating the time of the last state change of the current session.
   Session properties are always null for multi-session desktops.

-- SessionUid (System.Int64?)
   Session property indicating the UID of the current session.
   Session properties are always null for multi-session desktops.

-- SessionUserName (System.String)
   Session property indicates the name of the current sessions' user (in the form DOMAIN\user).
   Session properties are always null for multi-session desktops.

-- SessionUserSID (System.String)
   Session property indicates the SID of the current sessions' user.
   Session properties are always null for multi-session desktops.

-- SID (System.String)
   The SID of the desktop.

-- SmartAccessTags (System.String[])
   Session property that indicates the Smart Access tags for the current session.
   Session properties are always null on multi-session desktops.

-- StartTime (System.DateTime?)
   Session property that indicates the start time of the current session.
   Session properties are always null on multi-session desktops.

-- SummaryState (Citrix.Broker.Admin.SDK.DesktopSummaryState)
   Indicates the overall state of the desktop. The overall state is a result of other more specific states such as session state, registration state and power state. Possible values: Off, Unregistered, Available, Disconnected, InUse, Preparing.

-- Tags (System.String[])
   A list of tags for the desktop.

-- Uid (System.Int32)
   UID of the desktop object.

-- WillShutdownAfterUse (System.Boolean)
   Flag indicating whether this desktop is tainted and will be shut down after all sessions on the desktop have ended. This flag should only ever be true on power managed, single-session desktops.
   Note: The desktop will not shut down if it is in maintenance mode, but will shut down after the desktop is taken out of maintenance mode.

C:\PS> Get-BrokerDesktop -RegistrationState Unregistered
C:\PS> Get-BrokerDesktop -Filter { RegistrationState -ne 'Registered' }

C:\PS> Get-BrokerDesktop -SessionUid $null | ft -a DNSName,SummaryState

C:\PS> Get-BrokerDesktop -Filter { OSType -like "Windows XP*" -and ImageOutOfDate }

C:\PS> Get-BrokerDesktop -ApplicationInUse '*powerpoint*'

C:\PS> Get-BrokerDesktop -DesktopCondition * DNSName,SessionUserName,DesktopConditions

C:\PS> $d = (Get-Date).AddDays(-1)
C:\PS> Get-BrokerDesktop -Filter { StartTime -le $d } | ft MachineName,SessionUserName,StartTime,@{Label='Duration'; Expression={(Get-Date) - $_.StartTime}}