xref: /openbmc/bmcweb/redfish-core/include/registries/environmental_message_registry.hpp (revision 56b81992ba8a8e644f2e75251a94df4f4d0d0880)
1 #pragma once
2 /****************************************************************
3  *                 READ THIS WARNING FIRST
4  * This is an auto-generated header which contains definitions
5  * for Redfish DMTF defined messages.
6  * DO NOT modify this registry outside of running the
7  * parse_registries.py script.  The definitions contained within
8  * this file are owned by DMTF.  Any modifications to these files
9  * should be first pushed to the relevant registry in the DMTF
10  * github organization.
11  ***************************************************************/
12 #include "registries.hpp"
13 
14 #include <array>
15 
16 // clang-format off
17 
18 namespace redfish::registries::environmental
19 {
20 const Header header = {
21     "Copyright 2023 DMTF. All rights reserved.",
22     "#MessageRegistry.v1_6_2.MessageRegistry",
23     1,
24     0,
25     1,
26     "Environmental Message Registry",
27     "en",
28     "This registry defines messages related to environmental sensors, heating and cooling equipment, or other environmental conditions.",
29     "Environmental",
30     "DMTF",
31 };
32 constexpr const char* url =
33     "https://redfish.dmtf.org/registries/Environmental.1.0.1.json";
34 
35 constexpr std::array registry =
36 {
37     MessageEntry{
38         "FanFailed",
39         {
40             "Indicates that a fan has failed.",
41             "Fan '%1' has failed.",
42             "Warning",
43             1,
44             {
45                 "string",
46             },
47             "Check the fan hardware and replace any faulty component.",
48         }},
49     MessageEntry{
50         "FanGroupCritical",
51         {
52             "Indicates that a fan group has a critical status.",
53             "Fan group '%1' is in a critical state.",
54             "Critical",
55             1,
56             {
57                 "string",
58             },
59             "None.",
60         }},
61     MessageEntry{
62         "FanGroupNormal",
63         {
64             "Indicates that a fan group has returned to normal operations.",
65             "Fan group '%1' is operating normally.",
66             "OK",
67             1,
68             {
69                 "string",
70             },
71             "None.",
72         }},
73     MessageEntry{
74         "FanGroupWarning",
75         {
76             "Indicates that a fan group has a warning status.",
77             "Fan group '%1' is in a warning state.",
78             "Warning",
79             1,
80             {
81                 "string",
82             },
83             "None.",
84         }},
85     MessageEntry{
86         "FanInserted",
87         {
88             "Indicates that a fan was inserted or installed.",
89             "Fan '%1' was inserted.",
90             "OK",
91             1,
92             {
93                 "string",
94             },
95             "None.",
96         }},
97     MessageEntry{
98         "FanRemoved",
99         {
100             "Indicates that a fan was removed.",
101             "Fan '%1' was removed.",
102             "OK",
103             1,
104             {
105                 "string",
106             },
107             "None.",
108         }},
109     MessageEntry{
110         "FanRestored",
111         {
112             "Indicates that a fan was repaired or restored to normal operation.",
113             "Fan '%1' was restored.",
114             "OK",
115             1,
116             {
117                 "string",
118             },
119             "None.",
120         }},
121     MessageEntry{
122         "HumidityAboveLowerCriticalThreshold",
123         {
124             "Indicates that a humidity reading is no longer below the lower critical threshold but is still outside of normal operating range.",
125             "Humidity '%1' reading of %2 percent is now above the %3 lower critical threshold but remains outside of normal range.",
126             "Warning",
127             3,
128             {
129                 "string",
130                 "number",
131                 "number",
132             },
133             "Check the condition of the resource listed in OriginOfCondition.",
134         }},
135     MessageEntry{
136         "HumidityAboveUpperCautionThreshold",
137         {
138             "Indicates that a humidity reading is above the upper caution threshold.",
139             "Humidity '%1' reading of %2 percent is above the %3 upper caution threshold.",
140             "Warning",
141             3,
142             {
143                 "string",
144                 "number",
145                 "number",
146             },
147             "Check the condition of the resource listed in OriginOfCondition.",
148         }},
149     MessageEntry{
150         "HumidityAboveUpperCriticalThreshold",
151         {
152             "Indicates that a humidity reading is above the upper critical threshold.",
153             "Humidity '%1' reading of %2 percent is above the %3 upper critical threshold.",
154             "Critical",
155             3,
156             {
157                 "string",
158                 "number",
159                 "number",
160             },
161             "Check the condition of the resource listed in OriginOfCondition.",
162         }},
163     MessageEntry{
164         "HumidityBelowLowerCautionThreshold",
165         {
166             "Indicates that a humidity reading is below the lower caution threshold.",
167             "Humidity '%1' reading of %2 percent is below the %3 lower caution threshold.",
168             "Warning",
169             3,
170             {
171                 "string",
172                 "number",
173                 "number",
174             },
175             "Check the condition of the resource listed in OriginOfCondition.",
176         }},
177     MessageEntry{
178         "HumidityBelowLowerCriticalThreshold",
179         {
180             "Indicates that a humidity reading is below the lower critical threshold.",
181             "Humidity '%1' reading of %2 percent is below the %3 lower critical threshold.",
182             "Critical",
183             3,
184             {
185                 "string",
186                 "number",
187                 "number",
188             },
189             "Check the condition of the resource listed in OriginOfCondition.",
190         }},
191     MessageEntry{
192         "HumidityBelowUpperCriticalThreshold",
193         {
194             "Indicates that a humidity reading is no longer above the upper critical threshold but is still outside of normal operating range.",
195             "Humidity '%1' reading of %2 percent is now below the %3 upper critical threshold but remains outside of normal range.",
196             "Warning",
197             3,
198             {
199                 "string",
200                 "number",
201                 "number",
202             },
203             "Check the condition of the resource listed in OriginOfCondition.",
204         }},
205     MessageEntry{
206         "HumidityNormal",
207         {
208             "Indicates that a humidity reading is now within normal operating range.",
209             "Humidity '%1' reading of %2 percent is within normal operating range.",
210             "OK",
211             2,
212             {
213                 "string",
214                 "number",
215             },
216             "None.",
217         }},
218     MessageEntry{
219         "TemperatureAboveLowerCriticalThreshold",
220         {
221             "Indicates that a temperature reading is no longer below the lower critical threshold but is still outside of normal operating range.",
222             "Temperature '%1' reading of %2 degrees (C) is now above the %3 lower critical threshold but remains outside of normal range.",
223             "Warning",
224             3,
225             {
226                 "string",
227                 "number",
228                 "number",
229             },
230             "Check the condition of the resource listed in OriginOfCondition.",
231         }},
232     MessageEntry{
233         "TemperatureAboveLowerFatalThreshold",
234         {
235             "Indicates that a temperature reading is no longer below the lower fatal threshold but is still outside of normal operating range.",
236             "Temperature '%1' reading of %2 degrees (C) is now above the %3 lower fatal threshold but remains outside of normal range.",
237             "Critical",
238             3,
239             {
240                 "string",
241                 "number",
242                 "number",
243             },
244             "Check the condition of the resource listed in OriginOfCondition.",
245         }},
246     MessageEntry{
247         "TemperatureAboveUpperCautionThreshold",
248         {
249             "Indicates that a temperature reading is above the upper caution threshold.",
250             "Temperature '%1' reading of %2 degrees (C) is above the %3 upper caution threshold.",
251             "Warning",
252             3,
253             {
254                 "string",
255                 "number",
256                 "number",
257             },
258             "Check the condition of the resource listed in OriginOfCondition.",
259         }},
260     MessageEntry{
261         "TemperatureAboveUpperCriticalThreshold",
262         {
263             "Indicates that a temperature reading is above the upper critical threshold.",
264             "Temperature '%1' reading of %2 degrees (C) is above the %3 upper critical threshold.",
265             "Critical",
266             3,
267             {
268                 "string",
269                 "number",
270                 "number",
271             },
272             "Check the condition of the resource listed in OriginOfCondition.",
273         }},
274     MessageEntry{
275         "TemperatureAboveUpperFatalThreshold",
276         {
277             "Indicates that a temperature reading is above the upper fatal threshold.",
278             "Temperature '%1' reading of %2 degrees (C) is above the %3 upper fatal threshold.",
279             "Critical",
280             3,
281             {
282                 "string",
283                 "number",
284                 "number",
285             },
286             "Check the condition of the resource listed in OriginOfCondition.",
287         }},
288     MessageEntry{
289         "TemperatureBelowLowerCautionThreshold",
290         {
291             "Indicates that a temperature reading is below the lower caution threshold.",
292             "Temperature '%1' reading of %2 degrees (C) is below the %3 lower caution threshold.",
293             "Warning",
294             3,
295             {
296                 "string",
297                 "number",
298                 "number",
299             },
300             "Check the condition of the resource listed in OriginOfCondition.",
301         }},
302     MessageEntry{
303         "TemperatureBelowLowerCriticalThreshold",
304         {
305             "Indicates that a temperature reading is below the lower critical threshold.",
306             "Temperature '%1' reading of %2 degrees (C) is below the %3 lower critical threshold.",
307             "Critical",
308             3,
309             {
310                 "string",
311                 "number",
312                 "number",
313             },
314             "Check the condition of the resource listed in OriginOfCondition.",
315         }},
316     MessageEntry{
317         "TemperatureBelowLowerFatalThreshold",
318         {
319             "Indicates that a temperature reading is below the lower fatal threshold.",
320             "Temperature '%1' reading of %2 degrees (C) is below the %3 lower fatal threshold.",
321             "Critical",
322             3,
323             {
324                 "string",
325                 "number",
326                 "number",
327             },
328             "Check the condition of the resource listed in OriginOfCondition.",
329         }},
330     MessageEntry{
331         "TemperatureBelowUpperCriticalThreshold",
332         {
333             "Indicates that a temperature reading is no longer above the upper critical threshold but is still outside of normal operating range.",
334             "Temperature '%1' reading of %2 degrees (C) is now below the %3 upper critical threshold but remains outside of normal range.",
335             "Warning",
336             3,
337             {
338                 "string",
339                 "number",
340                 "number",
341             },
342             "Check the condition of the resource listed in OriginOfCondition.",
343         }},
344     MessageEntry{
345         "TemperatureBelowUpperFatalThreshold",
346         {
347             "Indicates that a temperature reading is no longer above the upper fatal threshold but is still outside of normal operating range.",
348             "Temperature '%1' reading of %2 degrees (C) is now below the %3 upper fatal threshold but remains outside of normal range.",
349             "Critical",
350             3,
351             {
352                 "string",
353                 "number",
354                 "number",
355             },
356             "Check the condition of the resource listed in OriginOfCondition.",
357         }},
358     MessageEntry{
359         "TemperatureCritical",
360         {
361             "Indicates that a temperature reading exceeds an internal critical level.",
362             "Temperature '%1' reading of %2 degrees (C) exceeds the critical level.",
363             "Critical",
364             2,
365             {
366                 "string",
367                 "number",
368             },
369             "Check the condition of the resource listed in OriginOfCondition.",
370         }},
371     MessageEntry{
372         "TemperatureNoLongerCritical",
373         {
374             "Indicates that a temperature reading no longer exceeds an internal critical level but still exceeds an internal warning level.",
375             "Temperature '%1' reading of %2 degrees (C) no longer exceeds the critical level.",
376             "Warning",
377             2,
378             {
379                 "string",
380                 "number",
381             },
382             "Check the condition of the resource listed in OriginOfCondition.",
383         }},
384     MessageEntry{
385         "TemperatureNormal",
386         {
387             "Indicates that a temperature reading is now within normal operating range.",
388             "Temperature '%1' reading of %2 degrees (C) is within normal operating range.",
389             "OK",
390             2,
391             {
392                 "string",
393                 "number",
394             },
395             "None.",
396         }},
397     MessageEntry{
398         "TemperatureWarning",
399         {
400             "Indicates that a temperature reading exceeds an internal warning level.",
401             "Temperature '%1' reading of %2 degrees (C) exceeds the warning level.",
402             "Warning",
403             2,
404             {
405                 "string",
406                 "number",
407             },
408             "Check the condition of the resource listed in OriginOfCondition.",
409         }},
410 
411 };
412 
413 enum class Index
414 {
415     fanFailed = 0,
416     fanGroupCritical = 1,
417     fanGroupNormal = 2,
418     fanGroupWarning = 3,
419     fanInserted = 4,
420     fanRemoved = 5,
421     fanRestored = 6,
422     humidityAboveLowerCriticalThreshold = 7,
423     humidityAboveUpperCautionThreshold = 8,
424     humidityAboveUpperCriticalThreshold = 9,
425     humidityBelowLowerCautionThreshold = 10,
426     humidityBelowLowerCriticalThreshold = 11,
427     humidityBelowUpperCriticalThreshold = 12,
428     humidityNormal = 13,
429     temperatureAboveLowerCriticalThreshold = 14,
430     temperatureAboveLowerFatalThreshold = 15,
431     temperatureAboveUpperCautionThreshold = 16,
432     temperatureAboveUpperCriticalThreshold = 17,
433     temperatureAboveUpperFatalThreshold = 18,
434     temperatureBelowLowerCautionThreshold = 19,
435     temperatureBelowLowerCriticalThreshold = 20,
436     temperatureBelowLowerFatalThreshold = 21,
437     temperatureBelowUpperCriticalThreshold = 22,
438     temperatureBelowUpperFatalThreshold = 23,
439     temperatureCritical = 24,
440     temperatureNoLongerCritical = 25,
441     temperatureNormal = 26,
442     temperatureWarning = 27,
443 };
444 } // namespace redfish::registries::environmental
445