Set-TagCategory

VMware: Modifies a tag category

Script

#Requires -Version 5.1
#Requires -Modules VMware.VimAutomation.Core
[CmdletBinding()]
Param(
    [Parameter(Mandatory = $true)]
    [string]$VIServer,
    [Parameter(Mandatory = $true)]
    [pscredential]$VICredential,
    [Parameter(Mandatory = $true)]
    [string]$Name,
    [string]$NewName,
    [string]$Description,
    [ValidateSet("Multi", "Single")]
    [string]$Cardinality,
    [ValidateSet('All', 'Cluster', 'Datacenter', 'Datastore', 'DatastoreCluster', 'DistributedPortGroup', 'DistributedSwitch', 'Folder', 'ResourcePool', 'VApp', 'VirtualPortGroup', 'VirtualMachine', 'VM', 'VMHost')]
    [string[]]$EntityType
)
Process {
    try {
        if ($EntityType -contains 'All') { $EntityType = @('All') }
        [string[]]$Properties = @('Name', 'Description', 'Cardinality', 'EntityType', 'Id')
        $vmServer = Connect-VIServer -Server $VIServer -Credential $VICredential -ErrorAction Stop
        $cmdArgs = @{ ErrorAction = 'Stop'; Server = $vmServer }
        $cat = Get-TagCategory @cmdArgs -Name $Name -ErrorAction Stop
        $cmdArgs.Add('Category', $cat)
        if ($PSBoundParameters.ContainsKey('NewName')) { $cmdArgs.Add('Name', $NewName) }
        if ($PSBoundParameters.ContainsKey('Description')) { $cmdArgs.Add('Description', $Description) }
        if ($PSBoundParameters.ContainsKey('Cardinality')) { $cmdArgs.Add('Cardinality', $Cardinality) }
        if ($PSBoundParameters.ContainsKey('EntityType')) { $cmdArgs.Add('AddEntityType', $EntityType) }
        $result = Set-TagCategory @cmdArgs | Select-Object $Properties
        if ($null -ne $result) { $result | Add-Member -NotePropertyName Timestamp -NotePropertyValue (Get-Date -Format "yyyy-MM-dd HH:mm:ss") -PassThru -Force }
    }
    catch { throw }
    finally { if ($null -ne $vmServer) { Disconnect-VIServer -Server $vmServer -Force -Confirm:$false -ErrorAction SilentlyContinue } }
}

Customize

VIServer string

IP address or DNS name of the vSphere server

VICredential pscredential

PSCredential object for authenticating with the server

Name string

Name of the tag category to modify

NewName string

New name for the tag category

Description string

New description

Cardinality string

Cardinality: Single or Multi

EntityType string

Entity types to add