PropertyFilterSpec

PropertyFilterSpec
PropertyFilterSpec

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.

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "propSet": [
        {
            "_typeName": "string",
            "type": "string",
            "all": false,
            "pathSet": [
                "string"
            ]
        }
    ],
    "objectSet": [
        {
            "_typeName": "string",
            "obj": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "skip": false,
            "selectSet": [
                {
                    "_typeName": "string",
                    "name": "string"
                }
            ]
        }
    ],
    "reportMissingObjectsInResults": false
}
array of PropertySpec
propSet
Required

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

array of ObjectSpec
objectSet
Required

Set of specifications that determine the objects to filter.

boolean
reportMissingObjectsInResults
Optional

Control how to report missing objects during filter creation.

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

If true and PropertyFilterSpec.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 PropertyFilterSpec.objectSet refers to transient objects.

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

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

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

Property Of
Returned By