Event Manager Create Collector For Events

Creates an event history collector, which is a specialized history collector that provides Event objects.

Event collectors do not persist beyond the current client session.

Required privileges: System.View

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/EventManager/{moId}/CreateCollectorForEvents

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 EventManager/{moId}.

string

release

Required

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

Request Body

CreateCollectorForEventsRequestType of type(s) application/json

Required

"CreateCollectorForEventsRequestType Object"

filter

Required

The event query filter.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

The event collector based on the filter.

Returns MoRefEventHistoryCollector of type(s) application/json

"MoRefEventHistoryCollector Object"

500

InvalidArgument: if the filter is null or if any of its fields is invalid, such as an invalid reference to a managed object, alarm, or scheduled task, or an invalid event type or event chain id, etc.

InvalidState: if there are more than the maximum number of event collectors.

Returns InvalidState of type(s) application/json

"InvalidState Object"

Code Samples

COPY

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

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Infrastructure Operations

POST

Event Manager Query Events