< Back

Get-VIProperty

Sun Jan 19, 2020 6:53 pm

NAME Get-VIProperty



SYNOPSIS

This cmdlet retrieves extended object properties.





SYNTAX

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





DESCRIPTION

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





PARAMETERS

-DeclaredOnly [<SwitchParameter>]

Indicates that you want to retrieve only the extended properties that have been directly defined for the

specified object types.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Name <String[]>

Specifies the names of the extended properties you want to retrieve.



Required? false

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-ObjectType <String[]>

Specifies the object types for which you want to retrieve extended properties.



Required? false

Position? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? true



<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

Zero or more VIProperty objects







NOTES









-------------------------- 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 LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... perty.html

Remove-VIProperty

New-VIProperty