Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Get-BrokerMachineStatus

March 11, 2024
Contributed by: 
C

Gets detailed machine brokering and power management status

Syntax

Get-BrokerMachineStatus
   [[-MachineName] <String>]
   [-CatalogUid <Int32>]
   [-DesktopGroupUid <Int32>]
   [-IdlePoolStatus <String>]
   [-LaunchReadiness <String>]
   [-Sid <String>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Get-BrokerMachineStatus
   [-Uid] <Int32>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The Get-BrokerMachineStatus cmdlet retrieves detailed internal status of machines relating to their readiness to accept new sessions or undertake power management operations. This information is for diagnostic purposes only.

————————– BrokerMachineStatus Object

Each machine status object returned represents the detailed status of a physical or virtual machine configured in the site with respect to its readiness for brokering or power management.

  • CatalogUid (System.Int32)

    The UID of the catalog containing the machine.

  • CurrentSessions (System.Int32)

    The number of currently established sessions on the machine.

  • DesktopGroupUid (System.Int32?)

    The UID of the desktop group containing the machine.

  • DoNotShutdownBefore (System.DateTime)

    Time before which machine should not be shutdown by automatic power management.

  • DrainingUntilReboot (System.Boolean)

    Whether no new sessions can be started on the machine as it is drained of sessions pending a reboot as part of a reboot cycle.

  • DrainingUntilShutdown (System.Boolean)

    Whether no new sessions can be started on the machine as it is drained of sessions pending a shutdown.

  • EffectiveLoadIndex (System.Int32?)

    The machine’s effective load index (0 - 10000, RDS only).

  • FreeSessions (System.Int32)

    The number of additional sessions the machine can accept before it reaches its configured session limit (always 0 or 1 for VDI machines).

  • HasPendingPowerActions (System.Boolean)

    Whether the machine currently has outstanding, not yet started or completed, power actions.

  • HasRegisteredInPeakTime (System.Boolean)

    Machine has registered in current peak time period.

  • HasRegisteredSinceOutage (System.Boolean)

    Machine has registered since last recorded site outage.

  • HypervisorInMaintenanceMode (System.Boolean)

    Whether the machine’s hypervisor connection (if any) is in maintenance mode.

  • IdlePoolStatus (System.String)

    Status of machine with respect to possible idle pool power management operations.

  • IdleTimeBeforeUsageSecs (System.Int32?)

    Number of seconds for which the machine should ideally be left idle before it is selected for a new session (for example, after registration).

  • ImageOutOfDate (System.Boolean)

    Whether the MCS master disk image currently being used by the machine is out of date.

  • InMaintenanceMode (System.Boolean)

    Whether the machine is currently in maintenance mode.

  • LastIdlePeriodStartTime (System.DateTime)

    Start time of the last idle period (see IdleTimeBeforeUsageSecs).

  • LastPowerManagementActionUid (System.Int64?)

    UID of last power management action performed by this machine (persists after action has completed).

  • LastPowerOnTime (System.DateTime)

    Time at which machine was last seen to power on.

  • LastShutdownTime (System.DateTime)

    Time at which machine was last seen to power off.

  • LastUserDrivenResetTime (System.DateTime)

    Time of last user ‘restart’ operation requested via CWA/SF.

  • LaunchReadiness (System.String)

    Summary state of the machine’s readiness to accept a new session.

  • LogonsInProgress (System.Int32?)

    The number of session logons currently in progress on the machine (RDS only).

  • MachineFaultState (System.String)

    Indicates any diagnostic fault state of the machine, or None otherwise.

  • MachineName (System.String)

    The name of the machine (domaine ame).

  • NeedsStart (System.Boolean)

    Whether the machine will be restarted when next convenient (a ‘natural’ reboot).

  • NeedsStartReason (System.String)

    Reason why the machine will be restarted when next convenient (if any).

  • PendingSessions (System.Int32)

    Number of outstanding sessions brokered to the machine that have not yet been established (client has not connected to the machine).

  • PowerManagementActionUid (System.Int64?)

    UID of any power management action currently in progress for this machine.

  • PowerOffExpectedSoonAfter (System.DateTime?)

    When not null and machine is On, time of last Shutdown/PowerOff action completed by machine and indicates that it should power off soon.

  • PowerSinBinReleaseTime (System.DateTime?)

    If set, time after which automatic pool management may attempt to power on machine again following an earlier failure during power on.

  • PowerState (System.String)

    The last reported power state of the machine.

  • RebootCycleUid (System.Int64?)

    UID of any reboot cycle in which the machine is currently participating.

  • SessionSupport (System.String)

    Whether the machine is a VDI (single session) or RDS (multi-session) machine.

  • Sid (System.String)

    The Windows SID of the machine.

  • SinBinReleaseTime (System.DateTime?)

    When set, indicates that the machine can not be selected for new sessions until the indicated time due to an earlier power management problem.

  • TagUid (System.String[])

    List of tags associated with the machine (if any).

  • TenantId (System.Guid?)

    Tenant ID associated with the machine (if any).

  • Uid (System.Int32)

    The UID of the machine.

  • Usage (System.String)

    The CVAD allocation type applicable to the machine.

  • UserForcedLogOffGracePeriodExpiryTime (System.DateTime?)

    If set, time at which Autoscale will forcibly logoff remaining sessions on machine if users have not already logged off.

  • UseVerticalScaling (System.Boolean?)

    If set, indicates that vertical load balancing is in use for machines in this desktop group.

  • UseVerticalScalingForRdsLaunches (System.Boolean)

    Specifies the default for the site as to whether horizontal or vertical load balancing is in use for multi-session machines.

  • WillShutdownAfterUse (System.Boolean)

    Whether the machine must be shutdown after current session ends.

  • WillShutdownAfterUseReason (System.String)

    Reason why the machine must be shutdown after current session ends (if any).

  • WindowsConnectionSetting (System.String)

    The Windows ConnectionSetting value reported on the machine (RDS only).

  • WorkerState (System.String)

    Internal machine state.

  • ZoneHealthy (System.Boolean)

    Whether the machine’s zone is currently considered healthy.

  • ZoneUid (System.Guid)

    The zone in which the machine resides.

Examples

Parameters

-Uid

Get status details of the machine with the specified UID.

Type: Int32
Position: 2
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-MachineName

Gets status details of machines having a name matching that specified.

Type: String
Position: 2
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-CatalogUid

Gets status details of machines in the specified catalog.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-DesktopGroupUid

Gets status details of machines in the specified desktop group.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-IdlePoolStatus

Gets status details of machines with the specified idle pool status.

Type: String
Accepted values: CanDrainAvailable, CanShutdownAvailable, CanShutdownUnregistered, CanShutdownUsed, CanStartup, Ignore
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-LaunchReadiness

Gets status detais of machines with the specified launch readiness.

Type: String
Accepted values: Draining, Later, Never, NotApplicable, Now, Soon
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Sid

Gets status details of the machine with the specified SID.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-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

-Property

Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server.

Type: String[]
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 can’t pipe objects to this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.GetBrokerMachineStatus

Get-BrokerMachineStatus returns an object for each selected machine.

Get-BrokerMachineStatus
March 11, 2024
Contributed by: 
C
March 11, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.