Set-Tag

This cmdlet modifies the specified tags.

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
required
Tag
Tag[] named
  • wildcards
  • pipeline
  • 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
    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

    Feedback

    Was this page helpful?