Remove-BrokerMachineConfiguration

Last published : Oct 31, 2026
Deletes a machine configuration from the site or removes the association from a desktop group.
Related information
about_Broker_AccessPolicy

Syntax

Remove-BrokerMachineConfiguration
      [-InputObject] <MachineConfiguration[]>
      [-Application <Application>]
      [-DesktopGroup <DesktopGroup>]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
Remove-BrokerMachineConfiguration
      [-Name] <String>
      [-Application <Application>]
      [-DesktopGroup <DesktopGroup>]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]

Description

This cmdlet has three functions:
  • Break associations between desktop groups and machine configurations.
  • Break associations between applications and machine configurations.
  • Remove machine configurations from the system.
If no desktop group or application is specified, then the Remove-BrokerMachineConfiguration cmdlet removes the machine configuration from the site.
If a desktop group is specified, then the Remove-BrokerMachineConfiguration cmdlet removes the association between the machine configuration and that desktop group. In this case, the machine configuration is not removed from the site.
If an application is specified, then the Remove-BrokerMachineConfiguration cmdlet removes the association between the machine configuration and that application. Again, in this case, the machine configuration is not removed from the site.

Examples

EXAMPLE 1

Removes the machine configuration named "UPM\Finance".
Remove-BrokerMachineConfiguration -Name UPM\Finance

EXAMPLE 2

Removes the association of the machine configuration named "Receiver\HumanResources" from the "SharedWorkers" desktop group.
Remove-BrokerMachineConfiguration -Name Receiver\HumanResources -DesktopGroup SharedWorkers

Parameters

-InputObject

Machine configuration to remove.
Type: MachineConfiguration[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Name of machine configuration for which the remove operation applies.
Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-Application

The application from which this machine configuration is to be removed.
Type: Application
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-DesktopGroup

The desktop group from which this machine configuration is to be removed.
Type: DesktopGroup
Position: Named
Default value: None
Required: False
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.MachineConfiguration

Machine configuration to remove

Outputs

None

By default, this cmdlet returns no output.

Notes

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