Product Documentation

Remove-BrokerMachineCommand

Sep 29, 2015

Cancel a pending command queued for delivery to a desktop.

Syntax

Remove-BrokerMachineCommand [-InputObject] <MachineCommand[]> [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

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

Parameters

-InputObject<MachineCommand[]>

Commands to cancel.

Required? true
Default Value  
Accept Pipeline Input? true (ByValue)

-LoggingId<Guid>

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.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminAddress<String>

Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value will become the default.
Accept Pipeline Input? false

Input Type

Citrix.Broker.Admin.SDK.MachineCommand Commands to cancel.

Return Values

None

Examples

-------------------------- EXAMPLE 1 --------------------------

Get-BrokerMachineCommand | Remove-BrokerMachineCommand

Cancel all pending commands.

-------------------------- EXAMPLE 2 --------------------------

Get-BrokerMachineCommand -Category "UPM" | Remove-BrokerMachineCommand

Cancel all pending commands that have the category "UPM".