New-BrokerTag
Creates a new tag.
Syntax
New-BrokerTag
[-Description <String>]
[-Name] <String>
[-Scope <String[]>]
[-UUID <Guid>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Creates a tag that can be associated with other objects using Add-BrokerTag.
Examples
EXAMPLE 1
Creates a new tag with name 'Tag1'.
New-BrokerTag -Name 'Tag1'
EXAMPLE 2
Creates a new tag with name 'Tag2' and associates it with machine DOMAIN\Machine.
New-BrokerTag 'Tag2' | Add-BrokerTag -Machine DOMAIN\Machine
Parameters
-Name
Specifies a name for the new tag.
| 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 |
-Description
A description for the tag.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
| Disallowed characters: | All ASCII control characters |
-Scope
Specifies the name of the delegated administration scope to which the tag should belong.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-UUID
Specifies a UUID for the new tag. When not specified, a UUID is automatically assigned.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| 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
None
Input cannot be piped to this cmdlet.
Outputs
Citrix.Broker.Admin.SDK.Tag
Outputs the generated tag.