# 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:

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

Properties

Name | Type | Description
--- | --- | ---
operator | StateAlarmOperator | 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.
statePath | xsd: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
type | xsd: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
<complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="StateAlarmExpression"> <complexContent> <extension base="vsan:AlarmExpression"> <sequence> <element name="operator" type="vsan:StateAlarmOperator"/> <element name="type" type="xsd:string"/> <element name="statePath" type="xsd:string"/> <element name="yellow" type="xsd:string" minOccurs="0"/> <element name="red" type="xsd:string" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType>