Skip to content

Remove-BrokerTagMetadata

Deletes Tag Metadata from the Tag objects

Syntax

Remove-BrokerTagMetadata [-InputObject] <Tag[]> -Name <String> [-LoggingId <Guid>] [-AdminClientIP <String>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

Detailed Description

The Remove-BrokerTagMetadata cmdlet deletes Metadata from the Tag objects.

Parameters

Name Description Required? Pipeline Input Default Value
InputObject Specifies the Tag object's instance whose Metadata is to be deleted. true true (ByValue)
Name Specifies the name of the Metadata to be deleted true 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. false false
AdminClientIP Internal use only. 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.Brokertag

You can pipe the Tag to delete the metadata.

Return Values

None

Examples

Example 1

C:\PS> Remove-BrokerTagMetadata -InputObject $obj-Uid -Name "MyMetadataName"

Description

This command deletes the Metadata "MyMetadataName" key-value pair for the Tag whose instance is pointed by \$obj-Uid

Example 2

C:\PS> Get-BrokerTag | Remove-BrokerTagMetadata -Name "MyMetadataName"

Description

This command deletes the Metadata "MyMetadataName" key-value pair for all the Tag in the site

Was this article helpful?