Product Documentation

New-BrokerTag

Apr 15, 2014

Creates a new tag.

Syntax

New-BrokerTag [-Name] <String> [-UUID <Guid>] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Creates a tag that can be associated with other objects using Add-BrokerTag.

Parameters

-Name<String>

Specifies a name for the new tag.

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

-UUID<Guid>

Specifies a UUID for the new tag. When not specified, a UUID is automatically assigned.

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

-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

None Input cannot be piped to this cmdlet.

Return Values

Citrix.Broker.Admin.SDK.Tag

Outputs the generated tag.

Examples

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

C:\PS> New-BrokerTag -Name 'Tag1'

Creates a new tag with name 'Tag1'.

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

C:\PS> New-BrokerTag 'Tag2' | Add-BrokerTag -Desktop $desktop

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