Citrix Virtual Apps and Desktops SDK

Remove-BrokerTag

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

Syntax

Remove-BrokerTag
      [-InputObject] <Tag[]>
      [-Force]
      [-Application <Application>]
      [-ApplicationGroup <ApplicationGroup>]
      [-Catalog <Catalog>]
      [-Desktop <Desktop>]
      [-DesktopGroup <DesktopGroup>]
      [-Machine <Machine>]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->
Remove-BrokerTag
      [-Force]
      [-Name] <String>
      [-Application <Application>]
      [-ApplicationGroup <ApplicationGroup>]
      [-Catalog <Catalog>]
      [-Desktop <Desktop>]
      [-DesktopGroup <DesktopGroup>]
      [-Machine <Machine>]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->
Remove-BrokerTag
      [-Tags] <Tag[]>
      [-AllApplications]
      [-AllApplicationGroups]
      [-AllDesktops]
      [-AllDesktopGroups]
      [-AllCatalogs]
      [-AllMachines]
      [-AllObjects]
      [-Force]
      [-Application <Application>]
      [-ApplicationGroup <ApplicationGroup>]
      [-Catalog <Catalog>]
      [-Desktop <Desktop>]
      [-DesktopGroup <DesktopGroup>]
      [-Machine <Machine>]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

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

Remove-BrokerTag $tag -Machine $machine
<!--NeedCopy-->

EXAMPLE 2

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

Remove-BrokerTag $tag
<!--NeedCopy-->

Parameters

-Tags

Specifies one or more tag objects.

Type: Tag[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-InputObject

Specifies one or more tag objects.

Type: Tag[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Specifies a tag by name.

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-AllApplications

Remove the specified tags from all applications.

Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AllApplicationGroups

Remove the specified tags from all application groups.

Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AllDesktops

Remove the specified tags from all desktops.

Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AllDesktopGroups

Remove the specified tags from all desktop groups.

Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AllCatalogs

Remove the specified tags from all catalogs.

Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AllMachines

Remove the specified tags from all machines.

Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AllObjects

Remove the specified tags from all objects.

Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Force

Remove tags even if they are used by group policy.

Type: SwitchParameter
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2311

-Application

Removes the association between the given tag and application.

Type: Application
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ApplicationGroup

Removes the association between the given tag and application group.

Type: ApplicationGroup
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Catalog

Removes the association between the given tag and the catalog group.

Type: Catalog
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Desktop

Removes the association between the given tag and desktop.

Type: Desktop
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-DesktopGroup

Removes the association between the given tag and desktop group.

Type: DesktopGroup
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Machine

Removes the association between the given tag and machine.

Type: Machine
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.Tag

Tags may be specified through pipeline input.

Outputs

None

By default, this cmdlet returns no output.

Remove-BrokerTag