## PowerCLI Reference

# Get-VIProperty

## Synopsis

This cmdlet retrieves extended object properties.

Syntax

Get-VIProperty [[-Name] <String[]>] [[-ObjectType] <String[]>] [-DeclaredOnly] [<CommonParameters>]

Related Commands

Online version
Remove-VIProperty
New-VIProperty

Detailed Description

This cmdlet retrieves the extended properties and filters them by using the provided cmdlet parameters.

Parameters

Name | Type | Description | Required? | Pipeline Input | Default Value
--- | --- | --- | --- | --- | ---
Name | String[] | Specifies the names of the extended properties you want to retrieve. | false | false
ObjectType | String[] | Specifies the object types for which you want to retrieve extended properties. | false | false
DeclaredOnly | SwitchParameter | Indicates that you want to retrieve only the extended properties that have been directly defined for the specified object types. | false | false

Return Type

Zero or more VIProperty objects

Notes

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.

Copyright © VMware, Inc. All rights reserved.