Get-BrokerTag

Last published : Oct 31, 2026
Gets one or more tags.
Related information
about_Broker_AccessPolicy

Syntax

Get-BrokerTag
   [[-Name] <String>]
   [-Description <String>]
   [-IsUsedByGpo <Boolean>]
   [-Metadata <String>]
   [-ScopeId <Guid>]
   [-ScopeName <String>]
   [-UUID <Guid>]
   [-ApplicationUid <Int32>]
   [-ApplicationGroupUid <Int32>]
   [-CatalogUid <Int32>]
   [-DesktopUid <Int32>]
   [-DesktopGroupUid <Int32>]
   [-EntitlementPolicyRuleUid <Int32>]
   [-MachineUid <Int32>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Get-BrokerTag
   [-Uid] <Int32>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

Gets tags that match all of the supplied criteria.
-------------------------- BrokerTag Object
The BrokerTag object represents a single instance of a Tag associated to other objects. It contains the following properties:
  • Description (System.String)
    Description of the tag
  • IsUsedByGpo (System.Boolean?)
    Indicate if the tag is used by group policy
  • MetadataMap (System.Collections.Generic.Dictionary\&lt;string, string\>)
    The metadata for this command.
  • Name (System.String)
    The name of the Tag
  • Scopes (Citrix.Fma.Sdk.DelegatedAdminInterfaces.ScopeReference\[\])
    The list of the delegated admin scopes to which the tag belongs.
  • Uid (System.Int32)
    The Uid of the Tag
  • UUID (System.Guid)
    The UUID associated to the Tag

Examples

EXAMPLE 1

Enumerate all tags.
Get-BrokerTag

EXAMPLE 2

Get a single specific tag with a Uid of 5.
Get-BrokerTag -Uid 5

EXAMPLE 3

Get tags associated with machine DOMAIN\Machine.
$machine = Get-BrokerMachine DOMAIN\Machine
Get-BrokerTag -MachineUid $machine.Uid

Parameters

-Uid

Gets the tag identified by Uid
Type: Int32
Position: 2
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Name

Gets tags that match the specified name.
Type: String
Position: 2
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-Description

Gets tags with the specified description.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-IsUsedByGpo

Gets tags that are used by group policy.
Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2003

-Metadata

Gets records with matching metadata entries.
The value being compared with is a concatenation of the key name, a colon, and the value. For example: -Metadata "abc:x*" matches records with a metadata entry having a key name of "abc" and a value starting with the letter "x".
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ScopeId

Gets tags that are associated with the given scope identifier.
Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2212

-ScopeName

Gets tags that are associated with the given scope name.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True
Introduced in: Citrix Virtual Apps and Desktop 7 2212

-UUID

Gets tags associated with a given UUID.
Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ApplicationUid

Gets tags associated with the specified application.
Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ApplicationGroupUid

Get tags associated with the specified application group.
Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-CatalogUid

Gets tags associated with the specified catalog.
Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-DesktopUid

Gets tags associated with the specified desktop.
Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-DesktopGroupUid

Gets tags associated with the specified desktop group.
Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-EntitlementPolicyRuleUid

Gets tags associated with the specified entitlement policy rule.
Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

-MachineUid

Gets tags associated with the specified machine.
Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ReturnTotalRecordCount

When specified, this causes the cmdlet to output an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Broker_Filtering for details.
Type: SwitchParameter
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-MaxRecordCount

Specifies the maximum number of records to return.
Type: Int32
Position: Named
Default value: 250
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Skip

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.
Type: Int32
Position: Named
Default value: 0
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SortBy

Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.
Type: String
Position: Named
Default value: The default sort order is by name or unique identifier.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-FilterScope

Gets only results allowed by the specified scope id.
Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2106

-Property

Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server.
Type: String[]
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

None

Input cannot be piped to this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.Tag

Returns matching tags.