Scripting Object - VcPropertyFilterSpec

Attribute of: VcPropertyFilter
Parameter to: createFilter, retrieveProperties, retrievePropertiesEx

Scripting Object Description

Specify the property data that is included in a filter. A filter can specify part of a single managed object, or parts of multiple related managed objects in an inventory hierarchy - for example, to collect updates from all virtual machines in a given folder.

Attributes

Name	Type	Description
objectSet	VcObjectSpec []	Set of specifications that determine the objects to filter.
propSet	VcPropertySpec []	Set of properties to include in the filter, specified for each object type.
reportMissingObjectsInResults*	boolean	Control how to report missing objects during filter creation. If false or unset and VcPropertyFilterSpec refers to missing objects, filter creation will fail with a VcManagedObjectNotFound fault. If true and VcPropertyFilterSpec refers to missing objects, filter creation will not fail and missing objects will be reported via filter results. This is the recommended setting when VcPropertyFilterSpec refers to transient objects. In an VcUpdateSet missing objects will appear in the VcPropertyFilterUpdate field. In a VcRetrieveResult missing objects will simply be omitted from the objects field. For a call to VcPropertyCollector missing objects will simply be omitted from the results.

Name

Type

Description

objectSet

VcObjectSpec []

Set of specifications that determine the objects to filter.

propSet

VcPropertySpec []

Set of properties to include in the filter, specified for each object type.

reportMissingObjectsInResults*

boolean

Control how to report missing objects during filter creation.

If false or unset and VcPropertyFilterSpec refers to missing objects, filter creation will fail with a VcManagedObjectNotFound fault.

If true and VcPropertyFilterSpec refers to missing objects, filter creation will not fail and missing objects will be reported via filter results. This is the recommended setting when VcPropertyFilterSpec refers to transient objects.

In an VcUpdateSet missing objects will appear in the VcPropertyFilterUpdate field.

In a VcRetrieveResult missing objects will simply be omitted from the objects field.

For a call to VcPropertyCollector missing objects will simply be omitted from the results.

*May not be present

Methods

Methods defined in this Scripting Object
None

Top of page

Attributes

Scripting-Object Types

Finder Types

All Scripting-Object Attributes

All Scripting-Object Methods

All Finder Relations

All Finder Policies

All Finder Properties