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