vSphere Web Services API


Data Object - PropertyFilterSpec(vmodl.query.PropertyCollector.FilterSpec)

Property of
PropertyFilter
Parameter to
CreateFilter, RetrieveProperties, RetrievePropertiesEx
Extends
DynamicData
See also
ObjectSpec, PropertySpec
Since
vmodl.query.version.version1

Data 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.

Properties

Name Type Description
objectSetObjectSpec[]

Set of specifications that determine the objects to filter.
propSetPropertySpec[]

Set of properties to include in the filter, specified for each object type.
reportMissingObjectsInResults*xsd:boolean

Control how to report missing objects during filter creation.

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

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

In an UpdateSet missing objects will appear in the missingSet field.

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

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

Since vSphere API Release 4.1
Properties inherited from DynamicData
None
*Need not be set
Show WSDL type definition