PowerCLI Reference

Remove-VIProperty

Synopsis

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

Syntax

Remove-VIProperty [-Name] <String[]> [-ObjectType] <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]

Remove-VIProperty [-VIProperty] <VIProperty[]> [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version
New-VIProperty
Get-VIProperty

Detailed Description

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

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specifies the names of the extended properties you want to remove.trueFalse
VIPropertyVIProperty[]Specifies the extended object properties you want to remove.trueTrue (ByValue)
ObjectTypeString[]Specifies the object types to which the extended properties you want to remove belong.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
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-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".


Copyright © VMware, Inc. All rights reserved.