Get-Annotation

NAME Get-Annotation



SYNOPSIS

This cmdlet retrieves annotations.





SYNTAX

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

[<CommonParameters>]



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





DESCRIPTION

This cmdlet retrieves annotations. An annotation is a user-defined description field of one or more vSphere

objects.





PARAMETERS

-CustomAttribute <CustomAttribute[]>

Specifies the custom attributes whose annotations you want to retrieve.



Required? false

Position? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-Entity <InventoryItem>

Specifies the entities whose annotations you want to retrieve.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



-Name <String[]>

Specifies the names of the annotations you want to retrieve.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



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







NOTES









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



RELATED LINKS

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

Set-Annotation

Get-CustomAttribute

New-CustomAttribute

Remove-CustomAttribute

Set-CustomAttribute