summaryrefslogtreecommitdiff
path: root/redfish-core/include/registries/sensor_event_message_registry.hpp
blob: 4692c8ebb65f7f10856a646ee74c3966a93d06ca (plain)
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
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
74
75
76
77
78
79
80
81
82
83
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
#pragma once
/****************************************************************
 *                 READ THIS WARNING FIRST
 * This is an auto-generated header which contains definitions
 * for Redfish DMTF defined messages.
 * DO NOT modify this registry outside of running the
 * parse_registries.py script.  The definitions contained within
 * this file are owned by DMTF.  Any modifications to these files
 * should be first pushed to the relevant registry in the DMTF
 * github organization.
 ***************************************************************/
#include "registries.hpp"

#include <array>

// clang-format off

namespace redfish::registries::sensor_event
{
const Header header = {
    "Copyright 2022-2023 DMTF. All rights reserved.",
    "#MessageRegistry.v1_6_2.MessageRegistry",
    "SensorEvent.1.0.1",
    "Sensor Event Message Registry",
    "en",
    "This registry defines messages used for general events related to Sensor resources.",
    "SensorEvent",
    "1.0.1",
    "DMTF",
};
constexpr const char* url =
    "https://redfish.dmtf.org/registries/SensorEvent.1.0.1.json";

constexpr std::array registry =
{
    MessageEntry{
        "InvalidSensorReading",
        {
            "Indicates that the service received an invalid reading from a sensor.",
            "Invalid reading received from sensor '%1'.",
            "Warning",
            1,
            {
                "string",
            },
            "Check the sensor hardware or connection.",
        }},
    MessageEntry{
        "ReadingAboveLowerCriticalThreshold",
        {
            "Indicates that a sensor reading is no longer below the lower critical threshold but is still outside of normal operating range.",
            "Sensor '%1' reading of %2 (%3) is now above the %4 lower critical threshold but remains outside of normal range.",
            "Warning",
            4,
            {
                "string",
                "number",
                "string",
                "number",
            },
            "Check the condition of the resources listed in RelatedItem.",
        }},
    MessageEntry{
        "ReadingAboveLowerFatalThreshold",
        {
            "Indicates that a sensor reading is no longer below the lower fatal threshold but is still outside of normal operating range.",
            "Sensor '%1' reading of %2 (%3) is now above the %4 lower fatal threshold but remains outside of normal range.",
            "Critical",
            4,
            {
                "string",
                "number",
                "string",
                "number",
            },
            "Check the condition of the resources listed in RelatedItem.",
        }},
    MessageEntry{
        "ReadingAboveUpperCautionThreshold",
        {
            "Indicates that a sensor reading is above the upper caution threshold.",
            "Sensor '%1' reading of %2 (%3) is above the %4 upper caution threshold.",
            "Warning",
            4,
            {
                "string",
                "number",
                "string",
                "number",
            },
            "Check the condition of the resources listed in RelatedItem.",
        }},
    MessageEntry{
        "ReadingAboveUpperCriticalThreshold",
        {
            "Indicates that a sensor reading is above the upper critical threshold.",
            "Sensor '%1' reading of %2 (%3) is above the %4 upper critical threshold.",
            "Critical",
            4,
            {
                "string",
                "number",
                "string",
                "number",
            },
            "Check the condition of the resources listed in RelatedItem.",
        }},
    MessageEntry{
        "ReadingAboveUpperFatalThreshold",
        {
            "Indicates that a sensor reading is above the upper fatal threshold.",
            "Sensor '%1' reading of %2 (%3) is above the %4 upper fatal threshold.",
            "Critical",
            4,
            {
                "string",
                "number",
                "string",
                "number",
            },
            "Check the condition of the resources listed in RelatedItem.",
        }},
    MessageEntry{
        "ReadingBelowLowerCautionThreshold",
        {
            "Indicates that a sensor reading is below the lower caution threshold.",
            "Sensor '%1' reading of %2 (%3) is below the %4 lower caution threshold.",
            "Warning",
            4,
            {
                "string",
                "number",
                "string",
                "number",
            },
            "Check the condition of the resources listed in RelatedItem.",
        }},
    MessageEntry{
        "ReadingBelowLowerCriticalThreshold",
        {
            "Indicates that a sensor reading is below the lower critical threshold.",
            "Sensor '%1' reading of %2 (%3) is below the %4 lower critical threshold.",
            "Critical",
            4,
            {
                "string",
                "number",
                "string",
                "number",
            },
            "Check the condition of the resources listed in RelatedItem.",
        }},
    MessageEntry{
        "ReadingBelowLowerFatalThreshold",
        {
            "Indicates that a sensor reading is below the lower fatal threshold.",
            "Sensor '%1' reading of %2 (%3) is below the %4 lower fatal threshold.",
            "Critical",
            4,
            {
                "string",
                "number",
                "string",
                "number",
            },
            "Check the condition of the resources listed in RelatedItem.",
        }},
    MessageEntry{
        "ReadingBelowUpperCriticalThreshold",
        {
            "Indicates that a sensor reading is no longer above the upper critical threshold but is still outside of normal operating range.",
            "Sensor '%1' reading of %2 (%3) is now below the %4 upper critical threshold but remains outside of normal range.",
            "Warning",
            4,
            {
                "string",
                "number",
                "string",
                "number",
            },
            "Check the condition of the resources listed in RelatedItem.",
        }},
    MessageEntry{
        "ReadingBelowUpperFatalThreshold",
        {
            "Indicates that a sensor reading is no longer above the upper fatal threshold but is still outside of normal operating range.",
            "Sensor '%1' reading of %2 (%3) is now below the %4 upper fatal threshold but remains outside of normal range.",
            "Critical",
            4,
            {
                "string",
                "number",
                "string",
                "number",
            },
            "Check the condition of the resources listed in RelatedItem.",
        }},
    MessageEntry{
        "ReadingCritical",
        {
            "Indicates that a sensor reading exceeds an internal critical level.",
            "Sensor '%1' reading of %2 (%3) exceeds the critical level.",
            "Critical",
            3,
            {
                "string",
                "number",
                "string",
            },
            "Check the condition of the resources listed in RelatedItem.",
        }},
    MessageEntry{
        "ReadingNoLongerCritical",
        {
            "Indicates that a sensor reading no longer exceeds an internal critical level but still exceeds an internal warning level.",
            "Sensor '%1' reading of %2 (%3) no longer exceeds the critical level.",
            "Warning",
            3,
            {
                "string",
                "number",
                "string",
            },
            "Check the condition of the resources listed in RelatedItem.",
        }},
    MessageEntry{
        "ReadingWarning",
        {
            "Indicates that a sensor reading exceeds an internal warning level.",
            "Sensor '%1' reading of %2 (%3) exceeds the warning level.",
            "Warning",
            3,
            {
                "string",
                "number",
                "string",
            },
            "Check the condition of the resources listed in RelatedItem.",
        }},
    MessageEntry{
        "SensorFailure",
        {
            "Indicates that the service cannot communicate with a sensor or has detected a failure.",
            "Sensor '%1' has failed.",
            "Warning",
            1,
            {
                "string",
            },
            "Check the sensor hardware or connection.",
        }},
    MessageEntry{
        "SensorReadingNormalRange",
        {
            "Indicates that a sensor reading is now within normal operating range.",
            "Sensor '%1' reading of %2 (%3) is within normal operating range.",
            "OK",
            3,
            {
                "string",
                "number",
                "string",
            },
            "None.",
        }},
    MessageEntry{
        "SensorRestored",
        {
            "Indicates that a sensor was repaired or communications were restored.  It may also indicate that the service is receiving valid data from a sensor.",
            "Sensor '%1' was restored.",
            "OK",
            1,
            {
                "string",
            },
            "None.",
        }},

};

enum class Index
{
    invalidSensorReading = 0,
    readingAboveLowerCriticalThreshold = 1,
    readingAboveLowerFatalThreshold = 2,
    readingAboveUpperCautionThreshold = 3,
    readingAboveUpperCriticalThreshold = 4,
    readingAboveUpperFatalThreshold = 5,
    readingBelowLowerCautionThreshold = 6,
    readingBelowLowerCriticalThreshold = 7,
    readingBelowLowerFatalThreshold = 8,
    readingBelowUpperCriticalThreshold = 9,
    readingBelowUpperFatalThreshold = 10,
    readingCritical = 11,
    readingNoLongerCritical = 12,
    readingWarning = 13,
    sensorFailure = 14,
    sensorReadingNormalRange = 15,
    sensorRestored = 16,
};
} // namespace redfish::registries::sensor_event