Get-BrokerDelayedHostingPowerAction

Last published : Oct 31, 2026
Gets power actions that are executed after a delay.
Related information
about_Broker_AccessPolicy

Syntax

Get-BrokerDelayedHostingPowerAction
   [[-MachineName] <String>]
   [-Action <PowerManagementAction>]
   [-ActionDueTime <DateTime>]
   [-DNSName <String>]
   [-HostedMachineName <String>]
   [-HypervisorConnectionName <String>]
   [-HypervisorConnectionUid <Int32>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Get-BrokerDelayedHostingPowerAction
   [-Uid] <Int64>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

Finds all delayed power actions that match the specified search criteria.
-------------------------- BrokerDelayedHostingPowerAction Object
The BrokerDelayedHostingPowerAction object represents an instance of a power action that is executed after a delay. It contains the following properties:
  • Action (Citrix.Broker.Admin.SDK.PowerManagementAction)
    The power action to apply to the machine. Possible values are ShutDown and Suspend.
  • ActionDueTime (System.DateTime)
    The UTC time at which the power action is due to be queued for execution.
  • DNSName (System.String)
    The fully qualified DNS name of the machine that the power action applies to.
  • HostedMachineName (System.String)
    The hypervisor's name for the machine that the power action applies to.
  • HypervisorConnectionUid (System.Int32)
    The unique identifier of the hypervisor connection that is associated with the target machine.
  • MachineName (System.String)
    The name of the machine that the power action applies to, in the form domain\machine.
  • Uid (System.Int64)
    The unique identifier of the power action.

Examples

EXAMPLE 1

Fetches records for all known delayed power actions that have not yet been queued for execution.
Get-BrokerDelayedHostingPowerAction

Parameters

-Uid

Gets only the single action record whose ID matches the specified value.
Type: Int64
Position: 2
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-MachineName

Gets only the records for actions that are for machines whose name (of the form domain\machine) matches the specified string.
Type: String
Position: 2
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-Action

Gets only the records for actions with the specified action type.
Valid values are Shutdown and Suspend.
Type: PowerManagementAction
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ActionDueTime

Gets only the records for actions due to be queued for execution at the specified time. This is useful with advanced filtering; for more information, see about_Broker_Filtering.
Type: DateTime
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-DNSName

Gets only the records for actions that are for machines whose DNS name matches the specified string.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-HostedMachineName

Gets only the records for actions that are for machines whose Hosting Name (the machine name as understood by the hypervisor) matches the specified string.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-HypervisorConnectionName

Gets only the records for actions for machines hosted through a hypervisor connection whose name matches the specified string.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-HypervisorConnectionUid

Gets only the records for actions for machines hosted through a hypervisor connection whose ID matches the specified value.
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

-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 cannot pipe input into this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.DelayedHostingPowerAction

Get-BrokerDelayedHostingPowerAction returns all delayed power actions that match the specified selection criteria.