PowerCLI Reference

New-Tag

Synopsis

This cmdlet creates a new tag in the specified tag category with the specified parameters.

Syntax

New-Tag [-Name] <String> [-Category] <TagCategory> [-Description <String>] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-Tag
Remove-Tag
Set-Tag

Detailed Description

This cmdlet creates a new tag in the specified tag category with the specified parameters.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameStringSpecifies the name of the new tag.truefalse
CategoryTagCategorySpecifies the tag category in which the new tag will be created.truetrue (ByValue)
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falsefalse
DescriptionStringSpecifies the description of the new tag.falsefalse
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falsefalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

The newly created Tag object

Notes

Works only with vCenter Server 5.1 or later.

Examples

-------------- Example 1 --------------

Get-TagCategory -Name "MyTagCategory" | New-Tag -Name "MyTag" -Description "Create MyTag tag in MyTagCategory category."

Retrieves a specific tag category, named "MyTagCategory", creates a tag named "MyTag" inside it, and sets the tag description.


Copyright © VMware, Inc. All rights reserved.