PowerCLI Reference

New-TagAssignment

Synopsis

This cmdlet assigns the specified tag(s) to the specified entity(s).

Syntax

New-TagAssignment [-Tag] <Tag[]> [-Entity] <VIObjectCore[]> [-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version
Get-Tag
Get-TagAssignment
Remove-TagAssignment

Detailed Description

This cmdlet assigns the specified tag to the specified entity.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
TagTag[]Specifies the tag to be assigned to the entity.trueFalse
EntityVIObjectCore[]Specifies the object on which to assign the specified tag.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

One or more TagAssignment objects

Notes

Works only with vCenter Server 5.1 or later.

Examples

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

$myTag = Get-Tag "MyTag"
Get-VM "*MyVM*" | New-TagAssignment -Tag $myTag

Assigns the "MyTag" tag to all virtual machines whose name contains the " MyVM " wildcard pattern.


Copyright © VMware, Inc. All rights reserved.