3 title: Fault Supervision MnS
6 OAS 3.0.1 definition of the Fault Supervision MnS
7 © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
10 description: 3GPP TS 28.532; Generic management services
11 url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/
13 - url: '{MnSRoot}/FaultSupervisionMnS/{MnSversion}'
16 description: See subclause 4.4.3 of TS 32.158
17 default: http://example.com/3GPPManagement
19 description: Version number of the OpenAPI definition
24 summary: Retrieve multiple alarms
26 Retrieves the alarms identified by alarmAckState, baseObjectInstance
33 $ref: '#/components/schemas/AlarmAckState'
34 - name: baseObjectInstance
38 $ref: 'comDefs.yaml#/components/schemas/Dn'
43 $ref: 'comDefs.yaml#/components/schemas/Filter'
47 Success case ("200 OK").
48 Returns the alarms identified in the request. The alarmId is the key
59 lastNotificationHeader:
60 $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
61 - $ref: '#/components/schemas/AlarmRecord'
65 $ref: '#/components/schemas/Comments'
67 description: Response in case of error.
71 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
73 summary: 'Clear, acknowledge or unacknowledge multiple alarms'
75 Clears, acknowledges or unacknowledges multiple alarms using patch. Depending
76 on which action is to be performed, different merge patch documents need
80 Patch documents for acknowledging and unacknowledging, or clearing multiple
81 alarms. The keys in the map are the alarmIds to be patched.
83 application/merge-patch+json:
88 $ref: '#/components/schemas/MergePatchAcknowledgeAlarm'
91 $ref: '#/components/schemas/MergePatchClearAlarm'
95 Success case ("204 No content").
96 The response message body is empty.
98 description: Response in case of error.
104 $ref: '#/components/schemas/FailedAlarm'
107 summary: Get the alarm count per perceived severity
109 - name: alarmAckState
113 $ref: '#/components/schemas/AlarmAckState'
122 Success case ("200 OK").
123 The alarm count per perceived severity is returned.
127 $ref: '#/components/schemas/AlarmCount'
129 description: Response in case of error. The error case needs rework.
133 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
136 summary: 'Clear, acknowledge or unacknowledge a single alarm'
138 Clears, acknowledges or uncknowldeges a single alarm by patching the alarm
139 information. A conditional acknowledge request based on the perceived
140 severity is not supported.
144 description: Identifies the alarm to be patched.
151 application/merge-patch+json:
154 - $ref: '#/components/schemas/MergePatchAcknowledgeAlarm'
155 - $ref: '#/components/schemas/MergePatchClearAlarm'
159 Success case (204 No content).
160 The response message body is absent.
162 description: Response in case of error.
166 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
167 /alarms/{alarmId}/comments:
169 summary: Add a comment to a single alarm
171 Adds a comment to an alarm identified by alarmId. The id of the new comment
172 is allocated by the producer.
176 description: Identifies the alarm to which the comment shall be added.
185 $ref: '#/components/schemas/Comment'
189 Success case (201 Created).
190 The representation of the newly created comment resource shall be returned.
194 $ref: '#/components/schemas/Comment'
197 description: URI of the newly created comment resource.
202 description: Error case.
206 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
210 summary: Create a subscription
212 To create a subscription the representation of the subscription is
213 POSTed on the /subscriptions collection resource.
219 $ref: '#/components/schemas/Subscription'
223 Success case ("201 Created").
224 The representation of the newly created subscription resource shall
229 $ref: '#/components/schemas/Subscription'
232 description: URI of the newly created subscription resource
237 description: Error case.
241 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
244 '{request.body#/consumerReference}':
252 - $ref: '#/components/schemas/NotifyNewAlarm'
253 - $ref: '#/components/schemas/NotifyNewSecAlarm'
257 Success case ("204 No Content").
258 The notification is successfully delivered. The response message
261 description: Error case.
265 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
267 '{request.body#/consumerReference}':
274 $ref: '#/components/schemas/NotifyClearedAlarm'
278 Success case ("204 No Content").
279 The notification is successfully delivered. The response message
282 description: Error case.
286 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
288 '{request.body#/consumerReference}':
295 $ref: '#/components/schemas/NotifyChangedAlarm'
299 Success case ("204 No Content").
300 The notification is successfully delivered. The response message
303 description: Error case.
307 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
308 notifyChangedAlarmGeneral:
309 '{request.body#/consumerReference}':
317 - $ref: '#/components/schemas/NotifyChangedAlarmGeneral'
318 - $ref: '#/components/schemas/NotifyChangedSecAlarmGeneral'
322 Success case ("204 No Content").
323 The notification is successfully delivered. The response message
326 description: Error case.
330 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
331 notifyCorrelatedNotificationChanged:
332 '{request.body#/consumerReference}':
339 $ref: '#/components/schemas/NotifyCorrelatedNotificationChanged'
343 Success case ("204 No Content").
344 The notification is successfully delivered. The response message
347 description: Error case.
351 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
352 notifyAckStateChanged:
353 '{request.body#/consumerReference}':
360 $ref: '#/components/schemas/NotifyAckStateChanged'
364 Success case ("204 No Content").
365 The notification is successfully delivered. The response message
368 description: Error case.
372 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
374 '{request.body#/consumerReference}':
381 $ref: '#/components/schemas/NotifyComments'
385 Success case ("204 No Content").
386 The notification is successfully delivered. The response message
389 description: Error case.
393 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
394 notifyPotentialFaultyAlarmList:
395 '{request.body#/consumerReference}':
402 $ref: '#/components/schemas/NotifyPotentialFaultyAlarmList'
406 Success case ("204 No Content").
407 The notification is successfully delivered. The response message
410 description: Error case.
414 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
415 notifyAlarmListRebuilt:
416 '{request.body#/consumerReference}':
423 $ref: '#/components/schemas/NotifyAlarmListRebuilt'
427 Success case ("204 No Content").
428 The notification is successfully delivered. The response message
431 description: Error case.
435 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
436 /subscriptions/{subscriptionId}:
438 summary: Delete a subscription
440 The subscription is deleted by deleting the corresponding subscription
441 resource. The resource to be deleted is identified with the path
442 component of the URI.
444 - name: subscriptionId
446 description: Identifies the subscription to be deleted.
453 Success case ("204 No Content").
454 The subscription resource has been deleted. The response message body
457 description: Error case.
461 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
466 #---- Definition of AlarmRecord ----------------------------------------------------#
473 - COMMUNICATIONS_ALARM
474 - QUALITY_OF_SERVICE_ALARM
475 - PROCESSING_ERROR_ALARM
477 - ENVIRONMENTAL_ALARM
478 - INTEGRITY_VIOLATION
479 - OPERATIONAL_VIOLATION
481 - SECURITY_SERVICE_OR_MECHANISM_VIOLATION
482 - TIME_DOMAIN_VIOLATION
485 The value of the probable cause may be a specific standardized string, or any
486 vendor provided string. Probable cause strings are not standardized in the
487 present document. They may be added in a future version. Up to then the
488 mapping of the generic probable cause strings "PROBABLE_CAUSE_001" to
489 "PROBABLE_CAUSE_005" is vendor specific.
490 The value of the probable cause may also be an integer. The mapping of integer
491 values to probable causes is vendor specific.
530 - $ref: 'comDefs.yaml#/components/schemas/Float'
532 $ref: 'comDefs.yaml#/components/schemas/Float'
538 $ref: '#/components/schemas/ThresholdHysteresis'
542 $ref: '#/components/schemas/ThresholdHysteresis'
551 - $ref: 'comDefs.yaml#/components/schemas/Float'
553 $ref: '#/components/schemas/ThresholdLevelInd'
555 $ref: 'comDefs.yaml#/components/schemas/DateTime'
557 - observedMeasurement
559 CorrelatedNotification:
562 sourceObjectInstance:
563 $ref: 'comDefs.yaml#/components/schemas/Dn'
567 $ref: 'comDefs.yaml#/components/schemas/NotificationId'
569 - sourceObjectInstance
571 CorrelatedNotifications:
574 $ref: '#/components/schemas/CorrelatedNotification'
583 The alarmId is not a property of an alarm record. It is used as key
584 in the map of alarm records instead.
588 # $ref: '#/components/schemas/AlarmId'
590 $ref: 'comDefs.yaml#/components/schemas/Dn'
592 $ref: 'comDefs.yaml#/components/schemas/NotificationId'
594 $ref: 'comDefs.yaml#/components/schemas/DateTime'
596 $ref: 'comDefs.yaml#/components/schemas/DateTime'
598 $ref: 'comDefs.yaml#/components/schemas/DateTime'
600 $ref: '#/components/schemas/AlarmType'
602 $ref: '#/components/schemas/ProbableCause'
604 $ref: '#/components/schemas/SpecificProblem'
606 $ref: '#/components/schemas/PerceivedSeverity'
610 $ref: 'comDefs.yaml#/components/schemas/Dn'
612 $ref: '#/components/schemas/TrendIndication'
614 $ref: '#/components/schemas/ThresholdInfo'
615 correlatedNotifications:
616 $ref: '#/components/schemas/CorrelatedNotifications'
617 stateChangeDefinition:
618 $ref: 'comDefs.yaml#/components/schemas/AttributeValueChangeSet'
620 $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
621 proposedRepairActions:
625 additionalInformation:
626 $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
632 $ref: 'comDefs.yaml#/components/schemas/DateTime'
638 $ref: '#/components/schemas/AckState'
648 securityAlarmDetector:
651 #---- Definition of alarm notifications --------------------------------------------#
653 AlarmNotificationTypes:
658 - notifyChangedAlarmGeneral
659 - notifyAckStateChanged
660 - notifyCorrelatedNotificationChanged
663 - notifyAlarmListRebuiltAlarm
664 - notifyPotentialFaultyAlarmList
665 AlarmListAlignmentRequirement:
669 - ALIGNMENT_NOT_REQUIRED
673 - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
682 $ref: '#/components/schemas/AlarmId'
684 $ref: '#/components/schemas/AlarmType'
686 $ref: '#/components/schemas/ProbableCause'
688 $ref: '#/components/schemas/SpecificProblem'
690 $ref: '#/components/schemas/PerceivedSeverity'
694 $ref: 'comDefs.yaml#/components/schemas/Dn'
696 $ref: '#/components/schemas/TrendIndication'
698 $ref: '#/components/schemas/ThresholdInfo'
699 correlatedNotifications:
700 $ref: '#/components/schemas/CorrelatedNotifications'
701 stateChangeDefinition:
702 $ref: 'comDefs.yaml#/components/schemas/AttributeValueChangeSet'
704 $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
705 proposedRepairActions:
709 additionalInformation:
710 $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
715 - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
724 - securityAlarmDetector
727 $ref: '#/components/schemas/AlarmId'
729 $ref: '#/components/schemas/AlarmType'
731 $ref: '#/components/schemas/ProbableCause'
733 $ref: '#/components/schemas/PerceivedSeverity'
734 correlatedNotifications:
735 $ref: '#/components/schemas/CorrelatedNotifications'
738 additionalInformation:
739 $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
746 securityAlarmDetector:
750 - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
759 $ref: '#/components/schemas/AlarmId'
761 $ref: '#/components/schemas/AlarmType'
763 $ref: '#/components/schemas/ProbableCause'
765 $ref: '#/components/schemas/PerceivedSeverity'
766 correlatedNotifications:
767 $ref: '#/components/schemas/CorrelatedNotifications'
774 - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
783 $ref: '#/components/schemas/AlarmId'
785 $ref: '#/components/schemas/AlarmType'
787 $ref: '#/components/schemas/ProbableCause'
789 $ref: '#/components/schemas/PerceivedSeverity'
790 NotifyChangedAlarmGeneral:
792 - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
799 $ref: '#/components/schemas/AlarmId'
801 $ref: '#/components/schemas/AlarmType'
803 $ref: '#/components/schemas/ProbableCause'
805 $ref: '#/components/schemas/SpecificProblem'
807 $ref: '#/components/schemas/PerceivedSeverity'
808 correlatedNotifications:
809 $ref: '#/components/schemas/CorrelatedNotifications'
813 $ref: 'comDefs.yaml#/components/schemas/Dn'
815 $ref: '#/components/schemas/TrendIndication'
817 $ref: '#/components/schemas/ThresholdInfo'
818 stateChangeDefinition:
819 $ref: 'comDefs.yaml#/components/schemas/AttributeValueChangeSet'
821 $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
822 proposedRepairActions:
826 additionalInformation:
827 $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
830 changedAlarmAttributes:
831 $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
832 NotifyChangedSecAlarmGeneral:
834 - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
841 - securityAlarmDetector
844 $ref: '#/components/schemas/AlarmId'
846 $ref: '#/components/schemas/AlarmType'
848 $ref: '#/components/schemas/ProbableCause'
850 $ref: '#/components/schemas/PerceivedSeverity'
851 correlatedNotifications:
852 $ref: '#/components/schemas/CorrelatedNotifications'
855 additionalInformation:
856 $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
863 securityAlarmDetector:
865 changedAlarmAttributes:
866 $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
867 NotifyCorrelatedNotificationChanged:
869 - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
873 - correlatedNotifications
876 $ref: '#/components/schemas/AlarmId'
877 correlatedNotifications:
878 $ref: '#/components/schemas/CorrelatedNotifications'
881 NotifyAckStateChanged:
883 - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
894 $ref: '#/components/schemas/AlarmId'
896 $ref: '#/components/schemas/AlarmType'
898 $ref: '#/components/schemas/ProbableCause'
900 $ref: '#/components/schemas/PerceivedSeverity'
902 $ref: '#/components/schemas/AckState'
909 - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
919 $ref: '#/components/schemas/AlarmId'
921 $ref: '#/components/schemas/AlarmType'
923 $ref: '#/components/schemas/ProbableCause'
925 $ref: '#/components/schemas/PerceivedSeverity'
927 $ref: '#/components/schemas/Comments'
928 NotifyPotentialFaultyAlarmList:
930 - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
937 NotifyAlarmListRebuilt:
939 - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
946 alarmListAlignmentRequirement:
947 $ref: '#/components/schemas/AlarmListAlignmentRequirement'
949 #---- Definition of query parameters -----------------------------------------------#
956 - ALL_ACTIVE_AND_ACKNOWLEDGED_ALARMS
957 - ALL_ACTIVE_AND_UNACKNOWLEDGED_ALARMS
958 - ALL_CLEARED_AND_UNACKNOWLEDGED_ALARMS
959 - ALL_UNACKNOWLEDGED_ALARMS
961 #---- Definition of patch documents ------------------------------------------------#
963 MergePatchAcknowledgeAlarm:
965 Patch document acknowledging or unacknowledging a single alarm. For
966 acknowleding an alarm the value of ackState is ACKNOWLEDGED, for unacknowleding
967 an alarm the value of ackState is UNACKNOWLEDGED.
978 $ref: '#/components/schemas/AckState'
979 MergePatchClearAlarm:
980 description: Patch document for clearing a single alarm
995 #---- Definition of method responses -----------------------------------------------#
1004 $ref: '#/components/schemas/AlarmId'
1008 #---- Definition of resources ------------------------------------------------------#
1017 - indeterminateCount
1036 $ref: 'comDefs.yaml#/components/schemas/DateTime'
1045 Collection of comments. The comment identifiers are allocated by the
1046 MnS producer and used as key in the map.
1048 additionalProperties:
1049 $ref: '#/components/schemas/Comment'
1054 $ref: 'comDefs.yaml#/components/schemas/Uri'
1058 $ref: 'comDefs.yaml#/components/schemas/Filter'