Get-BrokerAutoTagRule

Last published : Oct 31, 2026
Introduced in: Citrix Virtual Apps and Desktop 7 2109
Gets AutoTagRules that have been defined for this site.
Related information
about_Broker_AccessPolicy

Syntax

Get-BrokerAutoTagRule
   [[-Name] <String>]
   [-Description <String>]
   [-Metadata <String>]
   [-ObjectType <String>]
   [-RuleText <String>]
   [-TagUid <Int32>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Get-BrokerAutoTagRule
   [-Uid] <Int32>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

Retrieves AutoTagRules matching the specified criteria. If no parameters are specified this cmdlet enumerates all catalogs.
See about_Broker_Filtering for information about advanced filtering options.
-------------------------- BrokerAutoTagRule Object
The BrokerAutoTagRule object represents a single instance of an AutoTagRule.
See about_Broker_AutoTagRule for more information.
A BrokerAutoTagRule contains the following properties:
  • Description (System.String)
    Description of the AutoTagRule
  • MetadataMap (System.Collections.Generic.Dictionary\&lt;string, string\>)
    The metadata for the AutoTagRule.
  • Name (System.String)
    The name of the AutoTagRule
  • ObjectType (System.String)
    The object type the rule is applied to.
  • RuleText (System.String)
    The rule in a text format
  • TagUid (System.Int32)
    The Tag Uid this rule sets or removes
  • Uid (System.Int32)
    The Uid of the AutoTagRule

Examples

EXAMPLE 1

Gets the AutoTagRules with the name RandomAllocatedCatalogs
Get-BrokerAutoTagRule -Name RandomAllocatedCatalogs

Parameters

-Uid

Gets the AutoTagRule with the unique identifier.
Type: Int32
Position: 2
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Name

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

-Description

Gets the AutoTagRules that have the specified Description.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-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

-ObjectType

Gets the AutoTagRules that operate on the ObjectType.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-RuleText

Gets the AutoTagRules that have the specified RuleText.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-TagUid

Gets the AutoTagRule associated with the TagUid.
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

-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

You cannot pipe input into this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.AutoTagRule

Get-BrokerAutoTagRule returns matching AutoTagRule objects.