PowerCLI Reference

Remove-Tag

Synopsis

This cmdlet removes the specified tags from the server.

Syntax

Remove-Tag [-Tag] <Tag[]> [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-Tag
New-Tag
Set-Tag

Detailed Description

This cmdlet removes the specified tags from the server.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
TagTag[]Specifies the tags you want to remove.truetrue (ByValue)
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
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no 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.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

None

Notes

Works only with vCenter Server 5.1 or later.

Examples

-------------- Example 1 --------------

$tagCategory = Get-TagCategory "MyTagCategory"
Get-Tag -Name "MyTag1", "MyTag2" -Category $tagCategory | Remove-Tag

Retrieves the tags named "MyTag1" and "MyTag2" from the specified tag category named "MyTagCategory" and then removes the tags from the vCenter Server system.


Copyright © VMware, Inc. All rights reserved.