Service - EventDatabase

Class: VMware.Hv.EventDatabase
See also: EventDatabaseInfo, MapEntry
Since: Horizon View 6.0

Service Description

Service to manage the event database.

Methods

Methods defined in this Service
EventDatabase_Clear, EventDatabase_Get, EventDatabase_Update

EventDatabase_Clear

Clear the event database settings for this View cluster. If no event database is set, this will no-op.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global management is required to clear event database settings.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the EventDatabase used to make the method call.

Return Value

Type	Description
None

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Events

Event	Description
ADMIN_DATABASE_CONFIGURATION_DELETED	If a set Event Database was successfully cleared.
ADMIN_DATABASE_CONFIGURATION_DELETE_FAILED	If a set Event Database could not be cleared.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="EventDatabase_Clear" type="vdi:EventDatabase_ClearRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="EventDatabase_ClearResponse">
            <complexType/>
         </element>

EventDatabase_Get

Gets the event database settings for this View cluster If no event database is set, the eventDatabaseSet field will indicate that the settings and database members should be ignored.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	Global configuration (read-only) is required to get event database settings.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the EventDatabase used to make the method call.

Return Value

Type	Description
EventDatabaseInfo	The GlobalSettingsInfo object.

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="EventDatabase_Get" type="vdi:EventDatabase_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="EventDatabase_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:EventDatabaseInfo"/>
               </sequence>
            </complexType>
         </element>

EventDatabase_Update

Updates the event database settings for this View cluster. If no event database is set, this will cause a new event database to be set. If the settings are invalid, will throw InvalidRequest.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global management is required to update event database settings.

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the EventDatabase used to make the method call.

updates

MapEntry[]

key value pairs describing attributes to be updated

This parameter is an update map based on EventDatabaseInfo.

Return Value

Type	Description
None

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidRequest	Thrown if the broker can't connect to the database with the new settings
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Events

Event	Description
ADMIN_DATABASE_CONFIGURATION_ADDED	If the Event Database was not set, and a new one was successfully created.
ADMIN_DATABASE_CONFIGURATION_ADD_FAILED	If the Event Data was not set, and a new one could not be created.
ADMIN_DATABASE_CONFIGURATION_UPDATED	If a set Event Database was successfully updated.
ADMIN_DATABASE_CONFIGURATION_UPDATE_FAILED	If a set Event Database could not be updated.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="EventDatabase_Update" type="vdi:EventDatabase_UpdateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="EventDatabase_UpdateResponse">
            <complexType/>
         </element>

View API

Service - EventDatabase

Service Description

EventDatabase_Clear

EventDatabase_Get

EventDatabase_Update