Set-CustomAttribute
This cmdlet renames a custom attribute.
Syntax
[
-CustomAttribute
]
< CustomAttribute[] >
-Name
< String >
[-ProgressAction
< ActionPreference > ]
[-Server
< VIServer[] > ]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
CustomAttribute | CustomAttribute[] | 1 |
|
Specifies the custom attribute you want to rename. |
| required
|
Name | String | named |
|
Specifies a new name for the custom attribute. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | Server | VIServer[] | named |
|
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null 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. |
Output
VMware.VimAutomation.ViCore.Types.V1.AnnotationManagement.CustomAttributeExamples
Example 1
Set-CustomAttribute -Name CreationDetails -CustomAttribute CreationDate
Renames a custom attribute from CreationDate to CreationDetails.
Example 2
Get-CustomAttribute -Name CreationDate -Server server1, server2 | Set-CustomAttribute -Name CreationDetails
Renames the custom attributes retrieved from the specified vSphere servers from CreationDate to CreationDetails.
Related Commands
CustomAttribute
This cmdlet retrieves custom attributes.
This cmdlet creates a new custom attribute.
This cmdlet removes custom attributes.
This cmdlet renames a custom attribute.