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://{vcenter-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 8.0.2.0 APIs.

Request Body

CreateCollectorForEventsRequestType of type(s) application/json

Required

{
    "filter": {
        "entity": {
            "entity": {
                "type": "string",
                "value": "string"
            },
            "recursion": "string"
        },
        "time": {
            "beginTime": "string",
            "endTime": "string"
        },
        "userName": {
            "systemUser": false,
            "userList": [
                "string"
            ]
        },
        "eventChainId": 0,
        "alarm": {
            "type": "string",
            "value": "string"
        },
        "scheduledTask": {
            "type": "string",
            "value": "string"
        },
        "disableFullMessage": false,
        "category": [
            "string"
        ],
        "type": [
            "string"
        ],
        "tag": [
            "string"
        ],
        "eventTypeId": [
            "string"
        ],
        "maxCount": 0
    }
}

EventFilterSpec

filter

Required

Event filter used to query events in the history collector database.

The client creates an event history collector with a filter specification, then retrieves the events from the event history collector.

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

This response body class contains all of the following: MoRefHistoryCollector

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

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

This response body class contains all of the following: VimFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Event Manager Operations

POST

Event Manager Create Collector For Events