New-BrokerAutoTagRule

Last published : Oct 31, 2026
Introduced in: Citrix Virtual Apps and Desktop 7 2109
Creates a new AutoTagRule.
Related information
about_Broker_AccessPolicy

Syntax

New-BrokerAutoTagRule
   [-Description <String>]
   [-Name] <String>
   -ObjectType <String>
   -RuleText <String>
   -TagUid <Int32>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

Creates an AutoTagRule which defines a rule to select objects to assign (or remove) a Tag to (or from).

Examples

EXAMPLE 1

Creates a new rule for the "MyExample" tag.
$tag = New-BrokerTag -Name MyExample
New-BrokerAutoTagRule -Name RandomAllocatedCatalogs -TagUid $tag.Uid -ObjectType Catalog -RuleText "-AllocationType Random"

Parameters

-Name

The rule name.
Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Length range: 1 to 255
Disallowed characters: /;:#.*?=<>\|[]()"'` and all ASCII control characters

-ObjectType

The object type on which the rule is applied.
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-RuleText

Rule in the text format.
Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-TagUid

The Tag Uid this rule applies to.
Type: Int32
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Description

The Description of rule.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-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

None

Input cannot be piped to this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.AutoTagRule

Outputs the AutoTagRule object.