Citrix Virtual Apps and Desktops SDK

Remove-Brokermachineconfiguration

August 3, 2023

Contributed by:

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

Syntax

Remove-BrokerMachineConfiguration [-InputObject] <MachineConfiguration[]> [-Application <Application>] [-DesktopGroup <DesktopGroup>] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

Remove-BrokerMachineConfiguration [-Name] <String> [-Application <Application>] [-DesktopGroup <DesktopGroup>] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed 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-MachineConfiguration cmdlet removes the machine configuration from the site.

If a desktop group is specified, then the Remove-MachineConfiguration 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-MachineConfiguration cmdlet removes the association between the machine configuration and that application. Again, in this case, the machine configuration is not removed from the site.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
InputObject	Machine configuration to remove.	true	true (ByValue)	None
Name	Name of machine configuration for which the remove operation applies.	true	true (ByPropertyName)	None
Application	The application from which this machine configuration is to be removed.	false	true (ByValue)	None
DesktopGroup	The desktop group from which this machine configuration is to be removed.	false	true (ByValue)	None
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.	false	false
AdminAddress	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.	false	false	Localhost. Once a value is provided by any cmdlet, this value will become the default.
BearerToken	Specifies the bearer token assigned to the calling user	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false

Input Type

Citrix.Broker.Admin.Sdk.Machineconfiguration

Machine configuration to remove

Return Values

None

Notes

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

Examples

Example 1

Remove-BrokerMachineConfiguration -Name UPM\Finance
<!--NeedCopy-->

Description

Removes the machine configuration named “UPM\Finance”.

Example 2

Remove-BrokerMachineConfiguration -Name Receiver\HumanResources -DesktopGroup SharedWorkers
<!--NeedCopy-->

Description

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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Remove-Brokermachineconfiguration

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Remove-Brokermachineconfiguration

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.Broker.Admin.Sdk.Machineconfiguration

Return Values

None

Notes

Examples

Example 1

Description

Example 2

Description

In this article