openstack/deb-python-pyvmomi
Code Issues Proposed changes
Files
master
deb-python-pyvmomi/docs/vim/alarm/StateAlarmExpression.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

2.1 KiB
Raw Permalink Blame History

vim.alarm.StateAlarmExpression

An alarm expression that uses the running state of either a virtual machine or a host as the condition that triggers the alarm. Base type.There are two alarm operands: yellow and red. At least one of them must be set. The value of the alarm expression is determined as follows:
  • If the red state is set but the yellow state is not: the expression is red when the state operand matches (isEqual operator) or does not match (isUnequal operator) the state of the managed entity. The expression is green otherwise.
  • If yellow is set but red is not: the expression is yellow when the state operand matches (isEqual) or does not match (isUnequal) the state of the managed entity. The expression is green otherwise.
  • If both yellow and red are set, the value of the expression is red when the red state operand matches (isEqual) or does not match (isUnequal) the state of the managed entity. Otherwise, the expression is yellow when the yellow state operand matches (isEqual) or does not match (isUnequal) the state of the managed entity. Otherwise, the expression is green.
extends

vim.alarm.AlarmExpression

Attributes:

operator (vim.alarm.StateAlarmExpression.StateOperator):

The operation to be tested on the target state.

type (str):

Name of the object type containing the property.

statePath (str):

Path of the state property.The supported values:
  • for vim.VirtualMachine type:
  • runtime.powerState or summary.quickStats.guestHeartbeatStatus
  • for vim.HostSystem type: runtime.connectionState

yellow (str, optional):

Whether or not to test for a yellow condition. If this property is not set, do not calculate yellow status.

red (str, optional):

Whether or not to test for a red condition. If this property is not set, do not calculate red status.