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