## PowerCLI Reference

# Get-Annotation

## Synopsis

This cmdlet retrieves annotations.

Syntax

Get-Annotation [[-CustomAttribute] <CustomAttribute[]>] [-Entity] <InventoryItem> [-Server <VIServer[]>] [<CommonParameters>]
Get-Annotation [-Entity] <InventoryItem> [-Name <String[]>] [-Server <VIServer[]>] [<CommonParameters>]

Related Commands

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

Detailed 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 objects

Notes

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.

Copyright © VMware, Inc. All rights reserved.