powershellscripts.com

Tutorials  PowerShell Cmdlet Help for New-CustomAttribute



NAME
New-CustomAttribute

SYNOPSIS
Creates a new custom attribute.

SYNTAX
New-CustomAttribute [-Name] [[-TargetType] ] [-Server ] [-WhatIf]
[-Confirm] []


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


PARAMETERS
-Name
Specify a name for the new custom attribute.

Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false

-TargetType
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 gl
obal and applies to all target types.

Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Server
Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the co
mmand runs on the default servers. For more information about default servers, see the description of Connect-V
IServer.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-WhatIf
Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modi
fied.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm
If 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.

Required? false
Position? named
Default value $true
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
CustomAttribute[]


NOTES




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

C:\PS>New-CustomAttribute -Name "CompanyName" -TargetType VMHost, VirtualMachine


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






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/New-CustomAttribute.html
Get-CustomAttribute
Remove-CustomAttribute
Set-CustomAttribute
Get-Annotation
Set-Annotation