Set-Tag Command | Vmware PowerCLI Reference

Set-Tag

This cmdlet modifies the specified tags.

Syntax

Set-Tag
-Tag < Tag[] >
[-Description < String > ]
[-Name < String > ]
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Tag Tag[] named
  • pipeline
  • wildcards
Specifies the tags that you want to configure.
optional Description String named
Specifies the new description to set to the specified tags.
optional Name String named
Specifies the name to which the specified tags will be renamed.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
  • wildcards
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null 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.

Output

VMware.VimAutomation.ViCore.Types.V1.Tagging.Tag

Examples

Example 1

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

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

Related Commands

Tag

This cmdlet retrieves the tags available on a vCenter Server system.

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

This cmdlet removes the specified tags from the server.

This cmdlet modifies the specified tags.

TagAssignment

This cmdlet retrieves the tag assignments of objects.

This cmdlet assigns the specified tag(s) to the specified entity(s).

This cmdlet removes the specified tag assignment.

TagCategory

This cmdlet retrieves the tag categories available on a vCenter Server system and filters them using the specified cmdlet parameters.

This cmdlet creates a new tag category on the specified vCenter Server systems with the specified parameters.

This cmdlet removes the specified tag categories from the server.

This cmdlet modifies the specified tag categories.