powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Set-CustomAttribute



NAME
Set-CustomAttribute

SYNOPSIS
Renames a custom attribute.

SYNTAX
Set-CustomAttribute [-CustomAttribute] [-Name] [-Server ] [-WhatIf] [-Conf
irm] []


DESCRIPTION
Renames a custom attribute.


PARAMETERS
-CustomAttribute
Specify the custom attribute you want to rename.

Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-Name
Specify a new name for the custom attribute.

Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Server
Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the co
mmand runs on the default servers. For more information about default servers, see the description of Connect-V
IServer.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-WhatIf
Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modi
fied.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

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


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
CustomAttribute


NOTES




-------------- Example 1 --------------

C:\PS>Set-CustomAttribute -Name CreationDetails -CustomAttribute CreationDate


Renames a custom attribute from CreationDate to CreationDetails.





-------------- Example 2 --------------

C:\PS>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: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Set-CustomAttribute.html
Get-CustomAttribute
New-CustomAttribute
Remove-CustomAttribute
Get-Annotation
Set-Annotation