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 P	EventDescription	Static descriptive strings used in events.
latestEvent* P	Event	The latest event that happened on the VirtualCenter server.
maxCollector P	xsd: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

Name	Type	Description
_this	ManagedObjectReference	A reference to the EventManager used to make the method call.
filter	EventFilterSpec	The event query filter.

Return Value

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

Faults

Type	Description
InvalidArgument	Thrown if the filter is null or unknown.
InvalidState	Thrown if there are more than the maximum number of event collectors.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" name="CreateCollectorForEvents">
            <complexType>
               <sequence>
                  <element name="_this" type="vim2:ManagedObjectReference"/>
                  <element name="filter" type="vim2:EventFilterSpec"/>
               </sequence>
            </complexType>
         </element>
         <element xmlns="http://www.w3.org/2001/XMLSchema" name="CreateCollectorForEventsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim2:ManagedObjectReference"/>
               </sequence>
            </complexType>
         </element>

LogUserEvent

Logs a user defined event against a particular managed entity.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the EventManager used to make the method call.
entity P	ManagedObjectReference 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.
msg	xsd:string	The message to be logged.

P Required privilege: Global.LogEvent

Return Value

Type	Description
None

Faults

Type	Description
InvalidArgument	Thrown if the entity is of a wrong type or the "msg" string is empty.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" name="LogUserEvent">
            <complexType>
               <sequence>
                  <element name="_this" type="vim2:ManagedObjectReference"/>
                  <element name="entity" type="vim2:ManagedObjectReference"/>
                  <element name="msg" type="xsd:string"/>
               </sequence>
            </complexType>
         </element>
         <element xmlns="http://www.w3.org/2001/XMLSchema" name="LogUserEventResponse">
            <complexType/>
         </element>

QueryEvents

Returns the events in specified filter. Returns empty array when there are not any events qualified.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the EventManager used to make the method call.
filter	EventFilterSpec	The events qualified.

Return Value

Type	Description
Event[]	The events in the chain.

Faults

Type	Description
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" name="QueryEvents">
            <complexType>
               <sequence>
                  <element name="_this" type="vim2:ManagedObjectReference"/>
                  <element name="filter" type="vim2:EventFilterSpec"/>
               </sequence>
            </complexType>
         </element>
         <element xmlns="http://www.w3.org/2001/XMLSchema" name="QueryEventsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim2:Event" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>