AlarmCreate

AlarmCreate
AlarmCreate

This resource represents an alarm supporting the information model defined in ITU-T X.733.

Skipped properties: href, ackState, alarmChangedTime, alarmClearedTime, alarmRaisedTime, alarmReportingTime, isRootCause, sourceSystemId, state, comment, correlatedAlarm, parentAlarm, @baseType, @schemaLocation, @type

UserDefined properties: The below properties do not have any mapping from TMF to TCSA, however if the user provides the following proerties they will be added as part of UserDefined field, the default one is UserDefined19 :

ackSystemId, ackUserId, affectedService, alarmEscalation, clearSystemId, clearUserId, crossedThresholdInformation, externalAlarmId, probableCause, reportingSystemId, serviceAffecting, specificProblem, proposedRepairedActions, place

JSON Example 
{
    "alarmType": "OpenAPIExample",
    "alarmedObjectType": "gNodeB",
    "perceivedSeverity": "MAJOR",
    "alarmedObject": {
        "id": "gNodeB-service-mavenir$gNodeB$INCHARGE-SA-PRES"
    },
    "ackSystemId": "postman-api",
    "ackUserId": "admin",
    "probableCause": "UserDefined probable cause",
    "proposedRepairedActions": "UserDefined proposed repaired actions",
    "affectedService": [
        {
            "id": "Name:NOTIFICATION-Router_AMPMNEWUS23000__PS__Router__267_Unresponsive$Source:INCHARGE-SA-PRES2$"
        }
    ],
    "alarmEscalation": false,
    "clearSystemId": "creating clearSystemId",
    "clearUserId": "creating clearUserId",
    "externalAlarmId": "creating External Alarm ID",
    "reportingSystemId": "creating Reporting System ID",
    "serviceAffecting": false,
    "specificProblem": "creating specific problem"
}
string
ackState
Optional

Provides the Acknowledgement State of the alarm

string
ackSystemId
Optional

Provides the name of the system that last changed the ackState of an alarm, i.e. acknowledged or unacknowledged the alarm.

string
ackUserId
Optional

Provides the id of the user who has last changed the ack state of the alarm, i.e. acknowledged or unacknowledged the alarm.

string As date-time As date-time
alarmChangedTime
Optional

Indicates the last date and time when the alarm is changed on the alarm-owning system. Any change to the alarm whether coming from the alarmed resource, or triggered by a change from the client is changing this time.

string As date-time As date-time
alarmClearedTime
Optional

Indicates the time (as a date + time) at which the alarm is cleared at the source.

string
alarmDetails
Optional

Contains further information on the alarm.

boolean
alarmEscalation
Optional

Indicates if this alarm has been escalated or not.

string As date-time As date-time
alarmRaisedTime
Optional

Indicates the time (as a date + time) at which the alarm occurred at its source.

string As date-time As date-time
alarmReportingTime
Optional

Indicates the time (as a date + time) at which the alarm was reported by the owning OSS. It might be different from the alarmRaisedTime. For instance, if the alarm list is maintained by an EMS, the alarmRaisedtime would be the time the alarm was detected by the NE, while the alarmReportingTime would be the time this alarm was stored in the alarm list of the EMS.

string
alarmType
Required

Categorize the alarm.

string
alarmedObjectType
Required

The type (class) of the managed object associated with the event.

string
clearSystemId
Optional

Provides the id of the system where the user who invoked the alarmCleared operation is located.

string
clearUserId
Optional

Provides the id of the user who invoked the alarmCleared operation

string
externalAlarmId
Optional

An identifier of the alarm in the source system.

boolean
isRootCause
Optional

Indicates whether the alarm is a root cause alarm..

string
perceivedSeverity
Required

Lists the possible severities that can be allocated to an Alarm.

Possible values are : CRITICAL, MAJOR, MINOR, NORMAL, UNKNOWN,
string
plannedOutageIndicator
Optional

Indicates that the Managed Object (related to this alarm) is in planned outage (in planned maintenance, or out-of-service).

Possible values are : PLANNED_MAINTENANCE, OUT_OF_SERVICE,
string
probableCause
Optional

Provides the probable cause of the alarm.

string
proposedRepairedActions
Optional

Indicates proposed repair actions, if known to the system emitting the alarm.

string
reportingSystemId
Optional

Reporting system identity.

boolean
serviceAffecting
Optional

Indicates whether the alarm affects service or not.

string
sourceSystemId
Optional

Source system identity.

string
specificProblem
Optional

Provides more specific information about the alarm.

string
state
Optional

Defines the alarm state during its life cycle

array of AffectedService
affectedService
Optional

Identifies the service affected by the alarm.

AlarmedObjectCreate
alarmedObject
Required

alarmedObject

array of Comment
comment
Optional

comment

array of AlarmRef
correlatedAlarm
Optional

Indicates other alarms related to this alarm.

CrossedThresholdInformation
crossedThresholdInformation
Optional

Identifies the details of the threshold that has been crossed.

array of AlarmRef
parentAlarm
Optional

Indicates the parent alarms of the alarm.

array of RelatedPlaceRefOrValue
place
Optional

place

Parameter To