org.ovirt.engine.sdk4.services

Interface EventsService

All Superinterfaces:

Service

All Known Implementing Classes:

EventsServiceImpl

public interface EventsService
extends Service

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EventsService.AddRequest Adds an external event to the internal audit log.
static interface	EventsService.AddResponse Adds an external event to the internal audit log.
static interface	EventsService.ListRequest
static interface	EventsService.ListResponse
static interface	EventsService.UndeleteRequest
static interface	EventsService.UndeleteResponse

Method Summary

Modifier and Type	Method and Description
EventsService.AddRequest	add() Adds an external event to the internal audit log.
EventService	eventService(String id)
EventsService.ListRequest	list()
Service	service(String path) Service locator method, returns individual service on which the URI is dispatched.
EventsService.UndeleteRequest	undelete()

Method Detail

add

EventsService.AddRequest add()

Adds an external event to the internal audit log.

This is intended for integration with external systems that detect or produce events relevant for the administrator of the system. For example, an external monitoring tool may be able to detect that a file system is full inside the guest operating system of a virtual machine. This event can be added to the internal audit log sending a request like this:

POST /ovirt-engine/api/events
<event>
  <description>File system /home is full</description>
  <severity>alert</severity>
  <origin>mymonitor</origin>
  <custom_id>1467879754</custom_id>
</event>

Events can also be linked to specific objects. For example, the above event could be linked to the specific virtual machine where it happened, using the vm link:

POST /ovirt-engine/api/events
<event>
  <description>File system /home is full</description>
  <severity>alert</severity>
  <origin>mymonitor</origin>
  <custom_id>1467879754</custom_id>
  <vm id="aae98225-5b73-490d-a252-899209af17e9"/>
</event>

Note	When using links, like the vm in the previous example, only the id attribute is accepted. The name attribute, if provided, is simply ignored.

list

EventsService.ListRequest list()

undelete

EventsService.UndeleteRequest undelete()

eventService

EventService eventService(String id)

service

Service service(String path)

Service locator method, returns individual service on which the URI is dispatched.