PowerCLI Reference



This cmdlet modifies the specified tags.


Set-Tag [-Tag] <Tag[]> [-Description <String>] [-Name <String>] [-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet modifies the specified tags.


NameTypeDescriptionRequired?Pipeline InputDefault Value
TagTag[]Specifies the tags that you want to configure.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 new description to set to the specified tags.falseFalse
NameStringSpecifies the name to which the specified tags will be renamed.falseFalse
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given 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

One or more modified Tag objects


Works only with vCenter Server 5.1 or later.


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

Get-Tag -Name "MyTag" | Set-Tag -Name "MyNewTag" -Description "MyNewDescription"

Retrieves a tag named "MyTag" and updates its name and description.

Copyright © VMware, Inc. All rights reserved.