powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Set-Annotation



NAME
Set-Annotation

SYNOPSIS
Modifies the value to a custom attribute of an inventory item.

SYNTAX
Set-Annotation [-Entity] [-CustomAttribute] [-Value] [-Server r[]>] [-WhatIf] [-Confirm] []


DESCRIPTION
Modifies the value to a custom attribute of an inventory item.


PARAMETERS
-Entity
Specify the entities to which the new annotation value applies.

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

-CustomAttribute
Specify the custom attribute whose annotation you want to change.

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

-Value
Specify a new value for the annotation.

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

-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

-WhatIf
Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modi
fied.

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

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

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


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

C:\PS>Get-Cluster Cluster | Set-Annotation -CustomAttribute "PhysicalLocation" -Value California


Modifies the annotation of the PhysicalLocation custom attribute for the Cluster cluster.






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