Add-BrokerTag
Associate a tag with another object in the site.
Syntax
Add-BrokerTag
[-InputObject] <Tag[]>
[-Application <Application[]>]
[-ApplicationGroup <ApplicationGroup[]>]
[-Catalog <Catalog[]>]
[-EntitlementPolicyRule <EntitlementPolicyRule[]>]
[-Desktop <Desktop[]>]
[-DesktopGroup <DesktopGroup[]>]
[-Machine <Machine[]>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Add-BrokerTag
[-Name] <String>
[-Application <Application[]>]
[-ApplicationGroup <ApplicationGroup[]>]
[-Catalog <Catalog[]>]
[-EntitlementPolicyRule <EntitlementPolicyRule[]>]
[-Desktop <Desktop[]>]
[-DesktopGroup <DesktopGroup[]>]
[-Machine <Machine[]>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Associates one or more tags with a machine, application group, application, desktop group or desktop within the site.
Examples
EXAMPLE 1
Associates 'Tag1' with machine DOMAIN\Machine.
Add-BrokerTag -Name 'Tag1' -Machine DOMAIN\Machine
EXAMPLE 2
Creates a new tag with name 'Tag2' and associates it with the machine with Uid 1.
$machine = Get-BrokerMachine -Uid 1
New-BrokerTag 'Tag2' | Add-BrokerTag -Machine $machine
Parameters
-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 |
-Application
Associates the tag with the specified application.
| Type: | Application[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-ApplicationGroup
Associates the tag with the specified application group.
| Type: | ApplicationGroup[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Catalog
Associates the tag with the specified catalog.
| Type: | Catalog[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-EntitlementPolicyRule
Associates the tag with the specified entitlement policy rule.
| Type: | EntitlementPolicyRule[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
-Desktop
Associates the tag with the specified desktop. The tag is associated with the underlying machine not with the desktop itself.
This parameter is deprecated, use -Machine instead.
| Type: | Desktop[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-DesktopGroup
Associates the tag with the specified desktop group.
| Type: | DesktopGroup[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-Machine
Associates the tag with the specified 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.