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 V16.4.0; Generic management services
11 url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/
13 - url: '{MnSRoot}/FaultSupervisionMnS/{version}'
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: '#/components/schemas/Dn'
43 $ref: '#/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: '#/components/schemas/NotificationHeader'
61 - $ref: '#/components/schemas/AlarmRecord'
65 $ref: '#/components/schemas/Comments'
67 description: Response in case of error.
71 $ref: '#/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: '#/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: '#/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: '#/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: '#/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: '#/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: '#/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: '#/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: '#/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: '#/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: '#/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: '#/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: '#/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: '#/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: '#/components/schemas/ErrorResponse'
466 #---- Definitions to be moved to comDefs.yaml --------------------------------------#
483 AttributeNameValuePairSet:
486 AttributeValueChangeSet:
488 The key in this map is the attribute name. The value of each key is an array.
489 When only one item is present in the array, it carries the new attribute
490 value. If two items are present, then the first item carries the old value
491 and the second item the new value. The items can be of any type including null.
493 additionalProperties:
509 Header used for all notification types
519 $ref: '#/components/schemas/Uri'
521 $ref: '#/components/schemas/NotificationId'
524 - $ref: '#/components/schemas/AlarmNotificationTypes'
525 #- $ref: 'faultMnS.yaml#/components/schemas/AlarmNotificationTypes'
526 #- $ref: 'provMnS.yaml#/components/schemas/CmNotificationTypes'
529 $ref: '#/components/schemas/DateTime'
531 $ref: '#/components/schemas/SystemDN'
535 Default schema for the response message body in case the request is not
545 #---- End of definitions to be moved to comDefs.yaml -------------------------------#
547 #---- Definition of AlarmRecord ----------------------------------------------------#
554 - COMMUNICATIONS_ALARM
555 - QUALITY_OF_SERVICE_ALARM
556 - PROCESSING_ERROR_ALARM
558 - ENVIRONMENTAL_ALARM
559 - INTEGRITY_VIOLATION
560 - OPERATIONAL_VIOLATION
562 - SECURITY_SERVICE_OR_MECHANISM_VIOLATION
563 - TIME_DOMAIN_VIOLATION
566 The value of the probable cause may be a specific standardized string, or any
567 vendor provided string. Probable cause strings are not standardized in the
568 present document. They may be added in a future version. Up to then the
569 mapping of the generic probable cause strings "PROBABLE_CAUSE_001" to
570 "PROBABLE_CAUSE_005" is vendor specific.
571 The value of the probable cause may also be an integer. The mapping of integer
572 values to probable causes is vendor specific.
611 - $ref: '#/components/schemas/Float'
613 $ref: '#/components/schemas/Float'
620 $ref: '#/components/schemas/ThresholdHysteresis'
622 $ref: '#/components/schemas/ThresholdHysteresis'
626 - observedMeasurement
634 - $ref: '#/components/schemas/Float'
636 $ref: '#/components/schemas/ThresholdLevelInd'
638 $ref: '#/components/schemas/DateTime'
639 CorrelatedNotification:
645 sourceObjectInstance:
646 $ref: '#/components/schemas/Dn'
650 $ref: '#/components/schemas/NotificationId'
651 CorrelatedNotifications:
654 $ref: '#/components/schemas/CorrelatedNotification'
663 The alarmId is not a property of an alarm record. It is used as key
664 in the map of alarm records instead.
668 # $ref: '#/components/schemas/AlarmId'
670 $ref: '#/components/schemas/Dn'
672 $ref: '#/components/schemas/NotificationId'
674 $ref: '#/components/schemas/DateTime'
676 $ref: '#/components/schemas/DateTime'
678 $ref: '#/components/schemas/DateTime'
680 $ref: '#/components/schemas/AlarmType'
682 $ref: '#/components/schemas/ProbableCause'
684 $ref: '#/components/schemas/SpecificProblem'
686 $ref: '#/components/schemas/PerceivedSeverity'
690 $ref: '#/components/schemas/Dn'
692 $ref: '#/components/schemas/TrendIndication'
694 $ref: '#/components/schemas/ThresholdInfo'
695 correlatedNotifications:
696 $ref: '#/components/schemas/CorrelatedNotifications'
697 stateChangeDefinition:
698 $ref: '#/components/schemas/AttributeValueChangeSet'
700 $ref: '#/components/schemas/AttributeNameValuePairSet'
701 proposedRepairActions:
705 additionalInformation:
706 $ref: '#/components/schemas/AttributeNameValuePairSet'
712 $ref: '#/components/schemas/DateTime'
718 $ref: '#/components/schemas/AckState'
728 securityAlarmDetector:
731 #---- Definition of alarm notifications --------------------------------------------#
733 AlarmNotificationTypes:
738 - notifyChangedAlarmGeneral
739 - notifyAckStateChanged
740 - notifyCorrelatedNotificationChanged
743 - notifyAlarmListRebuiltAlarm
744 - notifyPotentialFaultyAlarmList
745 AlarmListAlignmentRequirement:
749 - ALIGNMENT_NOT_REQUIRED
753 - $ref: '#/components/schemas/NotificationHeader'
762 $ref: '#/components/schemas/AlarmId'
764 $ref: '#/components/schemas/AlarmType'
766 $ref: '#/components/schemas/ProbableCause'
768 $ref: '#/components/schemas/SpecificProblem'
770 $ref: '#/components/schemas/PerceivedSeverity'
774 $ref: '#/components/schemas/Dn'
776 $ref: '#/components/schemas/TrendIndication'
778 $ref: '#/components/schemas/ThresholdInfo'
779 correlatedNotifications:
780 $ref: '#/components/schemas/CorrelatedNotifications'
781 stateChangeDefinition:
782 $ref: '#/components/schemas/AttributeValueChangeSet'
784 $ref: '#/components/schemas/AttributeNameValuePairSet'
785 proposedRepairActions:
789 additionalInformation:
790 $ref: '#/components/schemas/AttributeNameValuePairSet'
795 - $ref: '#/components/schemas/NotificationHeader'
804 - securityAlarmDetector
807 $ref: '#/components/schemas/AlarmId'
809 $ref: '#/components/schemas/AlarmType'
811 $ref: '#/components/schemas/ProbableCause'
813 $ref: '#/components/schemas/PerceivedSeverity'
814 correlatedNotifications:
815 $ref: '#/components/schemas/CorrelatedNotifications'
818 additionalInformation:
819 $ref: '#/components/schemas/AttributeNameValuePairSet'
826 securityAlarmDetector:
830 - $ref: '#/components/schemas/NotificationHeader'
839 $ref: '#/components/schemas/AlarmId'
841 $ref: '#/components/schemas/AlarmType'
843 $ref: '#/components/schemas/ProbableCause'
845 $ref: '#/components/schemas/PerceivedSeverity'
846 correlatedNotifications:
847 $ref: '#/components/schemas/CorrelatedNotifications'
854 - $ref: '#/components/schemas/NotificationHeader'
863 $ref: '#/components/schemas/AlarmId'
865 $ref: '#/components/schemas/AlarmType'
867 $ref: '#/components/schemas/ProbableCause'
869 $ref: '#/components/schemas/PerceivedSeverity'
870 NotifyChangedAlarmGeneral:
872 - $ref: '#/components/schemas/NotificationHeader'
879 - changedAlarmAttributes
882 $ref: '#/components/schemas/AlarmId'
884 $ref: '#/components/schemas/AlarmType'
886 $ref: '#/components/schemas/ProbableCause'
888 $ref: '#/components/schemas/SpecificProblem'
890 $ref: '#/components/schemas/PerceivedSeverity'
891 correlatedNotifications:
892 $ref: '#/components/schemas/CorrelatedNotifications'
896 $ref: '#/components/schemas/Dn'
898 $ref: '#/components/schemas/TrendIndication'
900 $ref: '#/components/schemas/ThresholdInfo'
901 stateChangeDefinition:
902 $ref: '#/components/schemas/AttributeValueChangeSet'
904 $ref: '#/components/schemas/AttributeNameValuePairSet'
905 proposedRepairActions:
909 additionalInformation:
910 $ref: '#/components/schemas/AttributeNameValuePairSet'
913 changedAlarmAttributes:
914 $ref: '#/components/schemas/AttributeNameValuePairSet'
915 NotifyChangedSecAlarmGeneral:
917 - $ref: '#/components/schemas/NotificationHeader'
926 - securityAlarmDetector
927 - changedAlarmAttributes
930 $ref: '#/components/schemas/AlarmId'
932 $ref: '#/components/schemas/AlarmType'
934 $ref: '#/components/schemas/ProbableCause'
936 $ref: '#/components/schemas/PerceivedSeverity'
937 correlatedNotifications:
938 $ref: '#/components/schemas/CorrelatedNotifications'
941 additionalInformation:
942 $ref: '#/components/schemas/AttributeNameValuePairSet'
949 securityAlarmDetector:
951 changedAlarmAttributes:
952 $ref: '#/components/schemas/AttributeNameValuePairSet'
953 NotifyCorrelatedNotificationChanged:
955 - $ref: '#/components/schemas/NotificationHeader'
959 - correlatedNotifications
962 $ref: '#/components/schemas/AlarmId'
963 correlatedNotifications:
964 $ref: '#/components/schemas/CorrelatedNotifications'
967 NotifyAckStateChanged:
969 - $ref: '#/components/schemas/NotificationHeader'
980 $ref: '#/components/schemas/AlarmId'
982 $ref: '#/components/schemas/AlarmType'
984 $ref: '#/components/schemas/ProbableCause'
986 $ref: '#/components/schemas/PerceivedSeverity'
988 $ref: '#/components/schemas/AckState'
995 - $ref: '#/components/schemas/NotificationHeader'
1005 $ref: '#/components/schemas/AlarmId'
1007 $ref: '#/components/schemas/AlarmType'
1009 $ref: '#/components/schemas/ProbableCause'
1011 $ref: '#/components/schemas/PerceivedSeverity'
1013 $ref: '#/components/schemas/Comments'
1014 NotifyPotentialFaultyAlarmList:
1016 - $ref: '#/components/schemas/NotificationHeader'
1023 NotifyAlarmListRebuilt:
1025 - $ref: '#/components/schemas/NotificationHeader'
1032 alarmListAlignmentRequirement:
1033 $ref: '#/components/schemas/AlarmListAlignmentRequirement'
1035 #---- Definition of query parameters -----------------------------------------------#
1042 - ALL_ACTIVE_AND_ACKNOWLEDGED_ALARMS
1043 - ALL_ACTIVE_AND_UNACKNOWLEDGED_ALARMS
1044 - ALL_CLEARED_AND_UNACKNOWLEDGED_ALARMS
1045 - ALL_UNACKNOWLEDGED_ALARMS
1047 #---- Definition of patch documents ------------------------------------------------#
1049 MergePatchAcknowledgeAlarm:
1051 Patch document acknowledging or unacknowledging a single alarm. For
1052 acknowleding an alarm the value of ackState is ACKNOWLEDGED, for unacknowleding
1053 an alarm the value of ackState is UNACKNOWLEDGED.
1064 $ref: '#/components/schemas/AckState'
1065 MergePatchClearAlarm:
1066 description: Patch document for clearing a single alarm
1081 #---- Definition of method responses -----------------------------------------------#
1090 $ref: '#/components/schemas/AlarmId'
1094 #---- Definition of resources ------------------------------------------------------#
1103 - indeterminateCount
1122 $ref: '#/components/schemas/DateTime'
1131 Collection of comments. The comment identifiers are allocated by the
1132 MnS producer and used as key in the map.
1134 additionalProperties:
1135 $ref: '#/components/schemas/Comment'
1140 $ref: '#/components/schemas/Uri'
1142 $ref: '#/components/schemas/Long'
1144 $ref: '#/components/schemas/Filter'