Alarm

Alarm
Alarm

The alarm data type encapsulates information about an alarm. It shall comply with the provisions defined in Table 8.5.2.4-1

JSON Example 
{
    "isRootCause": true,
    "rootCauseFaultyResource": {
        "faultyResource": {
            "resourceId": "resourceId",
            "vimId": "vimId",
            "vimLevelResourceType": "vimLevelResourceType",
            "resourceProviderId": "resourceProviderId"
        },
        "faultyResourceType": null
    },
    "alarmRaisedTime": "2000-01-23T04:56:07.000Z",
    "alarmClearedTime": "2000-01-23T04:56:07.000Z",
    "alarmAcknowledgedTime": "2000-01-23T04:56:07.000Z",
    "_links": {
        "self": {
            "href": "http://example.com/aeiou"
        }
    },
    "eventType": null,
    "alarmChangedTime": "2000-01-23T04:56:07.000Z",
    "ackState": "UNACKNOWLEDGED",
    "managedObjectId": "managedObjectId",
    "perceivedSeverity": null,
    "probableCause": "probableCause",
    "eventTime": "2000-01-23T04:56:07.000Z",
    "faultType": "faultType",
    "correlatedAlarmIds": [
        null,
        null
    ],
    "faultDetails": [
        "faultDetails",
        "faultDetails"
    ],
    "id": "id",
    "rootCauseFaultyComponent": {
        "faultyResourceType": "faultyResourceType",
        "faultyNsVirtualLinkInstanceId": "faultyNsVirtualLinkInstanceId",
        "faultyNestedNsInstanceId": "faultyNestedNsInstanceId"
    }
}
string
id
Required

An identifier with the intention of being globally unique.

string
managedObjectId
Required

An identifier with the intention of being globally unique.

FaultyComponentInfo
rootCauseFaultyComponent
Optional

rootCauseFaultyComponent

FaultyResourceInfo
rootCauseFaultyResource
Optional

rootCauseFaultyResource

string As date-time As date-time
alarmRaisedTime
Required

Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.

string As date-time As date-time
alarmChangedTime
Optional

Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.

string As date-time As date-time
alarmClearedTime
Optional

Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.

string As date-time As date-time
alarmAcknowledgedTime
Optional

Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.

string
ackState
Required

Acknowledgment state of the alarm. Permitted values: UNACKNOWLEDGED ACKNOWLEDGED

Possible values are : UNACKNOWLEDGED, ACKNOWLEDGED,
PerceivedSeverityType
perceivedSeverity
Required

perceivedSeverity

string As date-time As date-time
eventTime
Required

Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.

EventType
eventType
Required

eventType

string
faultType
Optional

Additional information to clarify the type of the fault.

string
probableCause
Required

Information about the probable cause of the fault.

boolean
isRootCause
Required

Attribute indicating if this fault is the root for other correlated alarms. If TRUE, then the alarms listed in the attribute CorrelatedAlarmId are caused by this fault.

array of Identifier
correlatedAlarmIds
Optional

List of identifiers of other alarms correlated to this fault.

array of string
faultDetails
Optional

Provides additional information about the fault..

Alarm__links
_links
Required

_links

Returned By