Syntax
Set-TagCategory [-Category] <TagCategory[]> [-AddEntityType <String[]>] [-Cardinality <Cardinality>] [-Description <String>] [-Name <String>] [-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]Related Commands
Online VersionDetailed Description
This cmdlet modifies the specified tag categories. The cardinality of a tag category can only be changed from "Single" to "Multiple".Parameters
Name | Type | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
Category | TagCategory[] | Specifies the tag categories that you want to configure. | true | True (ByValue) | |
AddEntityType | String[] | 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.
This parameter accepts both PowerCLI type names and vSphere API type names. The valid PowerCLI type names are: Cluster, Datacenter, Datastore, DatastoreCluster, DistributedPortGroup, DistributedSwitch, Folder, ResourcePool, VApp, VirtualPortGroup, VirtualMachine, VM, VMHost. For non-PowerCLI types, a namespace prefix is required. Example: 'urn:vim25:VirtualMachine' | false | False | |
Cardinality | Cardinality | Specifies the cardinality of the tag category. If not specified, the default value is "Single".
"Single" means that only a single tag from this category can be assigned to a specific object at a time. "Multiple" means that more than one tag from this category can be assigned to a specific object at a time. The only value that is accepted for this parameter is "Multiple". | false | False | |
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 tag categories. | false | False | |
Name | String | Specifies the name to which the specified tag categories 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 TagCategory objectsNotes
Works only with vCenter Server 5.1 or later.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.