StateAlarmExpression

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.

AllOf

This class requires all of the following:

AlarmExpression

JSON Example

{
    "_typeName": "string",
    "operator": "string",
    "type": "string",
    "statePath": "string",
    "yellow": "string",
    "red": "string"
}

StateAlarmOperator_enum

operator

Required

The operation on the target state.

Possible values:

• isEqual: Test if the target state matches the given red or yellow states.
• isUnequal: Test if the target state does not match the given red or yellow states.

Possible values are : isEqual, isUnequal,

string

type

Required

Name of the object type containing the property.

string

statePath

Required

Path of the state property.

The supported values:

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

string

yellow

Optional

Whether or not to test for a yellow condition.

If this property is not set, do not calculate yellow status.

string

red

Optional

Whether or not to test for a red condition.

If this property is not set, do not calculate red status.

Property Of

ArrayOfStateAlarmExpression