Remove-VIProperty Command | Vmware PowerCLI Reference

Remove-VIProperty

This cmdlet removes the extended properties from the specified object types. Changes take effect upon the next retrieval of the corresponding objects.

Syntax

Remove-VIProperty
[ -ObjectType ] < String[] >
-Name < String[] >
[-ProgressAction < ActionPreference > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
ObjectType String[] 1
  • wildcards
Specifies the object types to which the extended properties you want to remove belong.
required
Name String[] named
  • wildcards
Specifies the names of the extended properties you want to remove.
optional ProgressAction ActionPreference named
Remove-VIProperty
-VIProperty < VIProperty[] >
[-ProgressAction < ActionPreference > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
VIProperty VIProperty[] named
  • pipeline
Specifies the extended object properties you want to remove.
optional ProgressAction ActionPreference named

Output

Examples

Example 1

Remove-VIProperty -Name * -ObjectType *

Removes all custom properties.

Example 2

Remove-VIProperty -Name * -ObjectType VirtualMachine

Removes all custom properties for the VirtualMachine object type.

Example 3

Remove-VIProperty -Name OverallStatus, ConfigStatus -ObjectType VirtualMachine

Removes the OverallStatus and ConfigStatus for the VirtualMachine object type.

Example 4

Remove-VIProperty -Name OverallStatus -ObjectType VirtualMachine, Datacenter

Removes the OverallStatus property for the VirtualMachine and Datacenter types.

Example 5

Remove-VIProperty -Name *status* -ObjectType Virt*

Removes all properties that contain "status" in their names for object types with names that start with "Virt".

Related Commands

VIProperty

This cmdlet retrieves extended object properties.

This cmdlet creates a new extension property on the specified object type.

This cmdlet removes the extended properties from the specified object types.