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::update
19 {
20 const Header header = {
21     "Copyright 2014-2023 DMTF. All rights reserved.",
22     "#MessageRegistry.v1_6_2.MessageRegistry",
23     1,
24     0,
25     2,
26     "Update Message Registry",
27     "en",
28     "This registry defines the update status and error messages.",
29     "Update",
30     "DMTF",
31 };
32 constexpr const char* url =
33     "https://redfish.dmtf.org/registries/Update.1.0.2.json";
34 
35 constexpr std::array registry =
36 {
37     MessageEntry{
38         "ActivateFailed",
39         {
40             "Indicates that the component failed to activate the image.",
41             "Activation of image '%1' on '%2' failed.",
42             "Critical",
43             2,
44             {
45                 "string",
46                 "string",
47             },
48             "None.",
49         }},
50     MessageEntry{
51         "AllTargetsDetermined",
52         {
53             "Indicates that all target resources or devices for an update operation were determined by the service.",
54             "All the target devices to be updated were determined.",
55             "OK",
56             0,
57             {},
58             "None.",
59         }},
60     MessageEntry{
61         "ApplyFailed",
62         {
63             "Indicates that the component failed to apply an image.",
64             "Installation of image '%1' to '%2' failed.",
65             "Critical",
66             2,
67             {
68                 "string",
69                 "string",
70             },
71             "None.",
72         }},
73     MessageEntry{
74         "ApplyingOnComponent",
75         {
76             "Indicates that a component is applying an image.",
77             "Image '%1' is being applied on '%2'.",
78             "OK",
79             2,
80             {
81                 "string",
82                 "string",
83             },
84             "None.",
85         }},
86     MessageEntry{
87         "AwaitToActivate",
88         {
89             "Indicates that the resource or device is waiting for an action to proceed with activating an image.",
90             "Awaiting for an action to proceed with activating image '%1' on '%2'.",
91             "OK",
92             2,
93             {
94                 "string",
95                 "string",
96             },
97             "Perform the requested action to advance the update operation.",
98         }},
99     MessageEntry{
100         "AwaitToUpdate",
101         {
102             "Indicates that the resource or device is waiting for an action to proceed with installing an image.",
103             "Awaiting for an action to proceed with installing image '%1' on '%2'.",
104             "OK",
105             2,
106             {
107                 "string",
108                 "string",
109             },
110             "Perform the requested action to advance the update operation.",
111         }},
112     MessageEntry{
113         "InstallingOnComponent",
114         {
115             "Indicates that a component is installing an image.",
116             "Image '%1' is being installed on '%2'.",
117             "OK",
118             2,
119             {
120                 "string",
121                 "string",
122             },
123             "None.",
124         }},
125     MessageEntry{
126         "OperationTransitionedToJob",
127         {
128             "Indicates that the update operation transitioned to a job for managing the progress of the operation.",
129             "The update operation has transitioned to the job at URI '%1'.",
130             "OK",
131             1,
132             {
133                 "string",
134             },
135             "Follow the referenced job and monitor the job for further updates.",
136         }},
137     MessageEntry{
138         "TargetDetermined",
139         {
140             "Indicates that a target resource or device for an image was determined for update.",
141             "The target device '%1' will be updated with image '%2'.",
142             "OK",
143             2,
144             {
145                 "string",
146                 "string",
147             },
148             "None.",
149         }},
150     MessageEntry{
151         "TransferFailed",
152         {
153             "Indicates that the service failed to transfer an image to a component.",
154             "Transfer of image '%1' to '%2' failed.",
155             "Critical",
156             2,
157             {
158                 "string",
159                 "string",
160             },
161             "None.",
162         }},
163     MessageEntry{
164         "TransferringToComponent",
165         {
166             "Indicates that the service is transferring an image to a component.",
167             "Image '%1' is being transferred to '%2'.",
168             "OK",
169             2,
170             {
171                 "string",
172                 "string",
173             },
174             "None.",
175         }},
176     MessageEntry{
177         "UpdateInProgress",
178         {
179             "Indicates that an update is in progress.",
180             "An update is in progress.",
181             "OK",
182             0,
183             {},
184             "None.",
185         }},
186     MessageEntry{
187         "UpdateSuccessful",
188         {
189             "Indicates that a resource or device was updated.",
190             "Device '%1' successfully updated with image '%2'.",
191             "OK",
192             2,
193             {
194                 "string",
195                 "string",
196             },
197             "None.",
198         }},
199     MessageEntry{
200         "VerificationFailed",
201         {
202             "Indicates that the component failed to verify an image.",
203             "Verification of image '%1' at '%2' failed.",
204             "Critical",
205             2,
206             {
207                 "string",
208                 "string",
209             },
210             "None.",
211         }},
212     MessageEntry{
213         "VerifyingAtComponent",
214         {
215             "Indicates that a component is verifying an image.",
216             "Image '%1' is being verified at '%2'.",
217             "OK",
218             2,
219             {
220                 "string",
221                 "string",
222             },
223             "None.",
224         }},
225 
226 };
227 
228 enum class Index
229 {
230     activateFailed = 0,
231     allTargetsDetermined = 1,
232     applyFailed = 2,
233     applyingOnComponent = 3,
234     awaitToActivate = 4,
235     awaitToUpdate = 5,
236     installingOnComponent = 6,
237     operationTransitionedToJob = 7,
238     targetDetermined = 8,
239     transferFailed = 9,
240     transferringToComponent = 10,
241     updateInProgress = 11,
242     updateSuccessful = 12,
243     verificationFailed = 13,
244     verifyingAtComponent = 14,
245 };
246 } // namespace redfish::registries::update
247