< Back
Remove-VIProperty
Post
NAME 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>]
DESCRIPTION
This cmdlet removes the extended properties from the specified object types. Changes take effect upon the next
retrieval of the corresponding objects.
PARAMETERS
-Name <String[]>
Specifies the names of the extended properties you want to remove.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-ObjectType <String[]>
Specifies the object types to which the extended properties you want to remove belong.
Required? true
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VIProperty <VIProperty[]>
Specifies the extended object properties you want to remove.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
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.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
None
NOTES
-------------------------- 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 LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... perty.html
New-VIProperty
Get-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>]
DESCRIPTION
This cmdlet removes the extended properties from the specified object types. Changes take effect upon the next
retrieval of the corresponding objects.
PARAMETERS
-Name <String[]>
Specifies the names of the extended properties you want to remove.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-ObjectType <String[]>
Specifies the object types to which the extended properties you want to remove belong.
Required? true
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VIProperty <VIProperty[]>
Specifies the extended object properties you want to remove.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
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.
Required? false
Position? named
Default value $true
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
None
NOTES
-------------------------- 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 LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... perty.html
New-VIProperty
Get-VIProperty