Get-VIProperty
This cmdlet retrieves the extended properties and filters them by using the provided cmdlet parameters.
Syntax
[[-ObjectType]
<String[]>]
[-DeclaredOnly]
[-Name <String[]>]
[CommonParameters]
[-DeclaredOnly]
[-Name <String[]>]
[CommonParameters]
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
optional |
|
String[] | 1 |
|
Specifies the object types for which you want to retrieve extended properties. | optional |
|
SwitchParameter | named |
|
Indicates that you want to retrieve only the extended properties that have been directly defined for the specified object types. | optional |
|
String[] | named |
|
Specifies the names of the extended properties you want to retrieve. |
Output
VMware.VimAutomation.ViCore.Types.V1.VIProperty
Examples
Example 1
Get-VIProperty -Name "property*"
Retrieve all custom properties that match the specified name pattern.
Example 2
Get-VIProperty -ObjectType 'VirtualMachine'
Retrieve all custom properties for the specified object type.
Example 3
Get-VIProperty -ObjectType 'VirtualMachine' -DeclaredOnly
Retrieve all custom properties for the specified object type that are not inherited.
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.