Operation

post /FaultManagement/rest/api/v2/alarms/{alarmFdn}/acknowledgements
acknowledgeSpecifiedAlarm (acknowledgeSpecifiedAlarm : /FaultManagement/rest/api/v2/alarms/{alarmFdn}/acknowledgements)
This is to acknowledge for the specified alarm.

Request body

Name

IsRequired

Description

Data Type

Enum

body required systemName=NSP&preferenceName=globalPref String ---

Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    POST https://{NSP ServerIp}:8544/FaultManagement/rest/api/v2/alarms/fdn%3Amodel%3Afm%3AAlarm%3A2350/acknowledgements Request body: { "systemName": "NSP", "preferenceName": "globalPref" }

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": "fdn:model:fm:Alarm:2350 Acknowledged successfully", "errors": null } }

    External Docs
    See Also :

    Operation

    post /FaultManagement/rest/api/v2/alarms/{alarmFdn}/acknowledgementNotes
    acknowledgementNote (acknowledgementNote : /FaultManagement/rest/api/v2/alarms/{alarmFdn}/acknowledgementNotes)
    This is to add an acknowledgement note for the specified alarm.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required {} String ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    POST https://{NSP ServerIp}:8544/FaultManagement/rest/api/v2/alarms/fdn%3Amodel%3Afm%3AAlarm%3A2350/acknowledgementNotes?ackNote=test acknowledgement notes Request Body {}

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "noteText": "test acknowledgement notes", "noteCreator": "SAMqa", "timeModified": 1569004937641 }, "errors": null } }

    External Docs
    See Also :

    Operation

    get /FaultManagement/rest/api/v2/alarmedObjects/{affectedObjectFdn}/alarms
    affectedAlarms (affectedAlarms : /FaultManagement/rest/api/v2/alarmedObjects/{affectedObjectFdn}/alarms)
    This is to find a list of affected alarms for the specified alarm.


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    GET https://{NSP ServerIp}:8544/FaultManagement/rest/api/v2/alarmedObjects/fdn%3Amodel%3Afm%3AAlarm%3A2350/alarms

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 0, "data": [], "errors": null } }

    External Docs
    See Also :

    Operation

    get /FaultManagement/rest/api/v2/alarmedObjects/{affectedObjectFdn}/aggregatedAlarms
    aggregatedAlarms (aggregatedAlarms : /FaultManagement/rest/api/v2/alarmedObjects/{affectedObjectFdn}/aggregatedAlarms)
    This is to find a list of aggregated alarms for the specified alarm.


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    GET https://{NSP ServerIp}:8544/FaultManagement/rest/api/v2/alarmedObjects/fdn%3Amodel%3Afm%3AAlarm%3A2350/aggregatedAlarms

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 0, "data": [], "errors": null } }

    External Docs
    See Also :

    Operation

    get /FaultManagement/rest/api/v2/alarms/{alarmFdn}/causes
    alarmCauses (alarmCauses : /FaultManagement/rest/api/v2/alarms/{alarmFdn}/causes)
    This is to find a tree of causes for the specified alarm.


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    GET https://{NSP ServerIp}:8544/FaultManagement/rest/api/v2/alarms/fdn%3Amodel%3Afm%3AAlarm%3A2350/causes

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "alarmFdn": "fdn:model:fm:Alarm:2350", "causes": [] }, "errors": null } }

    External Docs
    See Also :

    Operation

    get /FaultManagement/rest/api/v2/alarmSettings/deletion
    alarmDeletion (alarmDeletion : /FaultManagement/rest/api/v2/alarmSettings/deletion)
    Get the active alarm deletion settings.


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    GET https://{NSP ServerIp}:8544/FaultManagement/rest/api/v2/alarmSettings/deletion

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "enabled": true, "manual": { "enabled": false, "deletionRule": "deleteWhenCleared" }, "correlated": { "enabled": true, "deletionRule": "deleteWithoutNotification" }, "automatic": { "enabled": true, "deletionRule": "deleteWhenCleared" } }, "errors": null } }

    External Docs
    See Also :

    Operation

    get /FaultManagement/rest/api/v2/alarms/details
    alarmDetails (alarmDetails : /FaultManagement/rest/api/v2/alarms/details)
    This returns a list of alarms. The list will contain the alarm information of each resulting alarm.


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    GET https://{NSP ServerIp}:8544/FaultManagement/rest/api/v2/alarms/details

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: { "response": { "status": 0, "startRow": 0, "endRow": 310, "totalRows": 310, "data": [ { "fdn": "fdn:model:fm:Alarm:2715", "objectFullName": "faultManager:svc-mgr@service-20@35.121.20.71|alarm-97-16-83", "sourceType": "nfmp", "sourceSystem": "fdn:realm:sam", "severity": "critical", "previousSeverity": "indeterminate", "originalSeverity": "critical", "highestSeverity": "critical", "probableCause": "siteDown", "alarmName": "ServiceSiteDown", "specificProblem": "Not Applicable", "alarmType": "serviceAlarm", "affectedObject": "svc-mgr:service-20:35.121.20.71", "affectedObjectType": "ipipe.Site", "affectedObjectName": "ipipe site", "acknowledged": false, "wasAcknowledged": false, "acknowledgedBy": "N/A", "clearedBy": "N/A", "deletedBy": "N/A", "firstTimeDetected": 1569003624215, "lastTimeDetected": 1569003843639, "lastTimeSeverityChanged": 0, "lastTimeCleared": 0, "lastTimeAcknowledged": 0, "nodeTimeOffset": -1, "numberOfOccurrences": 3, "numberOfOccurrencesSinceClear": 3, "numberOfOccurrencesSinceAck": 0, "serviceAffecting": false, "implicitlyCleared": true, "additionalText": "N/A", "neId": "35.121.20.71", "neName": "s168_96_44_Both", "userText": "N/A", "adminState": "maintenance", "impact": 0, "rootCause": false }, { "fdn": "fdn:model:fm:Alarm:2762", "objectFullName": "faultManager:network@35.121.20.71@shelf-1@cardSlot-1@card@daughterCardSlot-1@daughterCard@port-14|alarm-10-3-8", "sourceType": "nfmp", "sourceSystem": "fdn:realm:sam", "severity": "major", "previousSeverity": "indeterminate", "originalSeverity": "major", "highestSeverity": "major", "probableCause": "inoperableEquipment", "alarmName": "EquipmentDown", "specificProblem": "Not Applicable", "alarmType": "equipmentAlarm", "affectedObject": "network:35.121.20.71:shelf-1:cardSlot-1:card:daughterCardSlot-1:daughterCard:port-14", "affectedObjectType": "equipment.PhysicalPort", "affectedObjectName": "Port 1/1/14", "acknowledged": false, "wasAcknowledged": false, "acknowledgedBy": "N/A", "clearedBy": "N/A", "deletedBy": "N/A", "firstTimeDetected": 1569003624342, "lastTimeDetected": 1569003624342, "lastTimeSeverityChanged": 0, "lastTimeCleared": 0, "lastTimeAcknowledged": 0, "nodeTimeOffset": -1, "numberOfOccurrences": 1, "numberOfOccurrencesSinceClear": 1, "numberOfOccurrencesSinceAck": 0, "serviceAffecting": false, "implicitlyCleared": true, "additionalText": "N/A", "neId": "35.121.20.71", "neName": "s168_96_44_Both", "userText": "N/A", "adminState": "unlocked", "impact": 3, "rootCause": true }, { "fdn": "fdn:model:fm:Alarm:2786", "objectFullName": "faultManager:network@35.121.20.71@shelf-1@cardSlot-1@card@daughterCardSlot-1@daughterCard@port-44|alarm-12-4-10", "sourceType": "nfmp", "sourceSystem": "fdn:realm:sam", "severity": "major", "previousSeverity": "indeterminate", "originalSeverity": "major", "highestSeverity": "major", "probableCause": "portLinkProblem", "alarmName": "LinkDown", "specificProblem": "Not Applicable", "alarmType": "communicationsAlarm", "affectedObject": "network:35.121.20.71:shelf-1:cardSlot-1:card:daughterCardSlot-1:daughterCard:port-44", "affectedObjectType": "equipment.PhysicalPort", "affectedObjectName": "Port 1/1/44", "acknowledged": false, "wasAcknowledged": false, "acknowledgedBy": "N/A", "clearedBy": "N/A", "deletedBy": "N/A", "firstTimeDetected": 1569003624377, "lastTimeDetected": 1569003624377, "lastTimeSeverityChanged": 0, "lastTimeCleared": 0, "lastTimeAcknowledged": 0, "nodeTimeOffset": -1, "numberOfOccurrences": 1, "numberOfOccurrencesSinceClear": 1, "numberOfOccurrencesSinceAck": 0, "serviceAffecting": false, "implicitlyCleared": true, "additionalText": "N/A", "neId": "35.121.20.71", "neName": "s168_96_44_Both", "userText": "N/A", "adminState": "unlocked", "impact": 0, "rootCause": false }, } ], "errors": null } }

    External Docs
    See Also :

    Operation

    get /FaultManagement/rest/api/v2/alarms/{alarmFdn}/impacts
    alarmImpact (alarmImpact : /FaultManagement/rest/api/v2/alarms/{alarmFdn}/impacts)
    This is to find a list of impacts for the specified alarm.


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    GET https://{NSP ServerIp}:8544/FaultManagement/rest/api/v2/alarms/fdn%3Amodel%3Afm%3AAlarm%3A2350/impacts

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "alarmFdn": "fdn:model:fm:Alarm:2350", "impacts": [ { "alarmFdn": "fdn:model:fm:Alarm:2274", "impacts": [] } ] }, "errors": null } }

    External Docs
    See Also :

    Operation

    get /FaultManagement/rest/api/v2/alarms/rootCauses
    alarmRootCause (alarmRootCause : /FaultManagement/rest/api/v2/alarms/rootCauses)
    This is to find a list of root cause alarms.


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    GET https://{NSP ServerIp}:8544/FaultManagement/rest/api/v2/alarms/rootCauses

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: { "response": { "status": 0, "startRow": 0, "endRow": 183, "totalRows": 183, "data": [ "fdn:model:fm:Alarm:2351", "fdn:model:fm:Alarm:2352", "fdn:model:fm:Alarm:2350", "fdn:model:fm:Alarm:3161", "fdn:model:fm:Alarm:3040", "fdn:model:fm:Alarm:3160", "fdn:model:fm:Alarm:2348", "fdn:model:fm:Alarm:2744", "fdn:model:fm:Alarm:3039", "fdn:model:fm:Alarm:2347", "fdn:model:fm:Alarm:3159", "fdn:model:fm:Alarm:3038", "fdn:model:fm:Alarm:2741", "fdn:model:fm:Alarm:2344", "fdn:model:fm:Alarm:3158", "fdn:model:fm:Alarm:3037", "fdn:model:fm:Alarm:2740", "fdn:model:fm:Alarm:3157", "fdn:model:fm:Alarm:3036", "fdn:model:fm:Alarm:2342", "fdn:model:fm:Alarm:3035", "fdn:model:fm:Alarm:2748", "fdn:model:fm:Alarm:2747", "fdn:model:fm:Alarm:2746", "fdn:model:fm:Alarm:3155", "fdn:model:fm:Alarm:3034", "fdn:model:fm:Alarm:3033", "fdn:model:fm:Alarm:3154", "fdn:model:fm:Alarm:3032", "fdn:model:fm:Alarm:3153", "fdn:model:fm:Alarm:3152", "fdn:model:fm:Alarm:2180", "fdn:model:fm:Alarm:2181", "fdn:model:fm:Alarm:2730", "fdn:model:fm:Alarm:2179", "fdn:model:fm:Alarm:2697", "fdn:model:fm:Alarm:2298", "fdn:model:fm:Alarm:2331", "fdn:model:fm:Alarm:2177", "fdn:model:fm:Alarm:2178", "fdn:model:fm:Alarm:2739", "fdn:model:fm:Alarm:2736", "fdn:model:fm:Alarm:3221", "fdn:model:fm:Alarm:3220", "fdn:model:fm:Alarm:2371", "fdn:model:fm:Alarm:2250", "fdn:model:fm:Alarm:2251", "fdn:model:fm:Alarm:2370", "fdn:model:fm:Alarm:2800", "fdn:model:fm:Alarm:3217", "fdn:model:fm:Alarm:2766", "fdn:model:fm:Alarm:3216", "fdn:model:fm:Alarm:2368", "fdn:model:fm:Alarm:3215", "fdn:model:fm:Alarm:2369", "fdn:model:fm:Alarm:2248", "fdn:model:fm:Alarm:3214", "fdn:model:fm:Alarm:2763", "fdn:model:fm:Alarm:2366", "fdn:model:fm:Alarm:2245", "fdn:model:fm:Alarm:3213", "fdn:model:fm:Alarm:2762", "fdn:model:fm:Alarm:2367", "fdn:model:fm:Alarm:2246", "fdn:model:fm:Alarm:3212", "fdn:model:fm:Alarm:3211", "fdn:model:fm:Alarm:2760", "fdn:model:fm:Alarm:2640", "fdn:model:fm:Alarm:2365", "fdn:model:fm:Alarm:2244", "fdn:model:fm:Alarm:3219", "fdn:model:fm:Alarm:3210", "fdn:model:fm:Alarm:3207", "fdn:model:fm:Alarm:3206", "fdn:model:fm:Alarm:2755", "fdn:model:fm:Alarm:3205", "fdn:model:fm:Alarm:2632", "fdn:model:fm:Alarm:3204", "fdn:model:fm:Alarm:2753", "fdn:model:fm:Alarm:2633", "fdn:model:fm:Alarm:2358", "fdn:model:fm:Alarm:3203", "fdn:model:fm:Alarm:2355", "fdn:model:fm:Alarm:2751", "fdn:model:fm:Alarm:3202", "fdn:model:fm:Alarm:3201", "fdn:model:fm:Alarm:2750", "fdn:model:fm:Alarm:3200", "fdn:model:fm:Alarm:2759", "fdn:model:fm:Alarm:3209", "fdn:model:fm:Alarm:2758", "fdn:model:fm:Alarm:2636", "fdn:model:fm:Alarm:3208", "fdn:model:fm:Alarm:2792", "fdn:model:fm:Alarm:2671", "fdn:model:fm:Alarm:2790", "fdn:model:fm:Alarm:2273", "fdn:model:fm:Alarm:2271", "fdn:model:fm:Alarm:2701", "fdn:model:fm:Alarm:2788", "fdn:model:fm:Alarm:2700", "fdn:model:fm:Alarm:2787", "fdn:model:fm:Alarm:2269", "fdn:model:fm:Alarm:2785", "fdn:model:fm:Alarm:2663", "fdn:model:fm:Alarm:2300", "fdn:model:fm:Alarm:2784", "fdn:model:fm:Alarm:2662", "fdn:model:fm:Alarm:2669", "fdn:model:fm:Alarm:3232", "fdn:model:fm:Alarm:3199", "fdn:model:fm:Alarm:3231", "fdn:model:fm:Alarm:3230", "fdn:model:fm:Alarm:3197", "fdn:model:fm:Alarm:2261", "fdn:model:fm:Alarm:3196", "fdn:model:fm:Alarm:2262", "fdn:model:fm:Alarm:3195", "fdn:model:fm:Alarm:3194", "fdn:model:fm:Alarm:2260", "fdn:model:fm:Alarm:3193", "fdn:model:fm:Alarm:3192", "fdn:model:fm:Alarm:3229", "fdn:model:fm:Alarm:2778", "fdn:model:fm:Alarm:3228", "fdn:model:fm:Alarm:3227", "fdn:model:fm:Alarm:2258", "fdn:model:fm:Alarm:3226", "fdn:model:fm:Alarm:2775", "fdn:model:fm:Alarm:3225", "fdn:model:fm:Alarm:2774", "fdn:model:fm:Alarm:3224", "fdn:model:fm:Alarm:2773", "fdn:model:fm:Alarm:3223", "fdn:model:fm:Alarm:3222", "fdn:model:fm:Alarm:2779", "fdn:model:fm:Alarm:2728", "fdn:model:fm:Alarm:2727", "fdn:model:fm:Alarm:2317", "fdn:model:fm:Alarm:2318" ], "errors": null } }

    External Docs
    See Also :

    Operation

    get /FaultManagement/rest/api/v2/alarms/rootCauses/details
    alarmRootCauseDetails (alarmRootCauseDetails : /FaultManagement/rest/api/v2/alarms/rootCauses/details)
    This is to find a list of root cause alarm details.


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    GET https://<NSP Server>:8544/FaultManagement/rest/api/v2/alarms/rootCauses/details

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: { "response": { "status": 0, "startRow": 0, "endRow": 183, "totalRows": 183, "data": [ { "fdn": "fdn:model:fm:Alarm:2250", "objectFullName": "faultManager:network@35.121.20.72@shelf-1@cardSlot-1@card@daughterCardSlot-1@daughterCard@port-38|alarm-10-3-8", "sourceType": "nfmp", "sourceSystem": "fdn:realm:sam", "severity": "major", "previousSeverity": "indeterminate", "originalSeverity": "major", "highestSeverity": "major", "probableCause": "inoperableEquipment", "alarmName": "EquipmentDown", "specificProblem": "Not Applicable", "alarmType": "equipmentAlarm", "affectedObject": "network:35.121.20.72:shelf-1:cardSlot-1:card:daughterCardSlot-1:daughterCard:port-38", "affectedObjectType": "equipment.PhysicalPort", "affectedObjectName": "Port 1/1/38", "acknowledged": false, "wasAcknowledged": false, "acknowledgedBy": "N/A", "clearedBy": "N/A", "deletedBy": "N/A", "firstTimeDetected": 1569003517979, "lastTimeDetected": 1569003517979, "lastTimeSeverityChanged": 0, "lastTimeCleared": 0, "lastTimeAcknowledged": 0, "nodeTimeOffset": -1, "numberOfOccurrences": 1, "numberOfOccurrencesSinceClear": 1, "numberOfOccurrencesSinceAck": 0, "serviceAffecting": false, "implicitlyCleared": true, "additionalText": "N/A", "neId": "35.121.20.72", "neName": "s168_96_6_Both", "userText": "N/A", "adminState": "unlocked", "impact": 1, "rootCause": true }, { "fdn": "fdn:model:fm:Alarm:2763", "objectFullName": "faultManager:network@35.121.20.71@shelf-1@cardSlot-1@card@daughterCardSlot-1@daughterCard@port-26|alarm-10-3-8", "sourceType": "nfmp", "sourceSystem": "fdn:realm:sam", "severity": "major", "previousSeverity": "indeterminate", "originalSeverity": "major", "highestSeverity": "major", "probableCause": "inoperableEquipment", "alarmName": "EquipmentDown", "specificProblem": "Not Applicable", "alarmType": "equipmentAlarm", "affectedObject": "network:35.121.20.71:shelf-1:cardSlot-1:card:daughterCardSlot-1:daughterCard:port-26", "affectedObjectType": "equipment.PhysicalPort", "affectedObjectName": "Port 1/1/26", "acknowledged": false, "wasAcknowledged": false, "acknowledgedBy": "N/A", "clearedBy": "N/A", "deletedBy": "N/A", "firstTimeDetected": 1569003624354, "lastTimeDetected": 1569003624354, "lastTimeSeverityChanged": 0, "lastTimeCleared": 0, "lastTimeAcknowledged": 0, "nodeTimeOffset": -1, "numberOfOccurrences": 1, "numberOfOccurrencesSinceClear": 1, "numberOfOccurrencesSinceAck": 0, "serviceAffecting": false, "implicitlyCleared": true, "additionalText": "N/A", "neId": "35.121.20.71", "neName": "s168_96_44_Both", "userText": "N/A", "adminState": "unlocked", "impact": 1, "rootCause": true }, { "fdn": "fdn:model:fm:Alarm:2729", "objectFullName": "faultManager:network@35.121.20.71@shelf-1@cardSlot-1@card@daughterCardSlot-1@daughterCard@port-22|alarm-10-3-8", "sourceType": "nfmp", "sourceSystem": "fdn:realm:sam", "severity": "major", "previousSeverity": "indeterminate", "originalSeverity": "major", "highestSeverity": "major", "probableCause": "inoperableEquipment", "alarmName": "EquipmentDown", "specificProblem": "Not Applicable", "alarmType": "equipmentAlarm", "affectedObject": "network:35.121.20.71:shelf-1:cardSlot-1:card:daughterCardSlot-1:daughterCard:port-22", "affectedObjectType": "equipment.PhysicalPort", "affectedObjectName": "Port 1/1/22", "acknowledged": false, "wasAcknowledged": false, "acknowledgedBy": "N/A", "clearedBy": "N/A", "deletedBy": "N/A", "firstTimeDetected": 1569003624350, "lastTimeDetected": 1569003624350, "lastTimeSeverityChanged": 0, "lastTimeCleared": 0, "lastTimeAcknowledged": 0, "nodeTimeOffset": -1, "numberOfOccurrences": 1, "numberOfOccurrencesSinceClear": 1, "numberOfOccurrencesSinceAck": 0, "serviceAffecting": false, "implicitlyCleared": true, "additionalText": "N/A", "neId": "35.121.20.71", "neName": "s168_96_44_Both", "userText": "N/A", "adminState": "unlocked", "impact": 1, "rootCause": true }, { "fdn": "fdn:model:fm:Alarm:2294", "objectFullName": "faultManager:network@35.121.20.72@shelf-1@cardSlot-1@card@daughterCardSlot-1@daughterCard@port-31|alarm-10-3-8", "sourceType": "nfmp", "sourceSystem": "fdn:realm:sam", "severity": "major", "previousSeverity": "indeterminate", "originalSeverity": "major", "highestSeverity": "major", "probableCause": "inoperableEquipment", "alarmName": "EquipmentDown", "specificProblem": "Not Applicable", "alarmType": "equipmentAlarm", "affectedObject": "network:35.121.20.72:shelf-1:cardSlot-1:card:daughterCardSlot-1:daughterCard:port-31", "affectedObjectType": "equipment.PhysicalPort", "affectedObjectName": "Port 1/1/31", "acknowledged": false, "wasAcknowledged": false, "acknowledgedBy": "N/A", "clearedBy": "N/A", "deletedBy": "N/A", "firstTimeDetected": 1569003517972, "lastTimeDetected": 1569003517972, "lastTimeSeverityChanged": 0, "lastTimeCleared": 0, "lastTimeAcknowledged": 0, "nodeTimeOffset": -1, "numberOfOccurrences": 1, "numberOfOccurrencesSinceClear": 1, "numberOfOccurrencesSinceAck": 0, "serviceAffecting": false, "implicitlyCleared": true, "additionalText": "N/A", "neId": "35.121.20.72", "neName": "s168_96_6_Both", "userText": "N/A", "adminState": "unlocked", "impact": 1, "rootCause": true }, { "fdn": "fdn:model:fm:Alarm:3216", "objectFullName": "faultManager:svc-mgr@service-12@35.121.20.71@circuit-150-5|alarm-98-17-84", "sourceType": "nfmp", "sourceSystem": "fdn:realm:sam", "severity": "critical", "previousSeverity": "indeterminate", "originalSeverity": "critical", "highestSeverity": "critical", "probableCause": "labelProblem", "alarmName": "LabelProblem", "specificProblem": "Not Applicable", "alarmType": "CircuitAlarm", "affectedObject": "svc-mgr:service-12:35.121.20.71:circuit-150-5", "affectedObjectType": "svt.SpokeSdpBinding", "affectedObjectName": "circuit-150-5", "acknowledged": false, "wasAcknowledged": false, "acknowledgedBy": "N/A", "clearedBy": "N/A", "deletedBy": "N/A", "firstTimeDetected": 1569003827800, "lastTimeDetected": 1569003827800, "lastTimeSeverityChanged": 0, "lastTimeCleared": 0, "lastTimeAcknowledged": 0, "nodeTimeOffset": -1, "numberOfOccurrences": 1, "numberOfOccurrencesSinceClear": 1, "numberOfOccurrencesSinceAck": 0, "serviceAffecting": false, "implicitlyCleared": true, "additionalText": "N/A", "neId": "35.121.20.71", "neName": "s168_96_44_Both", "userText": "N/A", "adminState": "maintenance", "impact": 0, "rootCause": true }, } ], "errors": null } }

    External Docs
    See Also :

    Operation

    get /FaultManagement/rest/api/v2/alarms
    alarmsWithoutFilter (alarmsWithoutFilter : /FaultManagement/rest/api/v2/alarms)
    Returns a list of alarms. The list will contain the objectFullName of each resulting alarm.


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    Alarms - without Filter ====================== GET https://{NSP ServerIp}:8544/FaultManagement/rest/api/v2/alarms Alarms - with Filter Example ============================ GET https://{NSP ServerIp}:8544/FaultManagement/rest/api/v2/alarms?alarmFilter=severity%253D'major'

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: Without Filter { "response": { "status": 0, "startRow": 0, "endRow": 310, "totalRows": 310, "data": [ "fdn:model:fm:Alarm:2351", "fdn:model:fm:Alarm:2352", "fdn:model:fm:Alarm:2350", "fdn:model:fm:Alarm:2348", "fdn:model:fm:Alarm:2346", "fdn:model:fm:Alarm:2347", "fdn:model:fm:Alarm:2344", "fdn:model:fm:Alarm:2345", "fdn:model:fm:Alarm:2342", "fdn:model:fm:Alarm:2343", "fdn:model:fm:Alarm:2698", "fdn:model:fm:Alarm:2699", "fdn:model:fm:Alarm:2696", "fdn:model:fm:Alarm:2697", "fdn:model:fm:Alarm:2694", "fdn:model:fm:Alarm:2331", "fdn:model:fm:Alarm:2695", "fdn:model:fm:Alarm:3221", "fdn:model:fm:Alarm:2252", "fdn:model:fm:Alarm:3220", "fdn:model:fm:Alarm:2253", "fdn:model:fm:Alarm:2371", "fdn:model:fm:Alarm:2250", "fdn:model:fm:Alarm:2251", "fdn:model:fm:Alarm:2370", "fdn:model:fm:Alarm:3218", "fdn:model:fm:Alarm:2243" ], "errors": null } } Response: With filter { "response": { "status": 0, "startRow": 0, "endRow": 237, "totalRows": 237, "data": [ "fdn:model:fm:Alarm:2351", "fdn:model:fm:Alarm:2352", "fdn:model:fm:Alarm:2350", "fdn:model:fm:Alarm:2348", "fdn:model:fm:Alarm:2346", "fdn:model:fm:Alarm:2347", "fdn:model:fm:Alarm:2344", "fdn:model:fm:Alarm:2345", "fdn:model:fm:Alarm:2342", "fdn:model:fm:Alarm:2343", "fdn:model:fm:Alarm:2698", "fdn:model:fm:Alarm:2696", "fdn:model:fm:Alarm:2697", "fdn:model:fm:Alarm:2694", "fdn:model:fm:Alarm:2331", "fdn:model:fm:Alarm:2695", "fdn:model:fm:Alarm:2252", "fdn:model:fm:Alarm:2253", "fdn:model:fm:Alarm:2250", "fdn:model:fm:Alarm:2251", "fdn:model:fm:Alarm:2800", "fdn:model:fm:Alarm:2249", "fdn:model:fm:Alarm:2247", "fdn:model:fm:Alarm:2248", "fdn:model:fm:Alarm:3214" ], "errors": null } }

    External Docs
    See Also :

    Operation

    delete /FaultManagement/rest/api/v2/alarms/{alarmFdn}
    deleteAlarm (deleteAlarm : /FaultManagement/rest/api/v2/alarms/{alarmFdn})
    This deletes the specified alarm.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required {} String ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    DELETE https://{NSP ServerIp}:8544/FaultManagement/rest/api/v2/alarms/fdn%3Amodel%3Afm%3AAlarm%3A2350

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": "fdn:model:fm:Alarm:2350 Deleted successfully", "errors": null } }

    External Docs
    See Also :

    Operation

    get /FaultManagement/rest/api/v2/alarms/{alarmFdn}/acknowledgementNotes
    getAcknowledgementNote (getAcknowledgementNote : /FaultManagement/rest/api/v2/alarms/{alarmFdn}/acknowledgementNotes)
    This is to get acknowledgement notes for the specified alarm.


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    GET https://{NSP ServerIp}:8544/FaultManagement/rest/api/v2/alarms/fdn%3Amodel%3Afm%3AAlarm%3A2350/acknowledgementNotes

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": [ { "noteText": "test acknowledgement notes", "noteCreator": "SAMqa", "timeModified": 1569004936789 } ], "errors": null } }

    External Docs
    See Also :

    Operation

    get /FaultManagement/rest/api/v2/alarmSettings/acknowledgement
    getAlarmAcknowledgement (getAlarmAcknowledgement : /FaultManagement/rest/api/v2/alarmSettings/acknowledgement)
    Get the active alarm acknowledgement settings.


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    GET https://{NSP ServerIp}:8544/FaultManagement/rest/api/v2/alarmSettings/acknowledgement

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "enabled": true, "correlated": { "enabled": true, "acknowledgementRule": "acknowledgeWithoutNotification" }, "automatic": { "enabled": false } }, "errors": null } }

    External Docs
    See Also :

    Operation

    get /FaultManagement/rest/api/v2/alarmSettings/aging
    getAlarmAging (getAlarmAging : /FaultManagement/rest/api/v2/alarmSettings/aging)
    Get the active alarm aging settings.


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    GET https://{NSP ServerIp}:8544/FaultManagement/rest/api/v2/alarmSettings/aging

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "enabled": false, "agingTime": 4 }, "errors": null } }

    External Docs
    See Also :

    Operation

    get /FaultManagement/rest/api/v2/alarmSettings/overflow
    getAlarmOverflow (getAlarmOverflow : /FaultManagement/rest/api/v2/alarmSettings/overflow)
    Get the active alarm overflow settings.


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    GET https://{NSP ServerIp}:8544/FaultManagement/rest/api/v2/alarmSettings/overflow

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "warningThreshold": 90, "overflowAction": "wrap", "purgeCriteria": "severity", "purgePercent": 10 }, "errors": null } }

    External Docs
    See Also :

    Operation

    get /FaultManagement/rest/api/v2/alarmSettings/severity
    getAlarmSeverity (getAlarmSeverity : /FaultManagement/rest/api/v2/alarmSettings/severity)
    Get the active alarm severity settings.


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    GET https://{NSP ServerIp}:8544/FaultManagement/rest/api/v2/alarmSettings/severity

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "enabled": true, "manual": { "enabled": true, "allowManualPromotion": true, "allowManualDemotion": true, "allowManualClearingOfAutoClearingAlarms": false }, "automatic": { "enabled": false, "allowPolicyBasedEscalation": false, "allowPolicyBasedDeEscalation": false } }, "errors": null } }

    External Docs
    See Also :

    Operation

    get /FaultManagement/rest/api/v2/alarmSettings/historicalArchive
    getHistoricalAlarm (getHistoricalAlarm : /FaultManagement/rest/api/v2/alarmSettings/historicalArchive)
    Get the active alarm deletion settings.


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    GET https://{NSP ServerIp}:8544/FaultManagement/rest/api/v2/alarmSettings/historicalArchive

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "enabled": true, "logOnChange": false, "logOnDelete": true }, "errors": null } }

    External Docs
    See Also :

    Operation

    get /FaultManagement/rest/api/v2/alarmSettings/historicalOverflow
    getHistoricalOverflow (getHistoricalOverflow : /FaultManagement/rest/api/v2/alarmSettings/historicalOverflow)
    Get the historical alarm overflow settings.


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    GET https://{NSP ServerIp}:8544/FaultManagement/rest/api/v2/alarmSettings/historicalOverflow

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: Response: { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "maxSize": 1000000, "warningThreshold": 95, "criticalThreshold": 100, "warningPurgePercent": 3, "criticalPurgePercent": 10 }, "errors": null } }

    External Docs
    See Also :

    Operation

    get /FaultManagement/rest/api/v2/alarms/{alarmFdn}
    specifiedAlarm (specifiedAlarm : /FaultManagement/rest/api/v2/alarms/{alarmFdn})
    This is to find information for the specified alarm.


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    GET https://{NSP ServerIp}:8544/FaultManagement/rest/api/v2/alarms/fdn%3Amodel%3Afm%3AAlarm%3A2350

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": { "fdn": "fdn:model:fm:Alarm:2350", "objectFullName": "faultManager:network@35.121.20.72@shelf-1@cardSlot-1@card@daughterCardSlot-1@daughterCard@port-60|alarm-10-3-8", "sourceType": "nfmp", "sourceSystem": "fdn:realm:sam", "severity": "major", "previousSeverity": "indeterminate", "originalSeverity": "major", "highestSeverity": "major", "probableCause": "inoperableEquipment", "alarmName": "EquipmentDown", "specificProblem": "Not Applicable", "alarmType": "equipmentAlarm", "affectedObject": "network:35.121.20.72:shelf-1:cardSlot-1:card:daughterCardSlot-1:daughterCard:port-60", "affectedObjectType": "equipment.PhysicalPort", "affectedObjectName": "Port 1/1/60", "acknowledged": false, "wasAcknowledged": false, "acknowledgedBy": "N/A", "clearedBy": "N/A", "deletedBy": "N/A", "firstTimeDetected": 1569003518000, "lastTimeDetected": 1569003518000, "lastTimeSeverityChanged": 0, "lastTimeCleared": 0, "lastTimeAcknowledged": 0, "nodeTimeOffset": -1, "numberOfOccurrences": 1, "numberOfOccurrencesSinceClear": 1, "numberOfOccurrencesSinceAck": 0, "serviceAffecting": false, "implicitlyCleared": true, "additionalText": "N/A", "neId": "35.121.20.72", "neName": "s168_96_6_Both", "userText": "N/A", "adminState": "unlocked", "impact": 1, "rootCause": true }, "errors": null } }

    External Docs
    See Also :

    Operation

    delete /FaultManagement/rest/api/v2/alarms/{alarmFdn}/acknowledgements/{ackFdn}
    unAcknowledgeAlarm (unAcknowledgeAlarm : /FaultManagement/rest/api/v2/alarms/{alarmFdn}/acknowledgements/{ackFdn})
    This is to delete acknowledgement for the specified alarm.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required {} String ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    DELETE https://{NSP ServerIp}:8544/FaultManagement/rest/api/v2/alarms/fdn%3Amodel%3Afm%3AAlarm%3A2350/acknowledgements/1

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: { "response": { "status": 0, "startRow": 0, "endRow": 0, "totalRows": 1, "data": "fdn:model:fm:Alarm:2350 Unacknowledged successfully", "errors": null } }

    External Docs
    See Also :