Property Collector Create Filter

Property Collector Create Filter

Creates a new filter for the given set of managed objects.

Required privileges: System.View

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/PropertyCollector/{moId}/CreateFilter
COPY
Path Parameters
string
moId
Required

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

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.

Request Body
CreateFilterRequestType of type(s) application/json
Required 
"CreateFilterRequestType Object"
spec
Required

The specifications for the filter.

boolean
partialUpdates
Required

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.

Authentication
This operation uses the following authentication methods.
Responses
200

A reference to the new filter.

Returns MoRefPropertyFilter of type(s) application/json
This response body class contains all of the following: InlineMoRefPropertyFilter0 
"MoRefPropertyFilter Object"

500

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.

ManagedObjectNotFound: See reportMissingObjectsInResults.

Returns InvalidProperty of type(s) application/json
This response body class contains all of the following: InlineInvalidProperty0 
"InvalidProperty Object"
string
name
Required

The property name that generated the error.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/PropertyCollector/{moId}/CreateFilter
On This Page
Virtual Infrastructure Operations
POST
Property Collector Cancel Retrieve Properties Ex
POST
Property Collector Cancel Wait For Updates
POST
Property Collector Check For Updates
Deprecated
POST
Property Collector Continue Retrieve Properties Ex
POST
Property Collector Create Filter
POST
Property Collector Create Property Collector
POST
Property Collector Destroy Property Collector
POST
Property Collector Retrieve Properties
Deprecated
POST
Property Collector Retrieve Properties Ex
POST
Property Collector Wait For Updates
Deprecated
POST
Property Collector Wait For Updates Ex
GET
Property Collector Get Filter