vSphere PowerCLI Reference

New-CustomAttribute

Synopsis

Creates a new custom attribute.

Syntax

New-CustomAttribute [-Name] <String> [[-TargetType] <CustomAttributeTargetType[]>] [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-CustomAttribute
Remove-CustomAttribute
Set-CustomAttribute
Get-Annotation
Set-Annotation

Detailed Description

Creates a new custom attribute. A custom attribute is a user-defined description field of one or more vSphere objects.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameStringSpecify a name for the new custom attribute.truefalse
TargetTypeCustomAttributeTargetType[]Specify the type of the objects to which the new custom attribute applies. The valid values are VirtualMachine, ResourcePool, Folder, VMHost, Cluster, Datacenter, and $null. If the value is $null the custom attribute is global and applies to all target types.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$true
ServerVIServer[]Specify the vSphere servers 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
WhatIfSwitchParameterIndicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

CustomAttribute[]

Notes

Examples

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

New-CustomAttribute -Name "CompanyName" -TargetType VMHost, VirtualMachine

Creates a new custom attribute named CompanyName for the virtual machines and hosts on the server.


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