Product Documentation


Oct 12, 2015

Deletes a machine configuration from the site or removes the association from a desktop group.


Remove-BrokerMachineConfiguration [-InputObject] <MachineConfiguration[]> [-DesktopGroup <DesktopGroup>] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Remove-BrokerMachineConfiguration [-Name] <String> [-DesktopGroup <DesktopGroup>] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

The Remove-MachineConfiguration cmdlet deletes machine configurations from the site. A machine configuration cannot be removed while it is applied to a desktop group.

When a desktop group is provided, the Remove-MachineConfiguration cmdlet removes the association between machine configuration and the desktop group. In this case, the machine configuration is not removed from the site.



Machine configuration to remove.

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


Name of machine configuration for which the remove operation applies.

Required? true
Default Value None
Accept Pipeline Input? true (ByPropertyName)


The desktop group from which this machine configuration is to be removed.

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


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


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.MachineConfiguration Machine configuration to remove

Return Values



A machine configuration can only be removed if it is not currently applied to a desktop group.


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

Remove-BrokerMachineConfiguration -Name UPM\Finance

Removes the machine configuration named "UPM\Finance".

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

Remove-BrokerMachineConfiguration -Name Receiver\HumanResources -DesktopGroup SharedWorkers

Removes the association of the machine configuration named "Receiver\HumanResources" from the "SharedWorkers" desktop group.