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
21 {
22 struct Base
23 {
24 static constexpr Header header = {
25 "Copyright 2014-2024 DMTF. All rights reserved.",
26 "#MessageRegistry.v1_6_2.MessageRegistry",
27 1,
28 19,
29 0,
30 "Base Message Registry",
31 "en",
32 "This registry defines the base messages for Redfish.",
33 "Base",
34 "DMTF",
35 };
36
37 static constexpr const char* url =
38 "https://redfish.dmtf.org/registries/Base.1.19.0.json";
39
40 static constexpr std::array registry =
41 {
42 MessageEntry{
43 "AccessDenied",
44 {
45 "Indicates that while attempting to access, connect to, or transfer to or from another resource, the service denied access.",
46 "While attempting to establish a connection to '%1', the service denied access.",
47 "Critical",
48 1,
49 {
50 "string",
51 },
52 "Attempt to ensure that the URI is correct and that the service has the appropriate credentials.",
53 }},
54 MessageEntry{
55 "AccountForSessionNoLongerExists",
56 {
57 "Indicates that the account for the session was removed, and so the session was removed as well.",
58 "The account for the current session was removed, and so the current session was removed as well.",
59 "OK",
60 0,
61 {},
62 "Attempt to connect with a valid account.",
63 }},
64 MessageEntry{
65 "AccountModified",
66 {
67 "Indicates that the account was successfully modified.",
68 "The account was successfully modified.",
69 "OK",
70 0,
71 {},
72 "None.",
73 }},
74 MessageEntry{
75 "AccountNotModified",
76 {
77 "Indicates that the modification requested for the account was not successful.",
78 "The account modification request failed.",
79 "Warning",
80 0,
81 {},
82 "The modification may have failed due to permission issues or issues with the request body.",
83 }},
84 MessageEntry{
85 "AccountRemoved",
86 {
87 "Indicates that the account was successfully removed.",
88 "The account was successfully removed.",
89 "OK",
90 0,
91 {},
92 "None.",
93 }},
94 MessageEntry{
95 "ActionDeprecated",
96 {
97 "Indicates the action is deprecated.",
98 "The action %1 is deprecated.",
99 "Warning",
100 1,
101 {
102 "string",
103 },
104 "Refer to the schema guide for more information.",
105 }},
106 MessageEntry{
107 "ActionNotSupported",
108 {
109 "Indicates that the action supplied with the `POST` operation is not supported by the resource.",
110 "The action %1 is not supported by the resource.",
111 "Critical",
112 1,
113 {
114 "string",
115 },
116 "Check the Actions property in the resource for the supported actions.",
117 }},
118 MessageEntry{
119 "ActionParameterDuplicate",
120 {
121 "Indicates that the action was supplied with a duplicated action parameter in the request body.",
122 "The action %1 was submitted with more than one value for the parameter %2.",
123 "Warning",
124 2,
125 {
126 "string",
127 "string",
128 },
129 "Resubmit the action with only one instance of the action parameter in the request body if the operation failed.",
130 }},
131 MessageEntry{
132 "ActionParameterMissing",
133 {
134 "Indicates that the action requested was missing an action parameter that is required to process the action.",
135 "The action %1 requires the parameter %2 to be present in the request body.",
136 "Critical",
137 2,
138 {
139 "string",
140 "string",
141 },
142 "Supply the action with the required parameter in the request body when the request is resubmitted.",
143 }},
144 MessageEntry{
145 "ActionParameterNotSupported",
146 {
147 "Indicates that the parameter supplied for the action is not supported on the resource.",
148 "The parameter %1 for the action %2 is not supported on the target resource.",
149 "Warning",
150 2,
151 {
152 "string",
153 "string",
154 },
155 "Remove the parameter supplied and resubmit the request if the operation failed.",
156 }},
157 MessageEntry{
158 "ActionParameterUnknown",
159 {
160 "Indicates that an action was submitted but an action parameter supplied did not match any of the known parameters.",
161 "The action %1 was submitted with the invalid parameter %2.",
162 "Warning",
163 2,
164 {
165 "string",
166 "string",
167 },
168 "Correct the invalid action parameter and resubmit the request if the operation failed.",
169 }},
170 MessageEntry{
171 "ActionParameterValueConflict",
172 {
173 "Indicates that the requested parameter value could not be completed because of a mismatch with other parameters or properties in the resource.",
174 "The parameter '%1' with the requested value of '%2' does not meet the constraints of the implementation.",
175 "Warning",
176 2,
177 {
178 "string",
179 "string",
180 },
181 "None.",
182 }},
183 MessageEntry{
184 "ActionParameterValueError",
185 {
186 "Indicates that a parameter was given an invalid value.",
187 "The value for the parameter %1 in the action %2 is invalid.",
188 "Warning",
189 2,
190 {
191 "string",
192 "string",
193 },
194 "Correct the value for the parameter in the request body and resubmit the request if the operation failed.",
195 }},
196 MessageEntry{
197 "ActionParameterValueFormatError",
198 {
199 "Indicates that a parameter was given the correct value type but the format of the value is not supported.",
200 "The value '%1' for the parameter %2 in the action %3 is not a format that the parameter can accept.",
201 "Warning",
202 3,
203 {
204 "string",
205 "string",
206 "string",
207 },
208 "Correct the value for the parameter in the request body and resubmit the request if the operation failed.",
209 }},
210 MessageEntry{
211 "ActionParameterValueNotInList",
212 {
213 "Indicates that a parameter was given the correct value type but the value of that parameter was not supported. The value is not in an enumeration.",
214 "The value '%1' for the parameter %2 in the action %3 is not in the list of acceptable values.",
215 "Warning",
216 3,
217 {
218 "string",
219 "string",
220 "string",
221 },
222 "Choose a value from the enumeration list that the implementation can support and resubmit the request if the operation failed.",
223 }},
224 MessageEntry{
225 "ActionParameterValueOutOfRange",
226 {
227 "Indicates that a parameter was given the correct value type but the value of that parameter is outside the supported range.",
228 "The value '%1' for the parameter %2 in the action %3 is not in the supported range of acceptable values.",
229 "Warning",
230 3,
231 {
232 "string",
233 "string",
234 "string",
235 },
236 "Correct the value for the parameter in the request body and resubmit the request if the operation failed.",
237 }},
238 MessageEntry{
239 "ActionParameterValueTypeError",
240 {
241 "Indicates that a parameter was given the wrong value type, such as when a number is supplied for a parameter that requires a string.",
242 "The value '%1' for the parameter %2 in the action %3 is not a type that the parameter can accept.",
243 "Warning",
244 3,
245 {
246 "string",
247 "string",
248 "string",
249 },
250 "Correct the value for the parameter in the request body and resubmit the request if the operation failed.",
251 }},
252 MessageEntry{
253 "ArraySizeTooLong",
254 {
255 "Indicates that the size of the array exceeded the maximum number of elements.",
256 "The array provided for property %1 exceeds the size limit %2.",
257 "Warning",
258 2,
259 {
260 "string",
261 "number",
262 },
263 "Resubmit the request with an appropriate array size.",
264 }},
265 MessageEntry{
266 "ArraySizeTooShort",
267 {
268 "Indicates that the size of the array is less than the minimum number of elements.",
269 "The array provided for property %1 is under the minimum size limit %2.",
270 "Warning",
271 2,
272 {
273 "string",
274 "number",
275 },
276 "Resubmit the request with an appropriate array size.",
277 }},
278 MessageEntry{
279 "AuthenticationTokenRequired",
280 {
281 "Indicates that the request could not be performed because an authentication token was not provided.",
282 "The request could not be performed because an authentication token was not provided.",
283 "Critical",
284 0,
285 {},
286 "Obtain an authentication token and resubmit the request.",
287 }},
288 MessageEntry{
289 "ChassisPowerStateOffRequired",
290 {
291 "Indicates that the request requires a specified chassis to be powered off.",
292 "The chassis with Id '%1' is required to be powered off to perform this request.",
293 "Warning",
294 1,
295 {
296 "string",
297 },
298 "Power off the specified chassis and resubmit the request.",
299 }},
300 MessageEntry{
301 "ChassisPowerStateOnRequired",
302 {
303 "Indicates that the request requires a specified chassis to be powered on.",
304 "The chassis with Id '%1' is required to be powered on to perform this request.",
305 "Warning",
306 1,
307 {
308 "string",
309 },
310 "Power on the specified chassis and resubmit the request.",
311 }},
312 MessageEntry{
313 "ConditionInRelatedResource",
314 {
315 "Indicates that one or more fault or error conditions exist in a related resource.",
316 "One or more conditions exist in a related resource. See the OriginOfCondition property.",
317 "Warning",
318 0,
319 {},
320 "Check the Conditions array in the resource shown in the OriginOfCondition property to determine the conditions that need attention.",
321 }},
322 MessageEntry{
323 "CouldNotEstablishConnection",
324 {
325 "Indicates that the attempt to access the resource, file, or image at the URI was unsuccessful because a session could not be established.",
326 "The service failed to establish a connection with the URI '%1'.",
327 "Critical",
328 1,
329 {
330 "string",
331 },
332 "Ensure that the URI contains a valid and reachable node name, protocol information, and other URI components.",
333 }},
334 MessageEntry{
335 "CreateFailedMissingReqProperties",
336 {
337 "Indicates that a create operation was attempted on a resource but that properties that are required for the create operation were missing from the request.",
338 "The create operation failed because the required property %1 was missing from the request.",
339 "Critical",
340 1,
341 {
342 "string",
343 },
344 "Correct the body to include the required property with a valid value and resubmit the request if the operation failed.",
345 }},
346 MessageEntry{
347 "CreateLimitReachedForResource",
348 {
349 "Indicates that no more resources can be created on the resource as it has reached its create limit.",
350 "The create operation failed because the resource has reached the limit of possible resources.",
351 "Critical",
352 0,
353 {},
354 "Either delete resources and resubmit the request if the operation failed or do not resubmit the request.",
355 }},
356 MessageEntry{
357 "Created",
358 {
359 "Indicates that all conditions of a successful create operation were met.",
360 "The resource was created successfully.",
361 "OK",
362 0,
363 {},
364 "None.",
365 }},
366 MessageEntry{
367 "EmptyJSON",
368 {
369 "Indicates that the request body contained an empty JSON object when one or more properties are expected in the body.",
370 "The request body submitted contained an empty JSON object and the service is unable to process it.",
371 "Warning",
372 0,
373 {},
374 "Add properties in the JSON object and resubmit the request.",
375 }},
376 MessageEntry{
377 "EventBufferExceeded",
378 {
379 "Indicates undelivered events may have been lost due to a lack of buffer space in the service.",
380 "Undelivered events may have been lost due to exceeding the event buffer.",
381 "Warning",
382 0,
383 {},
384 "None.",
385 }},
386 MessageEntry{
387 "EventSubscriptionLimitExceeded",
388 {
389 "Indicates that an event subscription establishment was requested but the operation failed due to the number of simultaneous connections exceeding the limit of the implementation.",
390 "The event subscription failed due to the number of simultaneous subscriptions exceeding the limit of the implementation.",
391 "Critical",
392 0,
393 {},
394 "Reduce the number of other subscriptions before trying to establish the event subscription or increase the limit of simultaneous subscriptions, if supported.",
395 }},
396 MessageEntry{
397 "GeneralError",
398 {
399 "Indicates that a general error has occurred. Use in `@Message.ExtendedInfo` is discouraged. When used in `@Message.ExtendedInfo`, implementations are expected to include a `Resolution` property with this message and provide a service-defined resolution to indicate how to resolve the error.",
400 "A general error has occurred. See Resolution for information on how to resolve the error, or @Message.ExtendedInfo if Resolution is not provided.",
401 "Critical",
402 0,
403 {},
404 "None.",
405 }},
406 MessageEntry{
407 "GenerateSecretKeyRequired",
408 {
409 "Indicates that the Time-based One-Time Password (TOTP) secret key needs to be generated for the account before accessing the service. The secret key can be generated with a `POST` to the `GenerateSecretKey` action for the `ManagerAccount` resource instance.",
410 "The Time-based One-Time Password (TOTP) secret key for this account must be generated before access is granted. Perform the GenerateSecretKey action at URI '%1' and retain the secret key from the response.",
411 "Critical",
412 1,
413 {
414 "string",
415 },
416 "Generate secret key for this account by performing the `GenerateSecretKey` action on the referenced URI and retaining the secret key from the action response to produce a Time-based One-Time Password (TOTP) for the `Token` property in future session creation requests.",
417 }},
418 MessageEntry{
419 "HeaderInvalid",
420 {
421 "Indicates that a request header is invalid.",
422 "Header '%1' is invalid.",
423 "Critical",
424 1,
425 {
426 "string",
427 },
428 "Resubmit the request with a valid request header.",
429 }},
430 MessageEntry{
431 "HeaderMissing",
432 {
433 "Indicates that a required request header is missing.",
434 "Required header '%1' is missing in the request.",
435 "Critical",
436 1,
437 {
438 "string",
439 },
440 "Resubmit the request with the required request header.",
441 }},
442 MessageEntry{
443 "InsufficientPrivilege",
444 {
445 "Indicates that the credentials associated with the established session do not have sufficient privileges for the requested operation.",
446 "There are insufficient privileges for the account or credentials associated with the current session to perform the requested operation.",
447 "Critical",
448 0,
449 {},
450 "Either abandon the operation or change the associated access rights and resubmit the request if the operation failed.",
451 }},
452 MessageEntry{
453 "InsufficientStorage",
454 {
455 "Indicates that the operation could not be completed due to a lack of storage or memory available to the service.",
456 "Insufficient storage or memory available to complete the request.",
457 "Critical",
458 0,
459 {},
460 "Increase the free storage space available to the service and resubmit the request.",
461 }},
462 MessageEntry{
463 "InternalError",
464 {
465 "Indicates that the request failed for an unknown internal error but that the service is still operational.",
466 "The request failed due to an internal service error. The service is still operational.",
467 "Critical",
468 0,
469 {},
470 "Resubmit the request. If the problem persists, consider resetting the service.",
471 }},
472 MessageEntry{
473 "InvalidIndex",
474 {
475 "The index is not valid.",
476 "The index %1 is not a valid offset into the array.",
477 "Warning",
478 1,
479 {
480 "number",
481 },
482 "Verify the index value provided is within the bounds of the array.",
483 }},
484 MessageEntry{
485 "InvalidJSON",
486 {
487 "Indicates that the request body contains invalid JSON.",
488 "The request body submitted is invalid JSON starting at line %1 and could not be parsed by the receiving service.",
489 "Critical",
490 1,
491 {
492 "number",
493 },
494 "Ensure that the request body is valid JSON and resubmit the request.",
495 }},
496 MessageEntry{
497 "InvalidObject",
498 {
499 "Indicates that the object in question is invalid according to the implementation. An example is a firmware update malformed URI.",
500 "The object at '%1' is invalid.",
501 "Critical",
502 1,
503 {
504 "string",
505 },
506 "Either the object is malformed or the URI is not correct. Correct the condition and resubmit the request if it failed.",
507 }},
508 MessageEntry{
509 "InvalidURI",
510 {
511 "Indicates that the operation encountered a URI that does not correspond to a valid resource.",
512 "The URI %1 was not found.",
513 "Critical",
514 1,
515 {
516 "string",
517 },
518 "Provide a valid URI and resubmit the request.",
519 }},
520 MessageEntry{
521 "LicenseRequired",
522 {
523 "Indicates that a license is required to perform the requested operation.",
524 "A license is required for this operation: %1.",
525 "Critical",
526 1,
527 {
528 "string",
529 },
530 "Install the requested license and resubmit the request.",
531 }},
532 MessageEntry{
533 "MalformedJSON",
534 {
535 "Indicates that the request body was malformed JSON.",
536 "The request body submitted was malformed JSON and could not be parsed by the receiving service.",
537 "Critical",
538 0,
539 {},
540 "Ensure that the request body is valid JSON and resubmit the request.",
541 }},
542 MessageEntry{
543 "MaximumErrorsExceeded",
544 {
545 "Indicates that so many errors have occurred that the reporting service cannot return them all.",
546 "Too many errors have occurred to report them all.",
547 "Critical",
548 0,
549 {},
550 "Resolve other reported errors and retry the current operation.",
551 }},
552 MessageEntry{
553 "MissingOrMalformedPart",
554 {
555 "Indicates that a multipart request is missing a required part or contains malformed parts.",
556 "The multipart request contains malformed parts or is missing required parts.",
557 "Critical",
558 0,
559 {},
560 "Add any missing required parts or correct the malformed parts and resubmit the request.",
561 }},
562 MessageEntry{
563 "NetworkNameResolutionNotConfigured",
564 {
565 "Indicates that network-based name resolution is not configured on the service.",
566 "Network name resolution is not configured on this service.",
567 "Warning",
568 0,
569 {},
570 "Configure the network-based name resolution protocol support on this service, or update any URI values to include an IP address instead of a network name and resubmit the request.",
571 }},
572 MessageEntry{
573 "NetworkNameResolutionNotSupported",
574 {
575 "Indicates the service does not support network-based name resolution.",
576 "Resolution of network-based names is not supported by this service.",
577 "Warning",
578 0,
579 {},
580 "Update any URI values to include an IP address instead of a network name and resubmit the request.",
581 }},
582 MessageEntry{
583 "NoOperation",
584 {
585 "Indicates that the requested operation will not perform any changes on the service.",
586 "The request body submitted contain no data to act upon and no changes to the resource took place.",
587 "Warning",
588 0,
589 {},
590 "Add properties in the JSON object and resubmit the request.",
591 }},
592 MessageEntry{
593 "NoValidSession",
594 {
595 "Indicates that the operation failed because a valid session is required in order to access any resources.",
596 "There is no valid session established with the implementation.",
597 "Critical",
598 0,
599 {},
600 "Establish a session before attempting any operations.",
601 }},
602 MessageEntry{
603 "OneTimePasscodeSent",
604 {
605 "Indicates that a required one-time passcode was sent to the user. The code should be provided as the Token property in the request to create a session.",
606 "A one-time passcode was sent to: %1. Supply the passcode as the `Token` property in the request to create a session.",
607 "OK",
608 1,
609 {
610 "string",
611 },
612 "Obtain the one-time passcode sent to the delivery address and resubmit the request using the passcode as the `Token` property.",
613 }},
614 MessageEntry{
615 "OperationFailed",
616 {
617 "Indicates that one of the internal operations necessary to complete the request failed. An example of this is when an internal service provider is unable to complete the request, such as in aggregation or RDE.",
618 "An error occurred internal to the service as part of the overall request. Partial results may have been returned.",
619 "Warning",
620 0,
621 {},
622 "Resubmit the request. If the problem persists, consider resetting the service or provider.",
623 }},
624 MessageEntry{
625 "OperationNotAllowed",
626 {
627 "Indicates that the HTTP method in the request is not allowed on this resource.",
628 "The HTTP method is not allowed on this resource.",
629 "Critical",
630 0,
631 {},
632 "None.",
633 }},
634 MessageEntry{
635 "OperationTimeout",
636 {
637 "Indicates that one of the internal operations necessary to complete the request timed out. An example of this is when an internal service provider is unable to complete the request, such as in aggregation or RDE.",
638 "A timeout internal to the service occurred as part of the request. Partial results may have been returned.",
639 "Warning",
640 0,
641 {},
642 "Resubmit the request. If the problem persists, consider resetting the service or provider.",
643 }},
644 MessageEntry{
645 "PasswordChangeRequired",
646 {
647 "Indicates that the password for the account provided must be changed before accessing the service. The password can be changed with a `PATCH` to the `Password` property in the manager account resource instance. Implementations that provide a default password for an account may require a password change prior to first access to the service.",
648 "The password provided for this account must be changed before access is granted. PATCH the Password property for this account located at the target URI '%1' to complete this process.",
649 "Critical",
650 1,
651 {
652 "string",
653 },
654 "Change the password for this account using a PATCH to the Password property at the URI provided.",
655 }},
656 MessageEntry{
657 "PayloadTooLarge",
658 {
659 "Indicates that the supplied payload is too large to be accepted by the service.",
660 "The supplied payload exceeds the maximum size supported by the service.",
661 "Critical",
662 0,
663 {},
664 "Check that the supplied payload is correct and supported by this service.",
665 }},
666 MessageEntry{
667 "PreconditionFailed",
668 {
669 "Indicates that the ETag supplied did not match the current ETag of the resource.",
670 "The ETag supplied did not match the ETag required to change this resource.",
671 "Critical",
672 0,
673 {},
674 "Try the operation again using the appropriate ETag.",
675 }},
676 MessageEntry{
677 "PreconditionRequired",
678 {
679 "Indicates that the request did not provide the required precondition such as an `If-Match` or `If-None-Match` header or `@odata.etag` annotations.",
680 "A precondition header or annotation is required to change this resource.",
681 "Critical",
682 0,
683 {},
684 "Try the operation again using an If-Match or If-None-Match header and appropriate ETag.",
685 }},
686 MessageEntry{
687 "PropertyDeprecated",
688 {
689 "Indicates the property is deprecated.",
690 "The deprecated property %1 was included in the request body.",
691 "Warning",
692 1,
693 {
694 "string",
695 },
696 "Refer to the schema guide for more information.",
697 }},
698 MessageEntry{
699 "PropertyDuplicate",
700 {
701 "Indicates that a duplicate property was included in the request body.",
702 "The property %1 was duplicated in the request.",
703 "Warning",
704 1,
705 {
706 "string",
707 },
708 "Remove the duplicate property from the request body and resubmit the request if the operation failed.",
709 }},
710 MessageEntry{
711 "PropertyMissing",
712 {
713 "Indicates that a required property was not supplied as part of the request.",
714 "The property %1 is a required property and must be included in the request.",
715 "Warning",
716 1,
717 {
718 "string",
719 },
720 "Ensure that the property is in the request body and has a valid value and resubmit the request if the operation failed.",
721 }},
722 MessageEntry{
723 "PropertyModified",
724 {
725 "Indicates that all properties listed in `RelatedProperties` in the message were successfully modified.",
726 "One or more properties were successfully modified.",
727 "OK",
728 0,
729 {},
730 "None.",
731 }},
732 MessageEntry{
733 "PropertyNotUpdated",
734 {
735 "Indicates that a property was not updated due to an internal service error, but the service is still functional.",
736 "The property %1 was not updated due to an internal service error. The service is still operational.",
737 "Critical",
738 1,
739 {
740 "string",
741 },
742 "Resubmit the request. If the problem persists, check for additional messages and consider resetting the service.",
743 }},
744 MessageEntry{
745 "PropertyNotWritable",
746 {
747 "Indicates that a property was given a value in the request body, but the property is a read-only property.",
748 "The property %1 is a read-only property and cannot be assigned a value.",
749 "Warning",
750 1,
751 {
752 "string",
753 },
754 "Remove the property from the request body and resubmit the request if the operation failed.",
755 }},
756 MessageEntry{
757 "PropertyUnknown",
758 {
759 "Indicates that an unknown property was included in the request body.",
760 "The property %1 is not in the list of valid properties for the resource.",
761 "Warning",
762 1,
763 {
764 "string",
765 },
766 "Remove the unknown property from the request body and resubmit the request if the operation failed.",
767 }},
768 MessageEntry{
769 "PropertyValueConflict",
770 {
771 "Indicates that the requested write of a property value could not be completed because of a conflict with another property value.",
772 "The property '%1' could not be written because its value would conflict with the value of the '%2' property.",
773 "Warning",
774 2,
775 {
776 "string",
777 "string",
778 },
779 "None.",
780 }},
781 MessageEntry{
782 "PropertyValueDeprecated",
783 {
784 "Indicates that a property was given a deprecated value.",
785 "The value '%1' for the property %2 is deprecated.",
786 "Warning",
787 2,
788 {
789 "string",
790 "string",
791 },
792 "Refer to the schema guide for more information.",
793 }},
794 MessageEntry{
795 "PropertyValueError",
796 {
797 "Indicates that a property was given an invalid value.",
798 "The value provided for the property %1 is not valid.",
799 "Warning",
800 1,
801 {
802 "string",
803 },
804 "Correct the value for the property in the request body and resubmit the request if the operation failed.",
805 }},
806 MessageEntry{
807 "PropertyValueExternalConflict",
808 {
809 "Indicates that the requested write of a property value could not be completed due to the current state or configuration of the resource. This can include configuration conflicts with other resources or parameters that are not exposed by this interface.",
810 "The property '%1' with the requested value of '%2' could not be written because the value is not available due to a configuration conflict.",
811 "Warning",
812 2,
813 {
814 "string",
815 "string",
816 },
817 "None.",
818 }},
819 MessageEntry{
820 "PropertyValueFormatError",
821 {
822 "Indicates that a property was given the correct value type but the format of the value is not supported.",
823 "The value '%1' for the property %2 is not a format that the property can accept.",
824 "Warning",
825 2,
826 {
827 "string",
828 "string",
829 },
830 "Correct the value for the property in the request body and resubmit the request if the operation failed.",
831 }},
832 MessageEntry{
833 "PropertyValueIncorrect",
834 {
835 "Indicates that the requested write of a property value could not be completed because of an incorrect value of the property. Examples include values that do not match a regular expression requirement or passwords that do not match the implementation constraints.",
836 "The property '%1' with the requested value of '%2' could not be written because the value does not meet the constraints of the implementation.",
837 "Warning",
838 2,
839 {
840 "string",
841 "string",
842 },
843 "None.",
844 }},
845 MessageEntry{
846 "PropertyValueModified",
847 {
848 "Indicates that a property was given the correct value type but the value of that property was modified. Examples are truncated or rounded values.",
849 "The property %1 was assigned the value '%2' due to modification by the service.",
850 "Warning",
851 2,
852 {
853 "string",
854 "string",
855 },
856 "None.",
857 }},
858 MessageEntry{
859 "PropertyValueNotInList",
860 {
861 "Indicates that a property was given the correct value type but the value of that property was not supported. The value is not in an enumeration.",
862 "The value '%1' for the property %2 is not in the list of acceptable values.",
863 "Warning",
864 2,
865 {
866 "string",
867 "string",
868 },
869 "Choose a value from the enumeration list that the implementation can support and resubmit the request if the operation failed.",
870 }},
871 MessageEntry{
872 "PropertyValueOutOfRange",
873 {
874 "Indicates that a property was given the correct value type but the value of that property is outside the supported range.",
875 "The value '%1' for the property %2 is not in the supported range of acceptable values.",
876 "Warning",
877 2,
878 {
879 "string",
880 "string",
881 },
882 "Correct the value for the property in the request body and resubmit the request if the operation failed.",
883 }},
884 MessageEntry{
885 "PropertyValueResourceConflict",
886 {
887 "Indicates that the requested write of a property value could not be completed due to the current state or configuration of another resource.",
888 "The property '%1' with the requested value of '%2' could not be written because the value conflicts with the state or configuration of the resource at '%3'.",
889 "Warning",
890 3,
891 {
892 "string",
893 "string",
894 "string",
895 },
896 "None.",
897 }},
898 MessageEntry{
899 "PropertyValueTypeError",
900 {
901 "Indicates that a property was given the wrong value type, such as when a number is supplied for a property that requires a string.",
902 "The value '%1' for the property %2 is not a type that the property can accept.",
903 "Warning",
904 2,
905 {
906 "string",
907 "string",
908 },
909 "Correct the value for the property in the request body and resubmit the request if the operation failed.",
910 }},
911 MessageEntry{
912 "QueryCombinationInvalid",
913 {
914 "Indicates the request contains multiple query parameters and that two or more of them cannot be used together.",
915 "Two or more query parameters in the request cannot be used together.",
916 "Warning",
917 0,
918 {},
919 "Remove one or more of the query parameters and resubmit the request if the operation failed.",
920 }},
921 MessageEntry{
922 "QueryNotSupported",
923 {
924 "Indicates that query is not supported on the implementation.",
925 "Querying is not supported by the implementation.",
926 "Warning",
927 0,
928 {},
929 "Remove the query parameters and resubmit the request if the operation failed.",
930 }},
931 MessageEntry{
932 "QueryNotSupportedOnOperation",
933 {
934 "Indicates that query is not supported with the given operation, such as when the `$expand` query is attempted with a `PATCH` operation.",
935 "Querying is not supported with the requested operation.",
936 "Warning",
937 0,
938 {},
939 "Remove the query parameters and resubmit the request if the operation failed.",
940 }},
941 MessageEntry{
942 "QueryNotSupportedOnResource",
943 {
944 "Indicates that query is not supported on the given resource, such as when the `$skip` query is attempted on a resource that is not a collection.",
945 "Querying is not supported on the requested resource.",
946 "Warning",
947 0,
948 {},
949 "Remove the query parameters and resubmit the request if the operation failed.",
950 }},
951 MessageEntry{
952 "QueryParameterOutOfRange",
953 {
954 "Indicates that a query parameter was provided that is out of range for the given resource. This can happen with values that are too low or that exceed what is possible for the supplied resource, such as when a page is requested that is beyond the last page.",
955 "The value '%1' for the query parameter %2 is out of range %3.",
956 "Warning",
957 3,
958 {
959 "string",
960 "string",
961 "string",
962 },
963 "Reduce the value for the query parameter to a value that is within range, such as a start or count value that is within bounds of the number of resources in a collection or a page number that is within the range of valid pages.",
964 }},
965 MessageEntry{
966 "QueryParameterUnsupported",
967 {
968 "Indicates that a query parameter is not supported.",
969 "Query parameter '%1' is not supported.",
970 "Warning",
971 1,
972 {
973 "string",
974 },
975 "Correct or remove the query parameter and resubmit the request.",
976 }},
977 MessageEntry{
978 "QueryParameterValueError",
979 {
980 "Indicates that a query parameter was given an invalid value.",
981 "The value for the parameter %1 is invalid.",
982 "Warning",
983 1,
984 {
985 "string",
986 },
987 "Correct the value for the query parameter in the request and resubmit the request if the operation failed.",
988 }},
989 MessageEntry{
990 "QueryParameterValueFormatError",
991 {
992 "Indicates that a query parameter was given the correct value type but the format of the value is not supported.",
993 "The value '%1' for the parameter %2 is not a format that the parameter can accept.",
994 "Warning",
995 2,
996 {
997 "string",
998 "string",
999 },
1000 "Correct the value for the query parameter in the request and resubmit the request if the operation failed.",
1001 }},
1002 MessageEntry{
1003 "QueryParameterValueTypeError",
1004 {
1005 "Indicates that a query parameter was given the wrong value type, such as when a number is supplied for a query parameter that requires a string.",
1006 "The value '%1' for the query parameter %2 is not a type that the parameter can accept.",
1007 "Warning",
1008 2,
1009 {
1010 "string",
1011 "string",
1012 },
1013 "Correct the value for the query parameter in the request and resubmit the request if the operation failed.",
1014 }},
1015 MessageEntry{
1016 "ResetRecommended",
1017 {
1018 "Indicates that a component reset is recommended for error recovery while unaffected applications can continue running without any effect on accuracy and performance.",
1019 "In order to recover from errors, a component reset is recommended with the Reset action URI '%1' and ResetType '%2'.",
1020 "Warning",
1021 2,
1022 {
1023 "string",
1024 "string",
1025 },
1026 "Perform the recommended reset action on the specified component.",
1027 }},
1028 MessageEntry{
1029 "ResetRequired",
1030 {
1031 "Indicates that a component reset is required for changes, error recovery, or operations to complete.",
1032 "In order to apply changes, recover from errors, or complete the operation, a component reset is required with the Reset action URI '%1' and ResetType '%2'.",
1033 "Warning",
1034 2,
1035 {
1036 "string",
1037 "string",
1038 },
1039 "Perform the required reset action on the specified component.",
1040 }},
1041 MessageEntry{
1042 "ResourceAlreadyExists",
1043 {
1044 "Indicates that a resource change or creation was attempted but that the operation cannot proceed because the resource already exists.",
1045 "The requested resource of type %1 with the property %2 with the value '%3' already exists.",
1046 "Critical",
1047 3,
1048 {
1049 "string",
1050 "string",
1051 "string",
1052 },
1053 "Do not repeat the create operation as the resource was already created.",
1054 }},
1055 MessageEntry{
1056 "ResourceAtUriInUnknownFormat",
1057 {
1058 "Indicates that the URI was valid but the resource or image at that URI was in a format not supported by the service.",
1059 "The resource at '%1' is in a format not recognized by the service.",
1060 "Critical",
1061 1,
1062 {
1063 "string",
1064 },
1065 "Place an image or resource or file that is recognized by the service at the URI.",
1066 }},
1067 MessageEntry{
1068 "ResourceAtUriUnauthorized",
1069 {
1070 "Indicates that the attempt to access the resource, file, or image at the URI was unauthorized.",
1071 "While accessing the resource at '%1', the service received an authorization error '%2'.",
1072 "Critical",
1073 2,
1074 {
1075 "string",
1076 "string",
1077 },
1078 "Ensure that the appropriate access is provided for the service in order for it to access the URI.",
1079 }},
1080 MessageEntry{
1081 "ResourceCannotBeDeleted",
1082 {
1083 "Indicates that a delete operation was attempted on a resource that cannot be deleted.",
1084 "The delete request failed because the resource requested cannot be deleted.",
1085 "Critical",
1086 0,
1087 {},
1088 "Do not attempt to delete a non-deletable resource.",
1089 }},
1090 MessageEntry{
1091 "ResourceCreationConflict",
1092 {
1093 "Indicates that the requested resource creation could not be completed because the service has a resource that conflicts with the request.",
1094 "The resource could not be created. The service has a resource at URI '%1' that conflicts with the creation request.",
1095 "Warning",
1096 1,
1097 {
1098 "string",
1099 },
1100 "None.",
1101 }},
1102 MessageEntry{
1103 "ResourceDeprecated",
1104 {
1105 "Indicates the resource is deprecated.",
1106 "The operation was performed on a deprecated resource '%1'.",
1107 "Warning",
1108 1,
1109 {
1110 "string",
1111 },
1112 "Refer to the schema guide for more information.",
1113 }},
1114 MessageEntry{
1115 "ResourceExhaustion",
1116 {
1117 "Indicates that a resource could not satisfy the request due to some unavailability of resources. An example is that available capacity was allocated.",
1118 "The resource '%1' was unable to satisfy the request due to unavailability of resources.",
1119 "Critical",
1120 1,
1121 {
1122 "string",
1123 },
1124 "Ensure that the resources are available and resubmit the request.",
1125 }},
1126 MessageEntry{
1127 "ResourceInStandby",
1128 {
1129 "Indicates that the request could not be performed because the resource is in standby.",
1130 "The request could not be performed because the resource is in standby.",
1131 "Critical",
1132 0,
1133 {},
1134 "Ensure that the resource is in the correct power state and resubmit the request.",
1135 }},
1136 MessageEntry{
1137 "ResourceInUse",
1138 {
1139 "Indicates that a change was requested to a resource but the change was rejected due to the resource being in use or transition.",
1140 "The change to the requested resource failed because the resource is in use or in transition.",
1141 "Warning",
1142 0,
1143 {},
1144 "Remove the condition and resubmit the request if the operation failed.",
1145 }},
1146 MessageEntry{
1147 "ResourceMissingAtURI",
1148 {
1149 "Indicates that the operation expected an image or other resource at the provided URI but none was found. Examples of this are in requests that require URIs such as firmware updates.",
1150 "The resource at the URI '%1' was not found.",
1151 "Critical",
1152 1,
1153 {
1154 "string",
1155 },
1156 "Place a valid resource at the URI or correct the URI and resubmit the request.",
1157 }},
1158 MessageEntry{
1159 "ResourceNotFound",
1160 {
1161 "Indicates that the operation expected a resource identifier that corresponds to an existing resource but one was not found.",
1162 "The requested resource of type %1 named '%2' was not found.",
1163 "Critical",
1164 2,
1165 {
1166 "string",
1167 "string",
1168 },
1169 "Provide a valid resource identifier and resubmit the request.",
1170 }},
1171 MessageEntry{
1172 "ResourceTypeIncompatible",
1173 {
1174 "Indicates that the resource type of the operation does not match that of the operation destination. Examples of this are a `POST` to a resource collection using the wrong resource type, an update where the `@odata.type` properties do not match, or a case of major version incompatibility.",
1175 "The @odata.type of the request body %1 is incompatible with the @odata.type of the resource, which is %2.",
1176 "Critical",
1177 2,
1178 {
1179 "string",
1180 "string",
1181 },
1182 "Resubmit the request with a payload compatible with the resource's schema.",
1183 }},
1184 MessageEntry{
1185 "RestrictedPrivilege",
1186 {
1187 "Indicates that the operation was not successful because a privilege is restricted.",
1188 "The operation was not successful because the privilege '%1' is restricted.",
1189 "Warning",
1190 1,
1191 {
1192 "string",
1193 },
1194 "Remove restricted privileges from the request body and resubmit the request.",
1195 }},
1196 MessageEntry{
1197 "RestrictedRole",
1198 {
1199 "Indicates that the operation was not successful because the role is restricted.",
1200 "The operation was not successful because the role '%1' is restricted.",
1201 "Warning",
1202 1,
1203 {
1204 "string",
1205 },
1206 "No resolution is required. For standard roles, consider using the role specified in the AlternateRoleId property in the Role resource.",
1207 }},
1208 MessageEntry{
1209 "ServiceDisabled",
1210 {
1211 "Indicates that the operation failed because the service, such as the account service, is disabled and cannot accept requests.",
1212 "The operation failed because the service at %1 is disabled and cannot accept requests.",
1213 "Warning",
1214 1,
1215 {
1216 "string",
1217 },
1218 "Enable the service and resubmit the request if the operation failed.",
1219 }},
1220 MessageEntry{
1221 "ServiceInUnknownState",
1222 {
1223 "Indicates that the operation failed because the service is in an unknown state and cannot accept additional requests.",
1224 "The operation failed because the service is in an unknown state and can no longer take incoming requests.",
1225 "Critical",
1226 0,
1227 {},
1228 "Restart the service and resubmit the request if the operation failed.",
1229 }},
1230 MessageEntry{
1231 "ServiceShuttingDown",
1232 {
1233 "Indicates that the operation failed because the service is shutting down, such as when the service reboots.",
1234 "The operation failed because the service is shutting down and can no longer take incoming requests.",
1235 "Critical",
1236 0,
1237 {},
1238 "When the service becomes available, resubmit the request if the operation failed.",
1239 }},
1240 MessageEntry{
1241 "ServiceTemporarilyUnavailable",
1242 {
1243 "Indicates the service is temporarily unavailable.",
1244 "The service is temporarily unavailable. Retry in %1 seconds.",
1245 "Critical",
1246 1,
1247 {
1248 "string",
1249 },
1250 "Wait for the indicated retry duration and retry the operation.",
1251 }},
1252 MessageEntry{
1253 "SessionLimitExceeded",
1254 {
1255 "Indicates that a session establishment was requested but the operation failed due to the number of simultaneous sessions exceeding the limit of the implementation.",
1256 "The session establishment failed due to the number of simultaneous sessions exceeding the limit of the implementation.",
1257 "Critical",
1258 0,
1259 {},
1260 "Reduce the number of other sessions before trying to establish the session or increase the limit of simultaneous sessions, if supported.",
1261 }},
1262 MessageEntry{
1263 "SessionTerminated",
1264 {
1265 "Indicates that the `DELETE` operation on the session resource resulted in the successful termination of the session.",
1266 "The session was successfully terminated.",
1267 "OK",
1268 0,
1269 {},
1270 "None.",
1271 }},
1272 MessageEntry{
1273 "SourceDoesNotSupportProtocol",
1274 {
1275 "Indicates that while attempting to access, connect to, or transfer a resource, file, or image from another location that the other end of the connection did not support the protocol.",
1276 "The other end of the connection at '%1' does not support the specified protocol %2.",
1277 "Critical",
1278 2,
1279 {
1280 "string",
1281 "string",
1282 },
1283 "Change protocols or URIs.",
1284 }},
1285 MessageEntry{
1286 "StrictAccountTypes",
1287 {
1288 "Indicates the request failed because a set of `AccountTypes` or `OEMAccountTypes` was not accepted while `StrictAccountTypes` is set to `true`.",
1289 "The request could not be fulfilled with the account types included in property '%1' because the property StrictAccountTypes is set to true.",
1290 "Warning",
1291 1,
1292 {
1293 "string",
1294 },
1295 "Resubmit the request either with an acceptable set of AccountTypes and OEMAccountTypes or with StrictAccountTypes set to false.",
1296 }},
1297 MessageEntry{
1298 "StringValueTooLong",
1299 {
1300 "Indicates that a string value passed to the given resource was longer than the maximum allowed length. An example is when an implementation has imposed a shorter maximum length than that allowed by the specification.",
1301 "The string '%1' exceeds the length limit %2.",
1302 "Warning",
1303 2,
1304 {
1305 "string",
1306 "number",
1307 },
1308 "Resubmit the request with an appropriate string length.",
1309 }},
1310 MessageEntry{
1311 "StringValueTooShort",
1312 {
1313 "Indicates that a string value passed to the given resource was shorter than the minimum required length. An example is when an implementation has imposed a greater minimum length than that required by the specification.",
1314 "The string '%1' was under the minimum required length %2.",
1315 "Warning",
1316 2,
1317 {
1318 "string",
1319 "number",
1320 },
1321 "Resubmit the request with an appropriate string length.",
1322 }},
1323 MessageEntry{
1324 "SubscriptionTerminated",
1325 {
1326 "An event subscription was terminated by the service. No further events will be delivered.",
1327 "The event subscription was terminated.",
1328 "OK",
1329 0,
1330 {},
1331 "None.",
1332 }},
1333 MessageEntry{
1334 "Success",
1335 {
1336 "Indicates that all conditions of a successful operation were met.",
1337 "The request completed successfully.",
1338 "OK",
1339 0,
1340 {},
1341 "None.",
1342 }},
1343 MessageEntry{
1344 "UndeterminedFault",
1345 {
1346 "Indicates that a fault or error condition exists but the source of the fault cannot be determined or is unknown to the service.",
1347 "An undetermined fault condition was reported by '%1'.",
1348 "Critical",
1349 1,
1350 {
1351 "string",
1352 },
1353 "None.",
1354 }},
1355 MessageEntry{
1356 "UnrecognizedRequestBody",
1357 {
1358 "Indicates that the service encountered an unrecognizable request body that could not even be interpreted as malformed JSON.",
1359 "The service detected a malformed request body that it was unable to interpret.",
1360 "Warning",
1361 0,
1362 {},
1363 "Correct the request body and resubmit the request if it failed.",
1364 }},
1365
1366 };
1367
1368 enum class Index
1369 {
1370 accessDenied = 0,
1371 accountForSessionNoLongerExists = 1,
1372 accountModified = 2,
1373 accountNotModified = 3,
1374 accountRemoved = 4,
1375 actionDeprecated = 5,
1376 actionNotSupported = 6,
1377 actionParameterDuplicate = 7,
1378 actionParameterMissing = 8,
1379 actionParameterNotSupported = 9,
1380 actionParameterUnknown = 10,
1381 actionParameterValueConflict = 11,
1382 actionParameterValueError = 12,
1383 actionParameterValueFormatError = 13,
1384 actionParameterValueNotInList = 14,
1385 actionParameterValueOutOfRange = 15,
1386 actionParameterValueTypeError = 16,
1387 arraySizeTooLong = 17,
1388 arraySizeTooShort = 18,
1389 authenticationTokenRequired = 19,
1390 chassisPowerStateOffRequired = 20,
1391 chassisPowerStateOnRequired = 21,
1392 conditionInRelatedResource = 22,
1393 couldNotEstablishConnection = 23,
1394 createFailedMissingReqProperties = 24,
1395 createLimitReachedForResource = 25,
1396 created = 26,
1397 emptyJSON = 27,
1398 eventBufferExceeded = 28,
1399 eventSubscriptionLimitExceeded = 29,
1400 generalError = 30,
1401 generateSecretKeyRequired = 31,
1402 headerInvalid = 32,
1403 headerMissing = 33,
1404 insufficientPrivilege = 34,
1405 insufficientStorage = 35,
1406 internalError = 36,
1407 invalidIndex = 37,
1408 invalidJSON = 38,
1409 invalidObject = 39,
1410 invalidURI = 40,
1411 licenseRequired = 41,
1412 malformedJSON = 42,
1413 maximumErrorsExceeded = 43,
1414 missingOrMalformedPart = 44,
1415 networkNameResolutionNotConfigured = 45,
1416 networkNameResolutionNotSupported = 46,
1417 noOperation = 47,
1418 noValidSession = 48,
1419 oneTimePasscodeSent = 49,
1420 operationFailed = 50,
1421 operationNotAllowed = 51,
1422 operationTimeout = 52,
1423 passwordChangeRequired = 53,
1424 payloadTooLarge = 54,
1425 preconditionFailed = 55,
1426 preconditionRequired = 56,
1427 propertyDeprecated = 57,
1428 propertyDuplicate = 58,
1429 propertyMissing = 59,
1430 propertyModified = 60,
1431 propertyNotUpdated = 61,
1432 propertyNotWritable = 62,
1433 propertyUnknown = 63,
1434 propertyValueConflict = 64,
1435 propertyValueDeprecated = 65,
1436 propertyValueError = 66,
1437 propertyValueExternalConflict = 67,
1438 propertyValueFormatError = 68,
1439 propertyValueIncorrect = 69,
1440 propertyValueModified = 70,
1441 propertyValueNotInList = 71,
1442 propertyValueOutOfRange = 72,
1443 propertyValueResourceConflict = 73,
1444 propertyValueTypeError = 74,
1445 queryCombinationInvalid = 75,
1446 queryNotSupported = 76,
1447 queryNotSupportedOnOperation = 77,
1448 queryNotSupportedOnResource = 78,
1449 queryParameterOutOfRange = 79,
1450 queryParameterUnsupported = 80,
1451 queryParameterValueError = 81,
1452 queryParameterValueFormatError = 82,
1453 queryParameterValueTypeError = 83,
1454 resetRecommended = 84,
1455 resetRequired = 85,
1456 resourceAlreadyExists = 86,
1457 resourceAtUriInUnknownFormat = 87,
1458 resourceAtUriUnauthorized = 88,
1459 resourceCannotBeDeleted = 89,
1460 resourceCreationConflict = 90,
1461 resourceDeprecated = 91,
1462 resourceExhaustion = 92,
1463 resourceInStandby = 93,
1464 resourceInUse = 94,
1465 resourceMissingAtURI = 95,
1466 resourceNotFound = 96,
1467 resourceTypeIncompatible = 97,
1468 restrictedPrivilege = 98,
1469 restrictedRole = 99,
1470 serviceDisabled = 100,
1471 serviceInUnknownState = 101,
1472 serviceShuttingDown = 102,
1473 serviceTemporarilyUnavailable = 103,
1474 sessionLimitExceeded = 104,
1475 sessionTerminated = 105,
1476 sourceDoesNotSupportProtocol = 106,
1477 strictAccountTypes = 107,
1478 stringValueTooLong = 108,
1479 stringValueTooShort = 109,
1480 subscriptionTerminated = 110,
1481 success = 111,
1482 undeterminedFault = 112,
1483 unrecognizedRequestBody = 113,
1484 };
1485 }; // struct base
1486
registerBase()1487 [[gnu::constructor]] inline void registerBase()
1488 { registerRegistry<Base>(); }
1489
1490 } // namespace redfish::registries
1491