Product Documentation

Add-BrokerTag

Oct 12, 2015

Associate a tag with another object.

Syntax

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

Add-BrokerTag [-Name] <String> [-Desktop <Desktop>] [-DesktopGroup <DesktopGroup>] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Associates one or more tags with another object.

Parameters

-InputObject<Tag[]>

Specifies one or more tag objects.

Required? true
Default Value  
Accept Pipeline Input? true (ByValue)

-Name<String>

Specifies a tag by name.

Required? true
Default Value  
Accept Pipeline Input? true (ByPropertyName)

-Desktop<Desktop>

Associates the tag with a desktop.

Required? false
Default Value  
Accept Pipeline Input? true (ByValue)

-DesktopGroup<DesktopGroup>

Associates the tag with a desktop group.

Required? false
Default Value  
Accept Pipeline Input? true (ByValue)

-LoggingId<Guid>

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.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminAddress<String>

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.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value will become the default.
Accept Pipeline Input? false

Input Type

Citrix.Broker.Admin.SDK.Tag Tags may be specified through pipeline input.

Return Values

None

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS> $desktop = Get-BrokerDesktop -Uid 1 
C:\PS> Add-BrokerTag -Name 'Tag1' -Desktop $desktop

Associates 'Tag1' with Desktop $desktop.

-------------------------- EXAMPLE 2 --------------------------

C:\PS> $desktop = Get-BrokerDesktop -Uid 1 
C:\PS> New-BrokerTag 'Tag2' | Add-BrokerTag -Desktop $desktop

Creates a new tag with name 'Tag2' and associates it with Desktop $desktop.