vSphere PowerCLI Reference

Remove-CustomField

Synopsis

This cmdlet deletes the specified custom fields for the specified type of inventory items.

Syntax

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

Related Commands

Online version
New-CustomField

Detailed Description

This cmdlet is deprecated and scheduled for removal. Deletes the specified custom fields for the specified type of inventory items.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
EntityInventoryItemSpecifies the inventory items to which the custom field you want to remove belongs.truetrue (ByValue)
NameStringSpecifies the names of the custom fields you want to remove.truefalse
ConfirmSwitchParameterIf 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.falsefalse$true
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

None

Notes

Examples

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

Remove-CustomField -Entity VM -Name CPUMaxLoad

Removes the custom field CPUMaxLoad from the virtual machine named VM. Asks for confirmation before running the task. The command returns the virtual machine VM, from which the custom field is removed.


Copyright © 1998 - 2014 VMware, Inc. All rights reserved.