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.

entity
Required

Entity on which the alarm is instantiated.

alarm
Required

Alarm object from which the AlarmState object is instantiated.

overallStatus
Required

Overall status of the alarm object.

This is the value of the alarm's top-level expression. In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property. To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Since this property is on a DataObject, an update returned by WaitForUpdatesEx may contain values for this property when some other property on the DataObject changes. If this update is a result of a call to WaitForUpdatesEx with a non-empty version parameter, the value for this property may not be current.

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