Syntax
Get-Annotation [-Entity] <InventoryItem> [[-CustomAttribute] <CustomAttribute[]>] [-Server <VIServer[]>] [<CommonParameters>]Related Commands
Online VersionDetailed Description
This cmdlet retrieves annotations. An annotation is a user-defined description field of one or more vSphere objects.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Entity | InventoryItem | Specifies the entities whose annotations you want to retrieve. | true | True (ByValue) | |
| CustomAttribute | CustomAttribute[] | Specifies the custom attributes whose annotations you want to retrieve. | false | False | |
| Name | String[] | Specifies the names of the annotations you want to retrieve. | false | False | |
| Server | VIServer[] | Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. | false | False |
Return Type
Zero or more Annotation objectsNotes
Examples
-------------------------- Example 1 --------------------------
Get-Cluster Cluster | Get-Annotation -CustomAttribute PhysicalLocation
Retrieves the annotation of the PhysicalLocation custom attribute for Cluster.
-------------------------- Example 2 --------------------------
$vm = Get-VM -Name $vmname Get-Annotation -Entity $vm -CustomAttribute Description
Retrieves the annotation of the Description custom attribute for the $vm virtual machine.