Scripting Object - VcEventManager

Scripting-object corresponding to
EventManager
Attribute of
VcSdkConnection, VcServiceContent

Scripting 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.

Attributes

Name Type Description
descriptionVcEventDescription

@since VI API 2.5
idString

@since Unknown
latestEventVcEvent

@since VI API 2.5
maxCollectorNumber

@since VI API 2.5
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, createCollectorForEvents, createTrigger, logUserEvent, postEvent, queryEvents, queryEventsById, queryLastEvent, retrieveArgumentDescription

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

queryEventsById

Returns the events specified by the argument event ids (keys). Returns empty array when none of the requested Events are found. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0Number []


Return Value

Type Description
VcEvent []

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. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcEventFilterSpec


Return Value

Type Description
VcEventHistoryCollector

queryEvents

Returns the events in specified filter. Returns empty array when there are not any events qualified. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcEventFilterSpec


Return Value

Type Description
VcEvent []

queryLastEvent

Returns the last events in specified filter. Returns empty array when there are not any events qualified. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcLastEventFilterSpec


Return Value

Type Description
VcEvent []

retrieveArgumentDescription

Retrieves the argument meta-data for a given Event type @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
VcEventArgDesc []

logUserEvent

Logs a user defined event against a particular managed entity. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcManagedEntity

arg1String


Return Value

Type Description
None

postEvent

Posts the specified event, optionally associating it with a task.

The event being posted should have the following info in it:

If the event being posted is to be associated with an existing {@link Task}, the appropriate {@link 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 {@link TaskManager#createTask}. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcEvent

arg1VcTaskInfo


Return Value

Type Description
None