This cmdlet is deprecated, please use the Get-BrokerMachine cmdlet instead.
Retrieve shared desktops matching the specified criteria. If no parameters are specified, all shared desktops are enumerated.
Get-BrokerSharedDesktop returns configuration information only for shared desktops (a DesktopKind of 'Shared').
For information about advanced filtering options, see about_Broker_Filtering; for information about desktops, see about_Broker_Desktops.
-------------------------- BrokerSharedDesktop Object
Shared desktops are desktops that are assigned randomly to users upon connection from a pool of available machines.
-- AgentVersion (System.String)
Version of the Citrix Virtual Delivery Agent (VDA) installed on the desktop.
-- ControllerDNSName (System.String)
The DNS host name of the controller that the desktop is registered to.
-- DesktopGroupUid (System.Int32)
Uid of the desktop group the desktop has been assigned to.
-- DNSName (System.String)
The DNS host name of the desktop.
-- 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.
-- HypervisorConnectionUid (System.Int32?)
The UID of the hypervisor connection that the desktop has been assigned to, if managed.
-- InMaintenanceMode (System.Boolean)
Denotes whether the desktop is in maintentance mode.
-- IPAddress (System.String)
The IP address of the desktop.
-- 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.
-- LastHostingUpdateTime (System.DateTime?)
Time of last update to any hosting data for this desktop reported by the hypervisor connection.
-- MachineName (System.String)
DNS host name of the machine associated with the desktop.
-- 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.
-- 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.
-- RegistrationState (Citrix.Broker.Admin.SDK.RegistrationState)
Indicates the registration state of the desktop. Possible values are: Unregistered, Initializing, Registered, AgentError.
-- SID (System.String)
The security identifier of the shared desktop.
-- Uid (System.Int32)
The uid of the shared desktop.
-- WillShutdownAfterUse (System.Boolean)
Flag indicating whether this desktop is tainted and will be shutdown 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.