AlarmState

AlarmState
AlarmState

Information about the alarm's state.

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "key": "string",
    "entity": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "alarm": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "overallStatus": "string",
    "time": "string",
    "acknowledged": false,
    "acknowledgedByUser": "string",
    "acknowledgedTime": "string",
    "eventKey": 0,
    "disabled": false
}
string
key
Required

Unique key that identifies the alarm.

MoRefManagedEntity
entity
Required

Reference to an instance of the ManagedEntity managed object.

MoRefAlarm
alarm
Required

Reference to an instance of the Alarm managed object.

ManagedEntityStatus_enum
overallStatus
Required

The Status enumeration defines a general "health" value for a managed entity.

Possible values:

  • gray: The status is unknown.
  • green: The entity is OK.
  • yellow: The entity might have a problem.
  • red: The entity definitely has a problem.
Possible values are : gray, green, yellow, red,
string As date-time As date-time
time
Required

Time the alarm triggered.

boolean
acknowledged
Optional

Flag to indicate if the alarm's actions have been acknowledged for the associated ManagedEntity.

string
acknowledgedByUser
Optional

The user who acknowledged this triggering.

If the triggering has not been acknowledged, then the value is not valid.

string As date-time As date-time
acknowledgedTime
Optional

The time this triggering was acknowledged.

If the triggering has not been acknowledged, then the value is not valid.

integer As int32 As int32
eventKey
Optional

Contains the key of the event that has triggered the alarm.

The value is set only for event based alarms. The value is not set for gray or manually reset alarms (via vim.AlarmManager.setAlarmStatus).

boolean
disabled
Optional

Flag to indicate if the alarm is disabled for the associated ManagedEntity.

Property Of
Returned By