TMF-642 Alarm Management - API Basic Testing Steps - Quick n Crisp

[Rahul Priyadars]

 The TM Forum Open APIs are a suite of application programming interfaces that: Enable services to be managed end-to-end throughout their lifecycle and TMF 642 is one of them for Carry out CRUD ops on Alarms generated on Monitoring Tool. It is part of TSOM module of Service Now.

How to Enable TMF 642 API- Install plugin Telecommunications Service Management Telecommunications Alarm Management Open API on the ServiceNow Store-sn_ind_tmf642

Once Installed you will find scoped application and APIs available in REST API Explorer.

Prepare POST for spinning an alert. JSON Data Used

{
"href":"http://api/alarm/ROUTER_IF@Cisco-0000-0-0-0-0-00-00-0-- Xz0/00@00",
"externalAlarmId":"<external-alarm-id>",
"alarmType":"QualityOfServiceAlarm",
"type":"QualityOfServiceAlarm",
"ackState":"acknowledged",
"perceivedSeverity":"CRITICAL",
"probableCause":"Threshold crossed",
"specificProblem":"Inbound Traffic threshold crossed",
"alarmedObjectType":"ROUTER",
"alarmedObject":{
"id":"vManage_000000",
"href":" http://api/alarmedobject/000000"
},
"sourceSystemId":"SOURCE_SYSTEM_vManage_00000_000_00",
"alarmDetails":"Software Failure on SD-WAN Controller vManage_000000",
"state":"RAISED",
"alarmChangedTime":"2017-08-15T07:04:15.666Z",
"proposedRepairActions":"Switch in standby equipment",
"alarmReportingTime":"2017-06-15T07:04:15.666Z",
"alarmRaisedTime":"2020-09-15T07:04:15.666Z",
"plannedOutageIndication":"IN_SERVICE",
"serviceAffecting":true,
"affectedService":[
{
"id":"SD WAN Enterprise Solutions",
"href":"http://api/service/vlan_dot0_dot0"
},
{
"id":"Santa Clara SD WAN Application Service",
"href":"http://api/service/vlan_dot0_dot0"
}]}

It creates and Event , Alert and an Incident

Clearing an Alarm- Pick message ID from Response Body form Above Post Response. It will clear the alarm . It will close the Alert and Resolve the Incident.

Clear Alarm JSON

{
"alarmClearedTime": "2017-08-15 06:04:15",
"clearSystemId": "vManage_000000",
"clearUserId": "SOURCE_SYSTEM_vManage_00000_000_00"
}

Clear Alarm received in event table and Processed

Alert Closed

Incident Resolved 

Hope this Helps.

Regards

RP

[Sumit Pandey4]

Great article, It is in my todo list to explore TSOM.

[PaulSylo]

Great Article - Rahul. I was expecting this one from you since we had our discussion. 

[Suresh32]

Thanks Rahul for this Article, Was looking for this solution since last one week and then found this article, which helped me to resolve my issue. 

[MayankVineet]

Very useful and greatly put together

[Sanjay34]

@Rahul Priyadars I just want to know this payload used in the article is oob or custom created payload by you ??

[SivaKrishnT]

Hi @Rahul Priyadars, thanks for your article. It helped me understand the payload of TMF642. When the payload is sent, it shows a response body. Whenever an incident task is generated, how is that incident creation shown to the external system? How can we send the incident ID through the response? Can you help with this?