vSphere PowerCLI Reference

Set-CustomField

Synopsis

This cmdlet modifies the value of a custom field for a specified inventory item.

Syntax

Set-CustomField [-Entity] <InventoryItem> [-Name] <String> [[-Value] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
New-CustomField
Remove-CustomField

Detailed Description

This cmdlet is deprecated and scheduled for removal.
This cmdlet modifies the value of a custom field for a specified inventory item. If the custom field with this name does not exist, it is created for this type of items and then its value is set.

Parameters

Name	Type	Description	Required?	Pipeline Input
Entity	InventoryItem	Specifies the inventory item to which the custom field you want to change belongs.	true	true (ByValue)
Name	String	Specifies the name of the custom field you want to change.	true	false
Value	String	Provides a new value for the custom field.	false	false
Confirm	SwitchParameter	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.	false	false
WhatIf	SwitchParameter	Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.	false	false

Return Type

The specified InventoryItem object

Notes

Examples

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

Get-VM VM | Set-CustomField -Name CF - Value 10

Sets the value of the CF custom field of the VM virtual machine.