openstack/deb-python-pyvmomi
Code Issues Proposed changes
Files
15f7be9a526d209fb7f0940cbf6b8e7cc481c0dd
deb-python-pyvmomi/docs/vim/alarm/EventAlarmExpression.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation 
This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15
2014-06-17 14:07:42 -04:00

3.6 KiB
Raw Blame History

vim.alarm.EventAlarmExpression

An alarm expression that uses the event stream to trigger the alarm.This alarm is triggered when an event matching this expression gets logged.

extends

vim.alarm.AlarmExpression

since

VI API 2.5

Attributes:

comparisons (vim.alarm.EventAlarmExpression.Comparison, optional):

The attributes/values to compare.

eventType (str):

The type of the event to trigger the alarm on.

eventTypeId (str, optional):

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 (str, optional):

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

status (vim.ManagedEntity.Status, optional):

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