alarm.schema.json 9.83 KB
Newer Older
aureliano sinatra's avatar
aureliano sinatra committed
1
{
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
    "description": "The alarm data type encapsulates information about an alarm. It shall comply with the provisions defined in Table 8.5.2.4-1\n",
    "type": "object",
    "required": [
      "id",
      "managedObjectId",
      "alarmRaisedTime",
      "ackState",
      "perceivedSeverity",
      "eventTime",
      "eventType",
      "probableCause",
      "isRootCause",
      "_links"
    ],
    "properties": {
      "id": {
        "description": "An identifier with the intention of being globally unique.\n",
        "type": "string"
      },
      "managedObjectId": {
        "description": "An identifier with the intention of being globally unique.\n",
        "type": "string"
      },
      "rootCauseFaultyComponent": {
        "description": "This type represents the faulty component that has a negative impact on an NS.  It shall comply with the provisions defined in Table 8.5.3.4-1.\n",
        "type": "object",
        "properties": {
          "faultyNestedNsInstanceId": {
            "description": "An identifier with the intention of being globally unique.\n",
            "type": "string"
          },
          "faultyResourceType": {
            "description": "An identifier with the intention of being globally unique.\n",
            "type": "string"
          },
          "faultyNsVirtualLinkInstanceId": {
            "description": "An identifier with the intention of being globally unique.\n",
            "type": "string"
          }
41
        }
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
      },
      "rootCauseFaultyResource": {
        "description": "This type represents the faulty virtual resources that have a negative impact on a NS.\n",
        "type": "object",
        "required": [
          "faultyResource",
          "faultyResourceType"
        ],
        "properties": {
          "faultyResource": {
            "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n",
            "type": "object",
            "required": [
              "resourceId"
            ],
            "properties": {
              "vimId": {
                "description": "An identifier with the intention of being globally unique.\n",
                "type": "string"
              },
              "resourceProviderId": {
                "description": "An identifier with the intention of being globally unique.\n",
                "type": "string"
              },
              "resourceId": {
                "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n",
                "type": "string"
              },
              "vimLevelResourceType": {
                "description": "Type of the resource in the scope of the VIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM or the resource provider and can be used as information that complements the ResourceHandle.\n",
                "type": "string"
              }
74
            }
75
76
77
78
79
80
81
82
83
          },
          "faultyResourceType": {
            "description": "The enumeration FaultyResourceType represents those types of faulty resource. Acceptable values are: - COMPUTE - Virtual compute resource. - STORAGE - Virtual storage resource. - NETWORK - Virtual network resource.\n",
            "type": "string",
            "enum": [
              "COMPUTE",
              "STORAGE",
              "NETWORK"
            ]
84
85
          }
        }
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
      },
      "alarmRaisedTime": {
        "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
        "format": "date-time"
      },
      "alarmChangedTime": {
        "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
        "format": "date-time"
      },
      "alarmClearedTime": {
        "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
        "format": "date-time"
      },
      "alarmAcknowledgedTime": {
        "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
        "format": "date-time"
      },
      "ackState": {
        "description": "Acknowledgment state of the alarm. Permitted values: UNACKNOWLEDGED ACKNOWLEDGED\n",
        "type": "string",
        "enum": [
          "UNACKNOWLEDGED",
          "ACKNOWLEDGED"
        ]
      },
      "perceivedSeverity": {
        "description": "Indicates the relative level of urgency for operator attention. * CRITICAL: The Critical severity level indicates that a service\n  affecting condition has occurred and an immediate corrective action\n  is required. Such a severity can be reported, for example, when a\n  managed object becomes totally out of service and its capability needs\n  to be restored (ITU-T Recommendation X.733).\n* MAJOR: The Major severity level indicates that a service affecting\n  condition has developed and an urgent corrective action is required.\n  Such a severity can be reported, for example, when there is a severe\n  degradation in the capability of the managed object and its full\n  capability needs to be restored (ITU-T Recommendation X.733).\n* MINOR: The Minor severity level indicates the existence of a\n  non-service affecting fault condition and that corrective action\n  should be taken in order to prevent a more serious (for example,\n  service affecting) fault. Such a severity can be reported, for\n  example, when the detected alarm condition is not currently degrading\n  the capacity of the managed object (ITU-T Recommendation X.733).\n* WARNING: The Warning severity level indicates the detection of a\n  potential or impending service affecting fault, before any significant\n  effects have been felt. Action should be taken to further diagnose (if\n  necessary) and correct the problem in order to prevent it from\n  becoming a more serious service affecting fault (ITU-T Recommendation\n  X.733).\n* INDETERMINATE: The Indeterminate severity level indicates that the\n  severity level cannot be determined (ITU-T Recommendation X.733).\n* CLEARED: The Cleared severity level indicates the clearing of one or\n  more previously reported alarms. This alarm clears all alarms for this\n  managed object that have the same Alarm type, Probable cause and\n  Specific problems (if given) (ITU-T Recommendation X.733).\n",
        "type": "string",
        "enum": [
          "CRITICAL",
          "MAJOR",
          "MINOR",
          "WARNING",
          "INDETERMINATE",
          "CLEARED"
        ]
      },
      "eventTime": {
        "description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
        "format": "date-time"
      },
      "eventType": {
        "description": "The enumeration EventType represents those types of events that trigger an alarm. - COMMUNICATIONS_ALARM: An alarm of this type is associated with the\n  procedure and/or process required conveying information from one point\n  to another (ITU-T Recommendation X.733).\n- PROCESSING_ERROR_ALARM: An alarm of this type is associated with a\n  software or processing fault (ITU-T Recommendation X.733).\n- ENVIRONMENTAL_ALARM: An alarm of this type is associated with a\n  condition related to an enclosure in which the equipment resides\n  (ITU-T Recommendation X.733).\n- QOS_ALARM: An alarm of this type is associated with degradation in the\n  quality of a service (ITU-T Recommendation X.733).\n- EQUIPMENT_ALARM: An alarm of this type is associated with an equipment\n  fault (ITU-T Recommendation X.733).\n",
        "type": "string",
        "enum": [
          "COMMUNICATIONS_ALARM",
          "PROCESSING_ERROR_ALARM",
          "ENVIRONMENTAL_ALARM",
          "QOS_ALARM",
          "EQUIPMENT_ALARM"
        ]
      },
      "faultType": {
        "description": "Additional information to clarify the type of the fault.\n",
140
        "type": "string"
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
      },
      "probableCause": {
        "description": "Information about the probable cause of the fault.\n",
        "type": "string"
      },
      "isRootCause": {
        "description": "Attribute indicating if this fault is the root for other correlated alarms. If TRUE, then the alarms listed in the attribute CorrelatedAlarmId are caused by this fault.\n",
        "type": "boolean"
      },
      "correlatedAlarmIds": {
        "description": "List of identifiers of other alarms correlated to this fault.\n",
        "type": "array",
        "items": {
          "description": "An identifier with the intention of being globally unique.\n",
          "type": "string"
        }
      },
      "faultDetails": {
        "description": "Provides additional information about the fault..\n",
160
161
162
163
        "type": "array",
        "items": {
          "type": "string"
        }
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
      },
      "_links": {
        "description": "Links for this resource.\n",
        "type": "object",
        "required": [
          "self"
        ],
        "properties": {
          "self": {
            "description": "This type represents a link to a resource.\n",
            "type": "object",
            "required": [
              "href"
            ],
            "properties": {
              "href": {
                "description": "URI of a resource referenced from a notification. Should be an absolute URI (i.e. a URI that contains {apiRoot}), however, may be a relative URI (i.e. a URI where the {apiRoot} part is omitted) if the {apiRoot} information is not available.\n",
                "type": "string",
                "format": "url"
              }
184
            }
aureliano sinatra's avatar
aureliano sinatra committed
185
186
187
188
          }
        }
      }
    }
189
  }