Set-TagCategory

This cmdlet modifies the specified tag categories. The cardinality of a tag category can only be changed from "Single" to "Multiple".

Syntax

-Category  <TagCategory[]>
[-AddEntityType  <String[]>]
[-Cardinality  <Cardinality>]
[-Description  <String>]
[-Name  <String>]
[-Server  <VIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Category
TagCategory[] named
  • wildcards
  • pipeline
  • Specifies the tag categories that you want to configure.
    optional
    AddEntityType
    String[] named Adds the specified entity types to the list of types that tags in this category are applicable to. If you specify "All" as a value, the tags will be applicable to all entity types.
    optional
    Cardinality
    Cardinality named Specifies the cardinality of the tag category. If not specified, the default value is "Single".
    optional
    Description
    String named Specifies the new description to set to the tag categories.
    optional
    Name
    String named Specifies the name to which the specified tag categories 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.TagCategory

    Examples


    Example 1

    Get-TagCategory "MyTagCategory" | Set-TagCategory -Name "MyNewCategoryName" -Description "Update MyTagCategory description"

    Retrieves a tag category named "MyTagCategory" and updates its name and description.

    Example 2

    $myTagCategory = Get-TagCategory "MyTagCategory"
    Set-TagCategory -Category $myTagCategory -Cardinality Multiple -AddEntityType "VirtualMachine"

    Retrieves a tag category named "MyTagCategory" and updates it by allowing more than one of its tags to be assigned to a specific object at a time, as well as adding "VirtualMachine" to the set of applicable entity types.

    Related Commands

    Feedback

    Was this page helpful?