Syntax
Set-Tag [-Tag] <Tag[]> [-Description <String>] [-Name <String>] [-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]Related Commands
Online VersionDetailed Description
This cmdlet modifies the specified tags.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Tag | Tag[] | Specifies the tags that you want to configure. | true | True (ByValue) | |
| Confirm | SwitchParameter | If 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. | false | False | |
| Description | String | Specifies the new description to set to the specified tags. | false | False | |
| Name | String | Specifies the name to which the specified tags will be renamed. | false | False | |
| Server | VIServer[] | 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. | false | False | |
| WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | False |
Return Type
One or more modified Tag objectsNotes
Works only with vCenter Server 5.1 or later.Examples
-------------------------- Example 1 --------------------------
Get-Tag -Name "MyTag" | Set-Tag -Name "MyNewTag" -Description "MyNewDescription"
Retrieves a tag named "MyTag" and updates its name and description.