Virtual Storage Lifecycle Management API
|
| Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |
Managed Object - EventManager(vim.event.EventManager)
- Property of
- ServiceContent
- See also
- Event, EventArgDesc, EventDescription, EventFilterSpec, EventHistoryCollector, ManagedEntity, TaskInfo
- Since
- 2.0
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.
|
Methods
| Methods defined in this Managed Object |
|---|
| CreateCollectorForEvents, LogUserEvent, PostEvent, QueryEvents, RetrieveArgumentDescription |
CreateCollectorForEvents(createCollector)
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.
Since 2.0 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a EventHistoryCollector | The event collector based on the filter. |
Faults
| Type | Description |
|---|---|
| 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. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
LogUserEvent(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.
Since 2.0 |
| msg | xsd:string |
The message to be logged.
Since 2.0 |
Return Value
| Type | Description |
|---|---|
| None | |
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. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
PostEvent(postEvent)
Posts the specified event, optionally associating it with a task.The event being posted should have the following info in it:
- The ManagedEntity on which the event is being posted should be set in the appropriate EntityEventArgument field of the base Event class. It is OK to not set any entity, in which case the event is treated as an event about the system.
- Some Event fields (key, chainId, createdTime) are mandatory because of the nature of the structure, but any caller-supplied values will be overwritten by the system.
If the event being posted is to be associated with an existing Task, the appropriate TaskInfo needs to be passed in. This task can either be one returned from a vSphere API operation or an extension task created by calling TaskManager#createTask.
- Required Privileges
- Global.LogEvent
- Since
- VI API 2.5
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the EventManager used to make the method call. |
| eventToPost | Event |
Fully-specified event to post
Since VI API 2.5 |
| taskInfo* | TaskInfo |
optional task associated with the event
Since VI API 2.5 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| InvalidEvent | no longer thrown by this API |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
QueryEvents(QueryEvent)
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.
Since 2.0 |
Return Value
| Type | Description |
|---|---|
| Event[] | The events matching the filter. |
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. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
RetrieveArgumentDescription(retrieveArgumentDescription)
Retrieves the argument meta-data for a given Event type- Required Privileges
- System.View
- Since
- vSphere API Release 4.0
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the EventManager used to make the method call. |
| eventTypeId | xsd:string |
Since vSphere API Release 4.0 |
Return Value
| Type | Description |
|---|---|
| EventArgDesc[] |
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. |
Events
| Type | |
|---|---|
| None | |
Show WSDL type definition
| Top of page | Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |