Citrix Virtual Apps and Desktops SDK


Associate a tag with another object in the site.


Add-BrokerTag [-InputObject] <Tag[]> [-Application <Application>] [-ApplicationGroup <ApplicationGroup>] [-Desktop <Desktop>] [-DesktopGroup <DesktopGroup>] [-Machine <Machine>] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [<CommonParameters>]

Add-BrokerTag [-Name] <String> [-Application <Application>] [-ApplicationGroup <ApplicationGroup>] [-Desktop <Desktop>] [-DesktopGroup <DesktopGroup>] [-Machine <Machine>] [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [<CommonParameters>]

Detailed Description

Associates one or more tags with a machine, application group, application, desktop group or desktop within the site.


Name Description Required? Pipeline Input Default Value
InputObject Specifies one or more tag objects. true true (ByValue)  
Name Specifies a tag by name. true true (ByPropertyName)  
Application Associates the tag with the specified application. false true (ByValue)  
ApplicationGroup Associates the tag with the specified application group. false true (ByValue)  
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.
false true (ByValue)  
DesktopGroup Associates the tag with the specified desktop group. false true (ByValue)  
Machine Associates the tag with the specified machine. false true (ByValue)  
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  
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  

Input Type


Tags may be specified through pipeline input.

Return Values



Example 1

C:\PS> Add-BrokerTag -Name 'Tag1' -Machine DOMAIN\Machine


Associates ‘Tag1’ with machine DOMAIN\Machine.

Example 2

C:\PS> $machine = Get-BrokerMachine -Uid 1

C:\PS> New-BrokerTag 'Tag2' | Add-BrokerTag -Machine $machine


Creates a new tag with name ‘Tag2’ and associates it with the machine with Uid 1.