Property Collector Create Filter
Creates a new filter for the given set of managed objects.
Required privileges: System.View
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId
, in this case PropertyCollector/{moId}
.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
{
"spec": {
"_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
},
"partialUpdates": false
}
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.
Flag to specify whether a change to a nested property should report only the nested change or the entire specified property value. If the value is true, a change should report only the nested property. If the value is false, a change should report the enclosing property named in the filter.
A reference to the new filter.
{
"_typeName": "string",
"type": "string",
"value": "string"
}
InvalidArgument: if any of the following is true:
- "spec" is empty.
- "spec" contains a selection with properties not defined on its type.
InvalidProperty: if "spec" has a property that is not defined on one of the objects.
InvalidType: if "spec" contains, directly or indirectly, a type name that does not refer to a known type.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
],
"name": "string"
}
The property name that generated the error.