AlarmTriggeringAction

AlarmTriggeringAction
AlarmTriggeringAction

This data object type describes one or more triggering transitions and an action to be done when an alarm is triggered.

There are four triggering transitions; at least one of them must be provided. A gray state is considered the same as a green state, for the purpose of detecting transitions.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "action": {
        "_typeName": "string"
    },
    "transitionSpecs": [
        {
            "_typeName": "string",
            "startState": "string",
            "finalState": "string",
            "repeats": false
        }
    ],
    "green2yellow": false,
    "yellow2red": false,
    "red2yellow": false,
    "yellow2green": false
}
action
Required

This data object type defines the action initiated by a scheduled task or alarm.

This is an abstract type. A client creates a scheduled task or an alarm each of which triggers an action, defined by a subclass of this type.

transitionSpecs
Optional

Indicates on which transitions this action executes and repeats.

This is optional only for backwards compatibility.

boolean
green2yellow
Required

Deprecated as of vSphere API 4.0, use AlarmTriggeringActionTransitionSpec .

Flag to specify that the alarm should trigger on a transition from green to yellow.

boolean
yellow2red
Required

Deprecated as of vSphere API 4.0, use AlarmTriggeringActionTransitionSpec .

Flag to specify that the alarm should trigger on a transition from yellow to red.

boolean
red2yellow
Required

Deprecated as of vSphere API 4.0, use AlarmTriggeringActionTransitionSpec .

Flag to specify that the alarm should trigger on a transition from red to yellow.

boolean
yellow2green
Required

Deprecated as of vSphere API 4.0, use AlarmTriggeringActionTransitionSpec .

Flag to specify that the alarm should trigger on a transition from yellow to green.