Syntax
Set-CustomAttribute [-Name] <String> [-CustomAttribute] <CustomAttribute[]> [-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]Related Commands
Online VersionDetailed Description
This cmdlet renames a custom attribute.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Name | String | Specifies a new name for the custom attribute. | true | False | |
| CustomAttribute | CustomAttribute[] | Specifies the custom attribute you want to rename. | true | True (ByValue) | |
| 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. | false | False | |
| Server | VIServer[] | Specifies the vCenter Server systems 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. | false | False | |
| WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | False |
Return Type
Zero or more modified CustomAttribute objectsNotes
Examples
-------------------------- 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.