Syntax
Set-Annotation [-Entity] <InventoryItem[]> [-CustomAttribute] <CustomAttribute> [-Value] <String> [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]Related Commands
Online versionDetailed Description
Modifies the value to a custom attribute of an inventory item.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Entity | InventoryItem[] | Specify the entities to which the new annotation value applies. | true | true (ByValue) | |
| CustomAttribute | CustomAttribute | Specify the custom attribute whose annotation you want to change. | true | true (ByValue) | |
| Value | String | Specify a new value for the annotation. | true | false | |
| 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 | $true |
| Server | VIServer[] | 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. | false | false | |
| WhatIf | SwitchParameter | Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | false |
Return Type
AnnotationNotes
Examples
-------------- Example 1 --------------
Set-Annotation -Entity $host -CustomAttribute "PhysicalLocation" -Value Office
Modifies the annotation of the PhysicalLocation custom attribute for the host stored in the $host variable.
-------------- Example 2 --------------
Get-Cluster Cluster | Set-Annotation -CustomAttribute "PhysicalLocation" -Value California
Modifies the annotation of the PhysicalLocation custom attribute for the Cluster cluster.