< Back
New-CustomAttribute
Post
NAME New-CustomAttribute
SYNOPSIS
This cmdlet creates a new custom attribute.
SYNTAX
New-CustomAttribute [-Name] <String> [[-TargetType] <CustomAttributeTargetType[]>] [-Server <VIServer[]>]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This cmdlet creates a new custom attribute. A custom attribute is a user-defined description field of one or more
vCenter Server objects.
PARAMETERS
-Name <String>
Specifies a name for the new custom attribute.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Server <VIServer[]>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-TargetType <CustomAttributeTargetType[]>
Specifies 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.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
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
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
The newly created CustomAttribute object
NOTES
-------------------------- 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.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... ibute.html
Get-CustomAttribute
Remove-CustomAttribute
Set-CustomAttribute
Get-Annotation
Set-Annotation
SYNOPSIS
This cmdlet creates a new custom attribute.
SYNTAX
New-CustomAttribute [-Name] <String> [[-TargetType] <CustomAttributeTargetType[]>] [-Server <VIServer[]>]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This cmdlet creates a new custom attribute. A custom attribute is a user-defined description field of one or more
vCenter Server objects.
PARAMETERS
-Name <String>
Specifies a name for the new custom attribute.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Server <VIServer[]>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-TargetType <CustomAttributeTargetType[]>
Specifies 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.
Required? false
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
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
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
The newly created CustomAttribute object
NOTES
-------------------------- 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.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... ibute.html
Get-CustomAttribute
Remove-CustomAttribute
Set-CustomAttribute
Get-Annotation
Set-Annotation