MetricAlarmExpression

MetricAlarmExpression

An alarm expression that uses a metric as the condition that triggers an 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 host is not connected, the host metric expression is gray.
• If the vm is not connected, the vm metric expression is gray.
• If red is set but yellow is not, the expression is red when the metric is over (isAbove operator) or under (isBelow operator) the red value. Otherwise, the expression is green.
• If yellow is set but red is not, the expression is yellow when the metric is over (isAbove) or under (isBelow) the yellow value. Otherwise, the expression is green.
• If both yellow and red are set, the value of the expression is red when the metric is over (isAbove) or under (isBelow) the red value. Otherwise, the expression is yellow when the metric is over (isAbove) or under (isBelow) the yellow value. Otherwise, the expression is green.

AllOf

This class requires all of the following:

AlarmExpression

JSON Example

{
    "_typeName": "string",
    "operator": "string",
    "type": "string",
    "metric": {
        "_typeName": "string",
        "counterId": 0,
        "instance": "string"
    },
    "yellow": 0,
    "yellowInterval": 0,
    "red": 0,
    "redInterval": 0
}

MetricAlarmOperator_enum

operator

Required

The operation on the target metric item.

Possible values:

• isAbove: Test if the target metric item is above the given red or yellow values.
• isBelow: Test if the target metric item is below the given red or yellow values.

Possible values are : isAbove, isBelow,

string

type

Required

Name of the object type containing the property.

PerfMetricId

metric

Required

This data object type contains information that associates a performance counter with a performance metric.

When constructing this data object for the metricId property of the PerfQuerySpec to submit to one of the PerformanceManager query operations, the instance property supports these special characters:

• An asterisk (*) to specify all instances of the metric for the specified counterId
• Double-quotes ("") to specify aggregated statistics

integer As int32 As int32

yellow

Optional

Whether or not to test for a yellow condition.

If not set, do not calculate yellow status. If set, it contains the threshold value that triggers yellow status.

integer As int32 As int32

yellowInterval

Optional

Time interval in seconds for which the yellow condition must be true before the yellow status is triggered.

If unset, the yellow status is triggered immediately when the yellow condition becomes true.

integer As int32 As int32

red

Optional

Whether or not to test for a red condition.

If not set, do not calculate red status. If set, it contains the threshold value that triggers red status.

integer As int32 As int32

redInterval

Optional

Time interval in seconds for which the red condition must be true before the red status is triggered.

If unset, the red status is triggered immediately when the red condition becomes true.

Property Of

ArrayOfMetricAlarmExpression