Managed Object - EventManager

Property of
ServiceContent
See also
Event, EventDescription, EventFilterSpec, EventHistoryCollector, ManagedEntity

Managed Object Description

This managed object type provides properties and methods for event management support. Event objects are used to record significant state changes of managed entities.

Properties

Name Type Description
description PEventDescription Static descriptive strings used in events.
latestEvent* PEvent The latest event that happened on the VirtualCenter server.
maxCollector Pxsd:int For each client, the maximum number of event collectors that can exist simultaneously.
*May not be presentP Required privilege: System.View

Methods

Methods defined in this Managed Object
CreateCollectorForEvents, LogUserEvent, QueryEvents

CreateCollectorForEvents

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

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the EventManager used to make the method call.
filterEventFilterSpec The event query filter.

Return Value

Type Description
ManagedObjectReference
to a EventHistoryCollector
The event collector based on the filter.

Faults

Type Description
InvalidArgumentThrown if the filter is null or unknown.
InvalidStateThrown if there are more than the maximum number of event collectors.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



LogUserEvent

Logs a user defined event against a particular managed entity.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the EventManager used to make the method call.
entity PManagedObjectReference
to a ManagedEntity
The entity against which the event is logged. The entity must be the root folder, a DataCenter, a VirtualMachine, a HostSystem, or a ComputeResource.
msgxsd:string The message to be logged.
P Required privilege: Global.LogEvent

Return Value

Type Description
None

Faults

Type Description
InvalidArgumentThrown if the entity is of a wrong type or the "msg" string is empty.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



QueryEvents

Returns the events in specified filter. Returns empty array when there are not any events qualified.
Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the EventManager used to make the method call.
filterEventFilterSpec The events qualified.

Return Value

Type Description
Event[]The events in the chain.

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition