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

Get-BrokerMachine [[-MachineName] <String>] [-AgentVersion <String>] [-AllocationType <AllocationType>] [-ApplicationInUse <String>] [-AssignedClientName <String>] [-AssignedIPAddress <String>] [-AssignedUserSID <String>] [-AssociatedTenantId <Guid>] [-AssociatedUserFullName <String>] [-AssociatedUserName <String>] [-AssociatedUserSID <String>] [-AssociatedUserUPN <String>] [-BrowserName <String>] [-CatalogName <String>] [-CatalogUid <Int32>] [-CatalogUUID <Guid>] [-CbpVersion <CBPVersion>] [-ColorDepth <ColorDepth>] [-ControllerDNSName <String>] [-DeliveryType <DeliveryType>] [-Description <String>] [-DesktopCondition <String>] [-DesktopGroupName <String>] [-DesktopGroupUid <Int32>] [-DesktopGroupUUID <Guid>] [-DesktopKind <DesktopKind>] [-DesktopUid <Int32>] [-DNSName <String>] [-FaultState <MachineFaultState>] [-FunctionalLevel <FunctionalLevel>] [-HostedMachineId <String>] [-HostedMachineName <String>] [-HostingServerName <String>] [-HypervisorConnectionName <String>] [-HypervisorConnectionUid <Int32>] [-HypHypervisorConnectionUid <Guid>] [-IconUid <Int32>] [-ImageOutOfDate <Boolean>] [-InMaintenanceMode <Boolean>] [-IPAddress <String>] [-IsAssigned <Boolean>] [-IsPhysical <Boolean>] [-IsReserved <Boolean>] [-LastConnectionFailure <ConnectionFailureReason>] [-LastConnectionTime <DateTime>] [-LastConnectionUser <String>] [-LastDeregistrationReason <DeregistrationReason>] [-LastDeregistrationTime <DateTime>] [-LastErrorReason <String>] [-LastErrorTime <DateTime>] [-LastHostingUpdateTime <DateTime>] [-LastPvdErrorReason <String>] [-LastPvdErrorTime <DateTime>] [-LoadIndex <Int32>] [-MachineInternalState <MachineInternalState>] [-Metadata <String>] [-OSType <String>] [-OSVersion <String>] [-PersistUserChanges <PersistUserChanges>] [-PowerActionPending <Boolean>] [-PowerState <PowerState>] [-ProvisioningType <ProvisioningType>] [-PublishedApplication <String>] [-PublishedName <String>] [-PvdEstimatedCompletionTime <DateTime>] [-PvdPercentDone <Int32>] [-PvdStage <PvdStage>] [-PvdUpdateStartTime <DateTime>] [-RegistrationState <RegistrationState>] [-ScheduledReboot <ScheduledReboot>] [-SecureIcaRequired <Boolean>] [-SessionAutonomouslyBrokered <Boolean>] [-SessionClientAddress <String>] [-SessionClientName <String>] [-SessionClientVersion <String>] [-SessionConnectedViaHostName <String>] [-SessionConnectedViaIP <String>] [-SessionCount <Int32>] [-SessionDeviceId <String>] [-SessionHardwareId <String>] [-SessionHidden <Boolean>] [-SessionKey <Guid>] [-SessionLaunchedViaHostName <String>] [-SessionLaunchedViaIP <String>] [-SessionProtocol <String>] [-SessionSecureIcaActive <Boolean>] [-SessionsEstablished <Int32>] [-SessionSmartAccessTag <String>] [-SessionsPending <Int32>] [-SessionStartTime <DateTime>] [-SessionState <SessionState>] [-SessionStateChangeTime <DateTime>] [-SessionSupport <SessionSupport>] [-SessionType <SessionType>] [-SessionUid <Int64>] [-SessionUserName <String>] [-SessionUserSID <String>] [-SID <String>] [-SummaryState <DesktopSummaryState>] [-SupportedPowerActions <String[]>] [-Tag <String>] [-UUID <Guid>] [-VMToolsState <VMToolsState>] [-WillShutdownAfterUse <Boolean>] [-WindowsConnectionSetting <WindowsConnectionSetting>] [-ZoneName <String>] [-ZoneUid <Guid>] [-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 machine.

-- AllocationType (Citrix.Broker.Admin.SDK.AllocationType)
   Describes how the machine is allocated to the user, can be Permanent or Random.

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

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

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

-- AssignedUserSIDs (System.String[])
   The SIDs of the users that have been assigned to the machine (private machines only).

-- AssociatedTenantId (System.Guid?)
   Tenant associated with the machine. Once a tenant is associated with a machine it can only host sessions for that tenant and no other. Tenant associations are transient and are cleared when the machine's image is reset.

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

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

-- AssociatedUserSIDs (System.String[])
   The SIDs of the users that have been associated with the machine.
   Associated users are the current user(s) for shared machines and the assigned users for private machines.

-- AssociatedUserUPNs (System.String[])
   The User Principal Names of the users associated with the machine (in the form user@domain).
   Associated users are the current user(s) for shared machines and the assigned users for private machines.

-- BrowserName (System.String)
   Site-wide unique name identifying associated desktop to other components (for example StoreFront). This is typically non-null only for machines backing assigned private desktops.

-- Capabilities (System.String[])
   List of the capabilities that the machine supports. Valid capabilities are:
   o MultiSession: Indicates an RDS- (Terminal Services-) based machine, which supports multiple active sessions from different users.
   o CBP1_5: Indicates the machine can use the CBP 1.5 protocol for communication.

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

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

-- CatalogUUID (System.Guid)
   UUID of the catalog the machine is a member of.

-- CbpVersion (Citrix.Broker.Admin.SDK.CBPVersion?)
   The version of CBP that the VDA is currently registered with. This will be null when the VDA is not registered.

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

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

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

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

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

-- DesktopGroupName (System.String)
   Name of the desktop group the machine is a member of.

-- DesktopGroupUid (System.Int32?)
   UID of the desktop group the machine is a member of.

-- DesktopGroupUUID (System.Guid?)
   UUID of the desktop group the machine is a member of.

-- DesktopKind (Citrix.Broker.Admin.SDK.DesktopKind?)
   Deprecated.
   Denotes whether the machine is private or shared. Use AllocationType instead.

-- DesktopUid (System.Int32?)
   The UID of the associated desktop object.

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

-- FaultState (Citrix.Broker.Admin.SDK.MachineFaultState)
   Summary state of any current fault state of the machine. Can be one of the following:
   o None - No fault; machine is healthy.
   o FailedToStart - Last power-on operation for machine failed.
   o StuckOnBoot - Machine does not seem to have booted following power on.
   o Unregistered - Machine has failed to register within expected period, or its registration has been rejected.
   o MaxCapacity - Machine is reporting itself at maximum capacity.

-- FunctionalLevel (Citrix.Broker.Admin.SDK.FunctionalLevel?)
   Functional level of the machine, if known.

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

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

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

-- HypervisorConnectionName (System.String)
   The name of the hypervisor connection that the machine has been assigned to, if managed.

-- HypervisorConnectionUid (System.Int32?)
   The UID of the hypervisor connection that the machine’s hosting server is accessed through.

-- HypHypervisorConnectionUid (System.Guid?)
   The UUID of the hypervisor connection that the machine’s hosting server is accessed through

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

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

-- InMaintenanceMode (System.Boolean)
   Denotes if the machine is in maintenance mode.

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

-- 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 machine.

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

-- IsReserved (System.Boolean)
   Indicates if machine is reserved for special use, for example for AppDisk preparation. A reserved machine cannot be a member of a desktop group.

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

-- 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 machine. 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 machine 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 machine from the controller.

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

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

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

-- LastPvdErrorReason (System.String)
   The error text from the most recent failure of the Personal vDisk preparation process for this machine (if any).

-- LastPvdErrorTime (System.DateTime?)
   The time of the most recent failure of the Personal vDisk preparation process for this machine (if any).

-- LoadIndex (System.Int32?)
   Gives current effective load index for multi-session machines.

-- LoadIndexes (System.String[])
   Gives the last reported individual load indexes that were used in the calculation of the LoadIndex value. Note that the LoadIndex value may have been subsequently adjusted due to session brokering operations. This value is only set for multi-session machines.

-- MachineInternalState (Citrix.Broker.Admin.SDK.MachineInternalState)
   The internal state of the machine; reported while the machine 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.

-- MetadataMap (System.Collections.Generic.Dictionary<string, string>)
   Any metadata that is associated with the machine.

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

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

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

-- PowerActionPending (System.Boolean)
   Indicates if there are any pending power actions for the machine.

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

-- ProvisioningType (Citrix.Broker.Admin.SDK.ProvisioningType)
   Describes how the machine 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 machine (displayed as browser names).

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

-- PvdEstimatedCompletionTime (System.DateTime?)
   If preparation of the Personal vDisk is currently in progress for this machine, this reports an estimation of the time at which the process will be complete.

-- PvdPercentDone (System.Int32?)
   If preparation of the Personal vDisk is currently in progress for this machine, this reports how far the process has got as a percentage. This value will be zero if preparation is not in progress.

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

-- PvdUpdateStartTime (System.DateTime?)
   If preparation of the Personal vDisk is currently in progress for this machine, this reports when the update process began.

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

-- ScheduledReboot (Citrix.Broker.Admin.SDK.ScheduledReboot)
   Indicates the state of any scheduled reboot operation for a machine. Possible values:
   o None: No reboot is scheduled.
   o Pending: Machine is awaiting reboot but is available for use.
   o Draining: Machine is awaiting reboot and is unavailable for new sessions; reconnections to existing connections are still allowed, however.
   o InProgress: Machine is actively undergoing a scheduled reboot. o Natural: Natural reboot in progress. Machine is awaiting a restart.

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

-- SessionAutonomouslyBrokered (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 machines.

-- SessionClientAddress (System.String)
   Session property indicating the IP address of the client connected to the machine.
   Session properties are always null for multi-session machines.

-- SessionClientName (System.String)
   Session property indicating the host name of the client connected to the machine.
   Session properties are always null for multi-session machines.

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

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

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

-- SessionCount (System.Int32)
   Count of number of sessions on the machine.

-- SessionDeviceId (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 machines.

-- SessionHardwareId (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-session machines.

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

-- SessionKey (System.Guid?)
   Session property indicating the key of the current session.
   Session properties are always null for multi-session machines.

-- SessionLaunchedViaHostName (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 machines.

-- SessionLaunchedViaIP (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 machines.

-- SessionProtocol (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 machines.

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

-- SessionsEstablished (System.Int32)
   Number of established sessions on this machine. For multi-session machines this excludes established sessions which have not yet completed their logon processing.

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

-- SessionsPending (System.Int32)
   Number of pending (brokered but not yet established) sessions on this machine. For multi-session machines this also includes established sessions which have not yet completed their logon processing.

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

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

-- 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 machines.

-- SessionSupport (Citrix.Broker.Admin.SDK.SessionSupport)
   Indicates the session support of the machine.
   Possible values:
   o SingleSession: Single-session only machine.
   o MultiSession: Multi-session capable machine.

-- SessionType (Citrix.Broker.Admin.SDK.SessionType?)
   Session property indicating the type of the current session.
   Session properties are always null for multi-session machines.

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

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

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

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

-- SummaryState (Citrix.Broker.Admin.SDK.DesktopSummaryState)
   Indicates the overall state of the desktop associated with the machine. 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.

-- SupportedPowerActions (System.String[])
   A list of power actions supported by this machine.

-- Tags (System.String[])
   A list of tags associated with the machine.

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

-- UUID (System.Guid)
   UUID of the machine object.

-- VMToolsState (Citrix.Broker.Admin.SDK.VMToolsState)
   State of the hypervisor tools present on the VM (if any).
   Possible values are:
   NotPresent, Unknown, NotStarted, Running.

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

-- WindowsConnectionSetting (Citrix.Broker.Admin.SDK.WindowsConnectionSetting?)
   The logon mode reported by Windows itself (multi-session machines only). For single-session machines the value is always hardwired to LogonEnabled.
   Possible values are:
   LogonEnabled, Draining, DrainingUntilRestart and LogonDisabled.

-- ZoneName (System.String)
   The name of the zone in which the machine is located.

-- ZoneUid (System.Guid)
   The UID of the zone in which the machine is located.

C:\PS> Get-BrokerMachine -PowerState Suspended
C:\PS> Get-BrokerMachine -Filter { PowerState -eq 'Suspended' }

C:\PS> Get-BrokerMachine -DNSName '*.mydomain.mycompany.com'

C:\PS> Get-BrokerMachine -Filter { RegistrationState -eq 'Registered' -and HypervisorConnectionUid -eq 5 }

C:\PS> Get-BrokerMachine -MachineName 'MyDomain\X*' | Remove-BrokerDesktopGroup 2

C:\PS> Get-BrokerMachine -Filter { DesktopGroupUid -ne $null }