Citrix Virtual Apps and Desktops SDK

Remove-BrokerMachineCommand

Cancel a pending command queued for delivery to a desktop.

Syntax

Remove-BrokerMachineCommand
      [-InputObject] <MachineCommand[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Sets the state of a pending command queued for delivery to a desktop to Canceled. The command is not removed from the system.

Examples

EXAMPLE 1

Cancel all pending commands.

Get-BrokerMachineCommand | Remove-BrokerMachineCommand
<!--NeedCopy-->

EXAMPLE 2

Cancel all pending commands that have the category “UPM”.

Get-BrokerMachineCommand -Category "UPM" | Remove-BrokerMachineCommand
<!--NeedCopy-->

Parameters

-InputObject

Commands to cancel.

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

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

Commands to cancel.

Outputs

None

By default, this cmdlet returns no output.

Remove-BrokerMachineCommand