Data Object Description

This alarm is triggered when an event matching this expression gets logged.

Properties

Name	Type	Description
comparisons*	EventAlarmExpressionComparison[]	The attributes/values to compare. *Since* vSphere API 4.0
eventType	xsd:string	Deprecated. use `eventTypeId` instead. The type of the event to trigger the alarm on.
eventTypeId*	xsd:string	The eventTypeId of the event to match. The semantics of how eventTypeId matching is done is as follows: If the event being matched is of type EventEx or ExtendedEvent, then we match this value against the `eventTypeId` (for `EventEx`) or `eventId` (for `ExtendedEvent`) member of the Event. Otherwise, we match it against the type of the Event itself. Either `eventType` or `eventTypeId` must be set.
objectType*	xsd:string	Name of the type of managed object on which the event is logged. An event alarm defined on a ManagedEntity is propagated to child entities in the VirtualCenter inventory depending on the value of this attribute. If objectType is any of the following, the alarm is propagated down to all children of that type: A datacenter: Datacenter. A cluster of host systems: ClusterComputeResource. A single host system: HostSystem. A resource pool representing a set of physical resources on a single host: ResourcePool. A virtual machine: VirtualMachine. A datastore: Datastore. A network: Network. A distributed virtual switch: DistributedVirtualSwitch. If objectType is unspecified or not contained in the above list, the event alarm is not propagated down to child entities in the VirtualCenter inventory. It is possible to specify an event alarm containing two (or more) different EventAlarmExpression's which contain different objectTypes. In such a case, the event is propagated to all child entities with specified type(s). *Since* vSphere API 4.0
status*	ManagedEntityStatus	The alarm's new state when this condition is evaluated and satisfied. If not specified then there is no change to alarm status, and all actions are fired (rather than those for the transition). *Since* vSphere API 4.0
Properties inherited from AlarmExpression
None
Properties inherited from DynamicData
dynamicProperty, dynamicType

Name

Type

Description

comparisons*

EventAlarmExpressionComparison[]

The attributes/values to compare.

Since vSphere API 4.0

eventType

xsd:string

Deprecated. use eventTypeId instead.

The type of the event to trigger the alarm on.

eventTypeId*

xsd:string

The eventTypeId of the event to match.

The semantics of how eventTypeId matching is done is as follows:

If the event being matched is of type EventEx or ExtendedEvent, then we match this value against the eventTypeId (for EventEx) or eventId (for ExtendedEvent) member of the Event.
Otherwise, we match it against the type of the Event itself.

Either eventType or eventTypeId must be set.

objectType*

xsd:string

Name of the type of managed object on which the event is logged.

An event alarm defined on a ManagedEntity is propagated to child entities in the VirtualCenter inventory depending on the value of this attribute. If objectType is any of the following, the alarm is propagated down to all children of that type:

A datacenter: Datacenter.
A cluster of host systems: ClusterComputeResource.
A single host system: HostSystem.
A resource pool representing a set of physical resources on a single host: ResourcePool.
A virtual machine: VirtualMachine.
A datastore: Datastore.
A network: Network.
A distributed virtual switch: DistributedVirtualSwitch.

If objectType is unspecified or not contained in the above list, the event alarm is not propagated down to child entities in the VirtualCenter inventory.

It is possible to specify an event alarm containing two (or more) different EventAlarmExpression's which contain different objectTypes. In such a case, the event is propagated to all child entities with specified type(s).

Since vSphere API 4.0

status*

ManagedEntityStatus

The alarm's new state when this condition is evaluated and satisfied. If not specified then there is no change to alarm status, and all actions are fired (rather than those for the transition).

Since vSphere API 4.0

Properties inherited from AlarmExpression

None

Properties inherited from DynamicData

dynamicProperty, dynamicType

Need not be set

Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="EventAlarmExpression">
            <complexContent>
               <extension base="vim25:AlarmExpression">
                  <sequence>
                     <element name="comparisons" type="vim25:EventAlarmExpressionComparison" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="eventType" type="xsd:string"/>
                     <element name="eventTypeId" type="xsd:string" minOccurs="0"/>
                     <element name="objectType" type="xsd:string" minOccurs="0"/>
                     <element name="status" type="vim25:ManagedEntityStatus" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - EventAlarmExpression

Data Object Description