Citrix Virtual Apps and Desktops SDK

Remove-BrokerDelayedHostingPowerAction

Cancels one or more delayed power actions.

Syntax

Remove-BrokerDelayedHostingPowerAction
      [-InputObject] <DelayedHostingPowerAction[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->
Remove-BrokerDelayedHostingPowerAction
      [-MachineName] <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Removes one or more delayed power actions that have not yet been queued for execution.

Examples

EXAMPLE 1

Cancels any pending delayed power actions for the machine called XD_VDA1.

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

Parameters

-InputObject

The power action to be cancelled.

Type: DelayedHostingPowerAction[]
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.DelayedHostingPowerAction

The power action to be cancelled.

Outputs

None

By default, this cmdlet returns no output.

Remove-BrokerDelayedHostingPowerAction