[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance
Telco Cloud Service Assurance
Tmf Alarms
- Defines the REST API for Alarm Management. These APIs are similar in their purpose with the notification API but also provide extra functionalities in creating and deleting custom alarms.
- The APIs follow the TMF-642 specification standard.
TMF Alarms APIs support the following
- APIs for CRUD operations on Alarms
- APIs for Creating and getting AckAlarms, UnAckAlarms, ClearAlarms and CommentAlarms tasks.
The deviations from the TMF-642 standard are as specified below:-
- Create Alarm
- The alarmRaisedTime parameter is mandatory in TMF but optional in TCSA.
- The alarmType parameter is mandatory, but does not conform with the alarmType defined in X.733 8.1.1 or 3GPP TS 32.111-2 Annex A.
- The perceivedSeverity parameter can have six values (CRITICAL,MAJOR,MINOR,WARNING,indeterminate ,cleared) as per recommendation {ITU-T Recommendation X.733} but in TCSA only 4 values are supported (CRITICAL,MAJOR,MINOR, NORMAL).
- The sourceSystemId parameter is mandatory in TMF but cannot be set in TCSA.
- The State parameter is a madatory field in TMF but cannot be set in TCSA. The deafult value is set to ACTIVE on alarm creation.
- The probableCause parameter is mandatory in TMF, but optional in TCSA.
- CorrelatedAlarm, ParentAlarm, Comments, ackState, alarmClearedTime, alarmChangedTime, alarmReportingTime and isRootCause cannot be set.
- The Below TMF fields are stored in configured “UserDefined” fields ackSystemId,ackUserId,affectedService,alarmEscalation,clearSystemId,clearUserId,crossedThresholdInformation,externalAlarmId,probableCause,reportingSystemId,serviceAffecting,specificProblem,proposedRepairedActions,place
- Update Alarm
- alarmType, alarmedObjectType and alarmedObject cannot be modifed.
- CorrelatedAlarm, ParentAlarm, Comments, ackState, alarmClearedTime, alarmChangedTime, alarmReportingTime and isRootCause cannot be modified.
- The Below TMF fields are stored in configured “UserDefined” fields ackSystemId,ackUserId,affectedService,alarmEscalation,clearSystemId,clearUserId,crossedThresholdInformation,externalAlarmId,probableCause,reportingSystemId,serviceAffecting,specificProblem,proposedRepairedActions,place
- Create ackAlarms, unAckAlarms, clearAlarms and commentAlarms
- In TMF standard the alarmPattern parameter matches all attribtues present in the Alarm Object but In TCSA the following attributes can be matched id, alarmType, alarmedObjectType, perceivedSeverity, plannedOutageIndicator and state.
- All the optional parameters cannot be set while creating the object. These are derived internally and filled. These are ackTime,state,ackedAlarm,ackUserId,unAckedAlarm,alarmClearedTime,clearUserId,clearSystemId,clearedAlarm,commentedAlarm
Operations
post
post
post
post
post
delete
get
get
get
get
get
patch
get
get
get
get
get
[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance