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
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
VIProperty[] | named |
|
Specifies the extended object properties you want to remove. |
[-ObjectType]
<String[]>
-Name <String[]>
[CommonParameters]
-Name <String[]>
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
String[] | 1 |
|
Specifies the object types to which the extended properties you want to remove belong. | required |
|
String[] | named |
|
Specifies the names of the extended properties you want to remove. |
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 removes the extended properties from the specified object types.
This cmdlet creates a new extension property on the specified object type.
