Property Collector Cancel Retrieve Properties Ex

Property Collector Cancel Retrieve Properties Ex

Discards remaining results from a retrieval started by RetrievePropertiesEx on the same session on the same PropertyCollector.

Required privileges: System.Read

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/PropertyCollector/{moId}/CancelRetrievePropertiesEx
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 8.0.2.0 APIs.

Request Body
CancelRetrievePropertiesExRequestType of type(s) application/json
Required 
"CancelRetrievePropertiesExRequestType Object"
string
token
Required

the token returned in the previous RetrieveResult returned on the same session by the same PropertyCollector.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

InvalidArgument: If the token does not match the token from the previous RetrieveResult returned on the same session by the same PropertyCollector.

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}/CancelRetrievePropertiesEx
On This Page
Property Collector 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