Citrix Virtual Apps and Desktops SDK

Remove-Brokertag

August 3, 2023

Contributed by:

Removes tag to object associations or deletes tags from the site altogether.

Syntax

Remove-BrokerTag [-Tags] <Tag[]> [-AllApplications] [-AllApplicationGroups] [-AllDesktops] [-AllDesktopGroups] [-AllCatalogs] [-AllMachines] [-AllObjects] [-Application <Application>] [-ApplicationGroup <ApplicationGroup>] [-Catalog <Catalog>] [-Desktop <Desktop>] [-DesktopGroup <DesktopGroup>] [-Machine <Machine>] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

Remove-BrokerTag [-InputObject] <Tag[]> [-Application <Application>] [-ApplicationGroup <ApplicationGroup>] [-Catalog <Catalog>] [-Desktop <Desktop>] [-DesktopGroup <DesktopGroup>] [-Machine <Machine>] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

Remove-BrokerTag [-Name] <String> [-Application <Application>] [-ApplicationGroup <ApplicationGroup>] [-Catalog <Catalog>] [-Desktop <Desktop>] [-DesktopGroup <DesktopGroup>] [-Machine <Machine>] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Removes the association between tags and objects within the site, or deletes tags from the site altogether.

To remove an association, supply one of the Application, Machine, Desktop or DesktopGroup parameters.

To delete a tag entirely, together with any associations between the tag and other objects in the site, specify the tag without any associated object parameter.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
Tags	Specifies one or more tag objects.	true	true (ByValue)
InputObject	Specifies one or more tag objects.	true	true (ByValue)
Name	Specifies a tag by name.	true	true (ByPropertyName)
AllApplications	Remove the specified tags from all applications.	false	false
AllApplicationGroups	Remove the specified tags from all application groups.	false	false
AllDesktops	Remove the specified tags from all desktops.	false	false
AllDesktopGroups	Remove the specified tags from all desktop groups.	false	false
AllCatalogs	Remove the specified tags from all catalogs.	false	false
AllMachines	Remove the specified tags from all machines.	false	false
AllObjects	Remove the specified tags from all objects.	false	false
Application	Removes the association between the given tag and application.	false	true (ByValue)
ApplicationGroup	Removes the association between the given tag and application group.	false	true (ByValue)
Catalog	Removes the association between the given tag and the catalog group.	false	true (ByValue)
Desktop	Removes the association between the given tag and desktop.	false	true (ByValue)
DesktopGroup	Removes the association between the given tag and desktop group.	false	true (ByValue)
Machine	Removes the association between the given tag and machine.	false	true (ByValue)
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.Tag

Tags may be specified through pipeline input.

Return Values

None

Examples

Example 1

C:\PS> Remove-BrokerTag $tag -Machine $machine
<!--NeedCopy-->

Description

Removes the association between a tag and a desktop. The tag itself continues to exist in the site.

Example 2

C:\PS> Remove-BrokerTag $tag
<!--NeedCopy-->

Description

Deletes the tag from the site also removing any associations that may exist between the tag and other objects.

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-Brokertag

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Remove-Brokertag

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.Broker.Admin.Sdk.Tag

Return Values

None

Examples

Example 1

Description

Example 2

Description

In this article