Data Object - StateAlarmExpression(vim.alarm.StateAlarmExpression)

Extends
AlarmExpression
See also
StateAlarmOperator
Since
2.0

Data Object Description

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:

Properties

Name Type Description
operatorStateAlarmOperator

The operation to be tested on the target state.
red*xsd:string

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

Path of the state property.

The supported values:

  • for vim.VirtualMachine type:
  • runtime.powerState or summary.quickStats.guestHeartbeatStatus
  • for vim.HostSystem type: runtime.connectionState

typexsd:string

Name of the object type containing the property.
yellow*xsd:string

Whether or not to test for a yellow condition. If this property is not set, do not calculate yellow status.
Properties inherited from AlarmExpression
None
Properties inherited from DynamicData
None
*Need not be set
Show WSDL type definition