1 /****************************************************************
2  *                 READ THIS WARNING FIRST
3  * This is an auto-generated header which contains definitions
4  * for Redfish DMTF defined messages.
5  * DO NOT modify this registry outside of running the
6  * parse_registries.py script.  The definitions contained within
7  * this file are owned by DMTF.  Any modifications to these files
8  * should be first pushed to the relevant registry in the DMTF
9  * github organization.
10  ***************************************************************/
11 #pragma once
12 #include <registries.hpp>
13 
14 // clang-format off
15 
16 namespace redfish::registries::resource_event
17 {
18 const Header header = {
19     "Copyright 2014-2020 DMTF in cooperation with the Storage Networking Industry Association (SNIA). All rights reserved.",
20     "#MessageRegistry.v1_4_0.MessageRegistry",
21     "ResourceEvent.1.0.3",
22     "Resource Event Message Registry",
23     "en",
24     "This registry defines the messages to use for resource events.",
25     "ResourceEvent",
26     "1.0.3",
27     "DMTF",
28 };
29 constexpr const char* url =
30     "https://redfish.dmtf.org/registries/ResourceEvent.1.0.3.json";
31 
32 constexpr std::array registry =
33 {
34     MessageEntry{
35         "LicenseAdded",
36         {
37             "Indicates that a license has been added.",
38             "A license for '%1' has been added.  The following message was returned: '%2'.",
39             "OK",
40             2,
41             {
42                 "string",
43                 "string",
44             },
45             "See vendor specific instructions for specific actions.",
46         }},
47     MessageEntry{
48         "LicenseChanged",
49         {
50             "Indicates that a license has changed.",
51             "A license for '%1' has changed.  The following message was returned: '%2'.",
52             "Warning",
53             2,
54             {
55                 "string",
56                 "string",
57             },
58             "See vendor specific instructions for specific actions.",
59         }},
60     MessageEntry{
61         "LicenseExpired",
62         {
63             "Indicates that a license has expired.",
64             "A license for '%1' has expired.  The following message was returned: '%2'.",
65             "Warning",
66             2,
67             {
68                 "string",
69                 "string",
70             },
71             "See vendor specific instructions for specific actions.",
72         }},
73     MessageEntry{
74         "ResourceChanged",
75         {
76             "Indicates that one or more resource properties have changed.  This is not used whenever there is another event message for that specific change, such as only the state has changed.",
77             "One or more resource properties have changed.",
78             "OK",
79             0,
80             {},
81             "None.",
82         }},
83     MessageEntry{
84         "ResourceCreated",
85         {
86             "Indicates that all conditions of a successful creation operation have been met.",
87             "The resource has been created successfully.",
88             "OK",
89             0,
90             {},
91             "None",
92         }},
93     MessageEntry{
94         "ResourceErrorThresholdCleared",
95         {
96             "Indicates that a specified resource property has cleared its error threshold.  Examples would be drive I/O errors, or network link errors.",
97             "The resource property %1 has cleared the error threshold of value %2.",
98             "OK",
99             2,
100             {
101                 "string",
102                 "number",
103             },
104             "None.",
105         }},
106     MessageEntry{
107         "ResourceErrorThresholdExceeded",
108         {
109             "Indicates that a specified resource property has exceeded its error threshold.  Examples would be drive I/O errors, or network link errors.",
110             "The resource property %1 has exceeded error threshold of value %2.",
111             "Critical",
112             2,
113             {
114                 "string",
115                 "number",
116             },
117             "None.",
118         }},
119     MessageEntry{
120         "ResourceErrorsCorrected",
121         {
122             "Indicates that a specified resource property has corrected errors.  Examples would be drive I/O errors, or network link errors.",
123             "The resource property %1 has corrected errors of type '%2'.",
124             "OK",
125             2,
126             {
127                 "string",
128                 "string",
129             },
130             "None.",
131         }},
132     MessageEntry{
133         "ResourceErrorsDetected",
134         {
135             "Indicates that a specified resource property has detected errors.  Examples would be drive I/O errors, or network link errors.",
136             "The resource property %1 has detected errors of type '%2'.",
137             "Warning",
138             2,
139             {
140                 "string",
141                 "string",
142             },
143             "Resolution dependent upon error type.",
144         }},
145     MessageEntry{
146         "ResourceRemoved",
147         {
148             "Indicates that all conditions of a successful remove operation have been met.",
149             "The resource has been removed successfully.",
150             "OK",
151             0,
152             {},
153             "None",
154         }},
155     MessageEntry{
156         "ResourceSelfTestCompleted",
157         {
158             "Indicates that a self-test has completed.",
159             "A self-test has completed.",
160             "OK",
161             0,
162             {},
163             "None.",
164         }},
165     MessageEntry{
166         "ResourceSelfTestFailed",
167         {
168             "Indicates that a self-test has failed.  Suggested resolution may be provided as OEM data.",
169             "A self-test has failed.  The following message was returned: '%1'.",
170             "Critical",
171             1,
172             {
173                 "string",
174             },
175             "See vendor specific instructions for specific actions.",
176         }},
177     MessageEntry{
178         "ResourceStatusChangedCritical",
179         {
180             "Indicates that the health of a resource has changed to Critical.",
181             "The health of resource `%1` has changed to %2.",
182             "Critical",
183             2,
184             {
185                 "string",
186                 "string",
187             },
188             "None.",
189         }},
190     MessageEntry{
191         "ResourceStatusChangedOK",
192         {
193             "Indicates that the health of a resource has changed to OK.",
194             "The health of resource '%1' has changed to %2.",
195             "OK",
196             2,
197             {
198                 "string",
199                 "string",
200             },
201             "None.",
202         }},
203     MessageEntry{
204         "ResourceStatusChangedWarning",
205         {
206             "Indicates that the health of a resource has changed to Warning.",
207             "The health of resource `%1` has changed to %2.",
208             "Warning",
209             2,
210             {
211                 "string",
212                 "string",
213             },
214             "None.",
215         }},
216     MessageEntry{
217         "ResourceVersionIncompatible",
218         {
219             "Indicates that an incompatible version of software has been detected.  Examples may be after a component or system level software update.",
220             "An incompatible version of software '%1' has been detected.",
221             "Warning",
222             1,
223             {
224                 "string",
225             },
226             "Compare the version of the resource with the compatible version of the software.",
227         }},
228     MessageEntry{
229         "ResourceWarningThresholdCleared",
230         {
231             "Indicates that a specified resource property has cleared its warning threshold.  Examples would be drive I/O errors, or network link errors.  Suggested resolution may be provided as OEM data.",
232             "The resource property %1 has cleared the warning threshold of value %2.",
233             "OK",
234             2,
235             {
236                 "string",
237                 "number",
238             },
239             "None.",
240         }},
241     MessageEntry{
242         "ResourceWarningThresholdExceeded",
243         {
244             "Indicates that a specified resource property has exceeded its warning threshold.  Examples would be drive I/O errors, or network link errors.  Suggested resolution may be provided as OEM data.",
245             "The resource property %1 has exceeded its warning threshold of value %2.",
246             "Warning",
247             2,
248             {
249                 "string",
250                 "number",
251             },
252             "None.",
253         }},
254     MessageEntry{
255         "URIForResourceChanged",
256         {
257             "Indicates that the URI for a resource has changed.  Examples for this would be physical component replacement or redistribution.",
258             "The URI for the resource has changed.",
259             "OK",
260             0,
261             {},
262             "None.",
263         }},
264 
265 };
266 
267 enum class Index
268 {
269     licenseAdded = 0,
270     licenseChanged = 1,
271     licenseExpired = 2,
272     resourceChanged = 3,
273     resourceCreated = 4,
274     resourceErrorThresholdCleared = 5,
275     resourceErrorThresholdExceeded = 6,
276     resourceErrorsCorrected = 7,
277     resourceErrorsDetected = 8,
278     resourceRemoved = 9,
279     resourceSelfTestCompleted = 10,
280     resourceSelfTestFailed = 11,
281     resourceStatusChangedCritical = 12,
282     resourceStatusChangedOK = 13,
283     resourceStatusChangedWarning = 14,
284     resourceVersionIncompatible = 15,
285     resourceWarningThresholdCleared = 16,
286     resourceWarningThresholdExceeded = 17,
287     uRIForResourceChanged = 18,
288 };
289 } // namespace redfish::registries::resource_event
290