| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
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 |
Event collectors do not persist beyond the current client session.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the EventManager used to make the method call. |
filter P | 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 |
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 P | 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 |
The event being posted should have the following info in it:
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.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the EventManager used to make the method call. |
eventToPost P | Event |
Fully-specified event to post
Since VI API 2.5 |
taskInfo* P | 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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the EventManager used to make the method call. |
filter P | 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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the EventManager used to make the method call. |
eventTypeId P | xsd:string |
Since vSphere API 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 |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |