vSphere PowerCLI Reference

Set-CustomAttribute

Synopsis

Renames a custom attribute.

Syntax

Set-CustomAttribute [-CustomAttribute] <CustomAttribute[]> [-Name] <String> [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

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

Detailed Description

Renames a custom attribute.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameStringSpecify a new name for the custom attribute.truefalse
CustomAttributeCustomAttribute[]Specify the custom attribute you want to rename.truetrue (ByValue)
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 --------------

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.


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