Remove-VIProperty - vSphere PowerCLI Cmdlets Reference

Synopsis

Syntax

Related Commands

Online version

New-VIProperty

Detailed Description

Parameters

Name	Description	Required?	Pipeline Input	Default Value
Name	Specify the names of the extended properties you want to remove.	true	false
ObjectType	Specify the object types to which the extended properties you want to remove belong.	true	false
WhatIf	Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.	false	false
Confirm	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	$true

Name

Description

Required?

Pipeline Input

Default Value

Name

Specify the names of the extended properties you want to remove.

true

false

ObjectType

Specify the object types to which the extended properties you want to remove belong.

true

false

WhatIf

Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.

false

Confirm

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

$true

Return Type

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".