vSphere PowerCLI Reference

Set-TagCategory

Synopsis

This cmdlet modifies the specified tag categories.

Syntax

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

Related Commands

Online version
Get-TagCategory
New-TagCategory
Remove-TagCategory

Detailed Description

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

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
CategoryTagCategory[]Specifies the tag categories that you want to configure.truetrue (ByValue)
AddEntityTypeString[]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 vSphere type names that are not vCenter Server API type names, a namespace prefix is used.
The format is: <namespace>/<type>
Example: 'vco/WorkflowItem'
falsefalse
CardinalityCardinalitySpecifies 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".
falsefalse
ConfirmSwitchParameterIf 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.falsefalse
DescriptionStringSpecifies the new description to set to the tag categories.falsefalse
NameStringSpecifies the name to which the specified tag categories will be renamed.falsefalse
ServerVIServer[]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.falsefalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

One or more modified TagCategory objects

Notes

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.


Copyright © 1998 - 2014 VMware, Inc. All rights reserved.