Product Documentation

Remove-BrokerTag

Nov 06, 2015

Removes a tag from the system or clears a tag to object association.

Syntax

Remove-BrokerTag [-InputObject] <Tag[]> [-Desktop <Desktop>] [-DesktopGroup <DesktopGroup>] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

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

Detailed Description

Clears tag to object associations or delete tags from the system altogether.

To clear an association, supply one of the Application, DesktopGroup or PrivateDesktop parameters.

To delete the tag, and any associations between the tag and other objects in the database, specify the tag without any associated object parameters.

Parameters

-InputObject<Tag[]>

Specifies one or more tag objects.

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

-Name<String>

Specifies a tag by name.

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

-Desktop<Desktop>

Clears the association between the given tag and Desktop.

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

-DesktopGroup<DesktopGroup>

Clears the association between the given tag and desktop group.

Required? false
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.Tag Tags may be specified through pipeline input.

Return Values

None

Examples

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

C:\PS> Remove-BrokerTag $tag -Desktop $desktop

Clears the association between a tag and a desktop. Note that the tag itself continues to exist as an object in the database.

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

C:\PS> Remove-BrokerTag $tag

Deletes the tag object from the database and clears any associations that may exist between that tag and other objects.