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

Remove-BrokerHostingPowerAction

April 19, 2024
Contributed by: 
C

Cancel one or more pending power actions.

Syntax

Remove-BrokerHostingPowerAction
      [-InputObject] <HostingPowerAction[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Remove-BrokerHostingPowerAction
      [-MachineName] <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Causes one or more of the pending power actions in the queue to be marked as canceled. The affected power actions are not sent to the hypervisor for processing, and take no further part in the queuing activity.

Power actions cannot be canceled once they have started to be processed by the hypervisor.

Examples

EXAMPLE 1

Cancels any pending power actions for the machine called ‘XD_VDA1’.

Remove-BrokerHostingPowerAction -MachineName 'XD_VDA1'
<!--NeedCopy-->

EXAMPLE 2

Cancels any pending power actions requested in the last five minutes.

Get-BrokerHostingPowerAction -Filter { State -eq "Pending" -and RequestTime -gt "-00:05" } | Remove-BrokerHostingPowerAction
<!--NeedCopy-->

Parameters

-InputObject

The power action to be canceled.

Type: HostingPowerAction[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-MachineName

Cancels only actions for machines whose name (of the form domain\machine) matches the specified string.

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-LoggingId

Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

Type: Guid
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

Citrix.Broker.Admin.SDK.HostingPowerAction

The power action to be canceled.

Outputs

None

By default, this cmdlet returns no output.

Remove-BrokerHostingPowerAction
April 19, 2024
Contributed by: 
C
April 19, 2024
Contributed by: 
C

In this article

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