Property Collector Check For Updates

Deprecated as of vSphere API 4.1, use WaitForUpdatesEx with a maxWaitSeconds of 0.

Checks for updates on properties specified by the union of all current filters.

If no updates are pending, this method returns null.

Required privileges: System.View

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/PropertyCollector/{moId}/CheckForUpdates

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

CheckForUpdatesRequestType of type(s) application/json

Required

"CheckForUpdatesRequestType Object"

string

version

Optional

The data version currently known to the client. The value must be either

the special initial version (an empty string)
a data version returned from PropertyCollector.CheckForUpdates or PropertyCollector.WaitForUpdates by the same PropertyCollector on the same session.
a non-truncated data version returned from PropertyCollector.WaitForUpdatesEx by the same PropertyCollector on the same session.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Changes since the passed in data version. If no updates are pending, then this method returns null.

This response body class contains all of the following: UpdateSet

{
    "0": "U",
    "1": "p",
    "2": "d",
    "3": "a",
    "4": "t",
    "5": "e",
    "6": "S",
    "7": "e",
    "8": "t",
    "9": " ",
    "10": "O",
    "11": "b",
    "12": "j",
    "13": "e",
    "14": "c",
    "15": "t"
}

500

InvalidCollectorVersion: if the data version does not meet the requirements above.

RequestCanceled: if CancelWaitForUpdates has been called or the session was closed or the PropertyCollector was destroyed at some point after the call was received but before the update calculation was actually started

Returns InvalidCollectorVersion of type(s) application/json

This response body class contains all of the following: InlineInvalidCollectorVersion0

"InvalidCollectorVersion Object"

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/PropertyCollector/{moId}/CheckForUpdates

Deprecated

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Infrastructure Operations

POST