powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Get-Annotation



NAME
Get-Annotation

SYNOPSIS
Retrieves annotations.

SYNTAX
Get-Annotation [[-CustomAttribute] ] [-Entity] [-Server ] [ rameters>]

Get-Annotation [-Entity] [-Name ] [-Server ] []


DESCRIPTION
Retrieves annotations. An annotation is a user-defined description field of one or more vSphere objects.


PARAMETERS
-CustomAttribute
Specify the custom attributes whose annotations you want to retrieve.

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

-Entity
Specify the entities whose annotations you want to retrieve.

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

-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

-Name
Specify the names of the annotations you want to retrieve.

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


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
Annotation[]


NOTES




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

C:\PS>Get-Cluster Cluster | Get-Annotation -CustomAttribute PhysicalLocation


Retrieves the annotation of the PhysicalLocation custom attribute for Cluster.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Get-Annotation.html
Set-Annotation
Get-CustomAttribute
New-CustomAttribute
Remove-CustomAttribute
Set-CustomAttribute