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