Set-CustomAttribute

NAME Set-CustomAttribute



SYNOPSIS

This cmdlet renames a custom attribute.





SYNTAX

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

[-WhatIf] [<CommonParameters>]





DESCRIPTION

This cmdlet renames a custom attribute.





PARAMETERS

-CustomAttribute <CustomAttribute[]>

Specifies the custom attribute you want to rename.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



-Name <String>

Specifies a new name for the 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 given 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



-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

Zero or more modified CustomAttribute objects







NOTES









-------------------------- 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 LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... ibute.html

Get-CustomAttribute

New-CustomAttribute

Remove-CustomAttribute

Get-Annotation

Set-Annotation