1 /* 2 // Copyright (c) 2019 Intel Corporation 3 // 4 // Licensed under the Apache License, Version 2.0 (the "License"); 5 // you may not use this file except in compliance with the License. 6 // You may obtain a copy of the License at 7 // 8 // http://www.apache.org/licenses/LICENSE-2.0 9 // 10 // Unless required by applicable law or agreed to in writing, software 11 // distributed under the License is distributed on an "AS IS" BASIS, 12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 // See the License for the specific language governing permissions and 14 // limitations under the License. 15 */ 16 /**************************************************************** 17 * This is an auto-generated header which contains definitions 18 * for Redfish DMTF defined messages. 19 ***************************************************************/ 20 #pragma once 21 #include <registries.hpp> 22 23 namespace redfish::message_registries::base 24 { 25 const Header header = { 26 "Copyright 2014-2018 DMTF. All rights reserved.", 27 "#MessageRegistry.v1_0_0.MessageRegistry", 28 "Base.1.4.0", 29 "Base Message Registry", 30 "en", 31 "This registry defines the base messages for Redfish", 32 "Base", 33 "1.4.0", 34 "DMTF", 35 }; 36 const std::array<MessageEntry, 58> registry = { 37 MessageEntry{ 38 "AccessDenied", 39 { 40 "Indicates that while attempting to access, connect to or transfer " 41 "to/from another resource, the service denied access.", 42 "While attempting to establish a connection to %1, the service " 43 "denied access.", 44 "Critical", 45 1, 46 { 47 "string", 48 }, 49 "Attempt to ensure that the URI is correct and that the service " 50 "has the appropriate credentials.", 51 }}, 52 MessageEntry{"AccountForSessionNoLongerExists", 53 { 54 "Indicates that the account for the session has been " 55 "removed, thus the session has been removed as well.", 56 "The account for the current session has been removed, " 57 "thus the current session has been removed as well.", 58 "OK", 59 0, 60 {}, 61 "Attempt to connect with a valid account.", 62 }}, 63 MessageEntry{"AccountModified", 64 { 65 "Indicates that the account was successfully modified.", 66 "The account was successfully modified.", 67 "OK", 68 0, 69 {}, 70 "No resolution is required.", 71 }}, 72 MessageEntry{"AccountNotModified", 73 { 74 "Indicates that the modification requested for the " 75 "account was not successful.", 76 "The account modification request failed.", 77 "Warning", 78 0, 79 {}, 80 "The modification may have failed due to permission " 81 "issues or issues with the request body.", 82 }}, 83 MessageEntry{"AccountRemoved", 84 { 85 "Indicates that the account was successfully removed.", 86 "The account was successfully removed.", 87 "OK", 88 0, 89 {}, 90 "No resolution is required.", 91 }}, 92 MessageEntry{ 93 "ActionNotSupported", 94 { 95 "Indicates that the action supplied with the POST operation is not " 96 "supported by the resource.", 97 "The action %1 is not supported by the resource.", 98 "Critical", 99 1, 100 { 101 "string", 102 }, 103 "The action supplied cannot be resubmitted to the implementation. " 104 "Perhaps the action was invalid, the wrong resource was the target " 105 "or the implementation documentation may be of assistance.", 106 }}, 107 MessageEntry{"ActionParameterDuplicate", 108 { 109 "Indicates that the action was supplied with a duplicated " 110 "parameter in the request body.", 111 "The action %1 was submitted with more than one value for " 112 "the parameter %2.", 113 "Warning", 114 2, 115 { 116 "string", 117 "string", 118 }, 119 "Resubmit the action with only one instance of the " 120 "parameter in the request body if the operation failed.", 121 }}, 122 MessageEntry{"ActionParameterMissing", 123 { 124 "Indicates that the action requested was missing a " 125 "parameter that is required to process the action.", 126 "The action %1 requires the parameter %2 to be present in " 127 "the request body.", 128 "Critical", 129 2, 130 { 131 "string", 132 "string", 133 }, 134 "Supply the action with the required parameter in the " 135 "request body when the request is resubmitted.", 136 }}, 137 MessageEntry{"ActionParameterNotSupported", 138 { 139 "Indicates that the parameter supplied for the action is " 140 "not supported on the resource.", 141 "The parameter %1 for the action %2 is not supported on " 142 "the target resource.", 143 "Warning", 144 2, 145 { 146 "string", 147 "string", 148 }, 149 "Remove the parameter supplied and resubmit the request " 150 "if the operation failed.", 151 }}, 152 MessageEntry{ 153 "ActionParameterUnknown", 154 { 155 "Indicates that an action was submitted but a parameter supplied " 156 "did not match any of the known parameters.", 157 "The action %1 was submitted with the invalid parameter %2.", 158 "Warning", 159 2, 160 { 161 "string", 162 "string", 163 }, 164 "Correct the invalid parameter and resubmit the request if the " 165 "operation failed.", 166 }}, 167 MessageEntry{"ActionParameterValueFormatError", 168 { 169 "Indicates that a parameter was given the correct value " 170 "type but the value of that parameter was not supported. " 171 "This includes value size/length exceeded.", 172 "The value %1 for the parameter %2 in the action %3 is of " 173 "a different format than the parameter can accept.", 174 "Warning", 175 3, 176 { 177 "string", 178 "string", 179 "string", 180 }, 181 "Correct the value for the parameter in the request body " 182 "and resubmit the request if the operation failed.", 183 }}, 184 MessageEntry{"ActionParameterValueTypeError", 185 { 186 "Indicates that a parameter was given the wrong value " 187 "type, such as when a number is supplied for a parameter " 188 "that requires a string.", 189 "The value %1 for the parameter %2 in the action %3 is of " 190 "a different type than the parameter can accept.", 191 "Warning", 192 3, 193 { 194 "string", 195 "string", 196 "string", 197 }, 198 "Correct the value for the parameter in the request body " 199 "and resubmit the request if the operation failed.", 200 }}, 201 MessageEntry{ 202 "CouldNotEstablishConnection", 203 { 204 "Indicates that the attempt to access the resource/file/image at " 205 "the URI was unsuccessful because a session could not be " 206 "established.", 207 "The service failed to establish a connection with the URI %1.", 208 "Critical", 209 1, 210 { 211 "string", 212 }, 213 "Ensure that the URI contains a valid and reachable node name, " 214 "protocol information and other URI components.", 215 }}, 216 MessageEntry{ 217 "CreateFailedMissingReqProperties", 218 { 219 "Indicates that a create was attempted on a resource but that " 220 "properties that are required for the create operation were " 221 "missing from the request.", 222 "The create operation failed because the required property %1 was " 223 "missing from the request.", 224 "Critical", 225 1, 226 { 227 "string", 228 }, 229 "Correct the body to include the required property with a valid " 230 "value and resubmit the request if the operation failed.", 231 }}, 232 MessageEntry{"CreateLimitReachedForResource", 233 { 234 "Indicates that no more resources can be created on the " 235 "resource as it has reached its create limit.", 236 "The create operation failed because the resource has " 237 "reached the limit of possible resources.", 238 "Critical", 239 0, 240 {}, 241 "Either delete resources and resubmit the request if the " 242 "operation failed or do not resubmit the request.", 243 }}, 244 MessageEntry{"Created", 245 { 246 "Indicates that all conditions of a successful creation " 247 "operation have been met.", 248 "The resource has been created successfully", 249 "OK", 250 0, 251 {}, 252 "None", 253 }}, 254 MessageEntry{ 255 "EmptyJSON", 256 { 257 "Indicates that the request body contained an empty JSON object " 258 "when one or more properties are expected in the body.", 259 "The request body submitted contained an empty JSON object and the " 260 "service is unable to process it.", 261 "Warning", 262 0, 263 {}, 264 "Add properties in the JSON object and resubmit the request.", 265 }}, 266 MessageEntry{ 267 "EventSubscriptionLimitExceeded", 268 { 269 "Indicates that a event subscription establishment has been " 270 "requested but the operation failed due to the number of " 271 "simultaneous connection exceeding the limit of the " 272 "implementation.", 273 "The event subscription failed due to the number of simultaneous " 274 "subscriptions exceeding the limit of the implementation.", 275 "Critical", 276 0, 277 {}, 278 "Reduce the number of other subscriptions before trying to " 279 "establish the event subscription or increase the limit of " 280 "simultaneous subscriptions (if supported).", 281 }}, 282 MessageEntry{ 283 "GeneralError", 284 { 285 "Indicates that a general error has occurred. Use in ExtendedInfo " 286 "is discouraged. When used in ExtendedInfo, implementations are " 287 "expected to include a Resolution property with this error to " 288 "indicate how to resolve the problem.", 289 "A general error has occurred. See Resolution for information on " 290 "how to resolve the error.", 291 "Critical", 292 0, 293 {}, 294 "None.", 295 }}, 296 MessageEntry{ 297 "InsufficientPrivilege", 298 { 299 "Indicates that the credentials associated with the established " 300 "session do not have sufficient privileges for the requested " 301 "operation", 302 "There are insufficient privileges for the account or credentials " 303 "associated with the current session to perform the requested " 304 "operation.", 305 "Critical", 306 0, 307 {}, 308 "Either abandon the operation or change the associated access " 309 "rights and resubmit the request if the operation failed.", 310 }}, 311 MessageEntry{ 312 "InternalError", 313 { 314 "Indicates that the request failed for an unknown internal error " 315 "but that the service is still operational.", 316 "The request failed due to an internal service error. The service " 317 "is still operational.", 318 "Critical", 319 0, 320 {}, 321 "Resubmit the request. If the problem persists, consider " 322 "resetting the service.", 323 }}, 324 MessageEntry{"InvalidIndex", 325 { 326 "The Index is not valid.", 327 "The Index %1 is not a valid offset into the array.", 328 "Warning", 329 1, 330 { 331 "number", 332 }, 333 "Verify the index value provided is within the bounds of " 334 "the array.", 335 }}, 336 MessageEntry{ 337 "InvalidObject", 338 { 339 "Indicates that the object in question is invalid according to the " 340 "implementation. Examples include a firmware update malformed " 341 "URI.", 342 "The object at %1 is invalid.", 343 "Critical", 344 1, 345 { 346 "string", 347 }, 348 "Either the object is malformed or the URI is not correct. " 349 "Correct the condition and resubmit the request if it failed.", 350 }}, 351 MessageEntry{"MalformedJSON", 352 { 353 "Indicates that the request body was malformed JSON. " 354 "Could be duplicate, syntax error,etc.", 355 "The request body submitted was malformed JSON and could " 356 "not be parsed by the receiving service.", 357 "Critical", 358 0, 359 {}, 360 "Ensure that the request body is valid JSON and resubmit " 361 "the request.", 362 }}, 363 MessageEntry{ 364 "NoOperation", 365 { 366 "Indicates that the requested operation will not perform any " 367 "changes on the service.", 368 "The request body submitted contain no data to act upon and no " 369 "changes to the resource took place.", 370 "Warning", 371 0, 372 {}, 373 "Add properties in the JSON object and resubmit the request.", 374 }}, 375 MessageEntry{ 376 "NoValidSession", 377 { 378 "Indicates that the operation failed because a valid session is " 379 "required in order to access any resources.", 380 "There is no valid session established with the implementation.", 381 "Critical", 382 0, 383 {}, 384 "Establish as session before attempting any operations.", 385 }}, 386 MessageEntry{"PropertyDuplicate", 387 { 388 "Indicates that a duplicate property was included in the " 389 "request body.", 390 "The property %1 was duplicated in the request.", 391 "Warning", 392 1, 393 { 394 "string", 395 }, 396 "Remove the duplicate property from the request body and " 397 "resubmit the request if the operation failed.", 398 }}, 399 MessageEntry{ 400 "PropertyMissing", 401 { 402 "Indicates that a required property was not supplied as part of " 403 "the request.", 404 "The property %1 is a required property and must be included in " 405 "the request.", 406 "Warning", 407 1, 408 { 409 "string", 410 }, 411 "Ensure that the property is in the request body and has a valid " 412 "value and resubmit the request if the operation failed.", 413 }}, 414 MessageEntry{"PropertyNotWritable", 415 { 416 "Indicates that a property was given a value in the " 417 "request body, but the property is a readonly property.", 418 "The property %1 is a read only property and cannot be " 419 "assigned a value.", 420 "Warning", 421 1, 422 { 423 "string", 424 }, 425 "Remove the property from the request body and resubmit " 426 "the request if the operation failed.", 427 }}, 428 MessageEntry{"PropertyUnknown", 429 { 430 "Indicates that an unknown property was included in the " 431 "request body.", 432 "The property %1 is not in the list of valid properties " 433 "for the resource.", 434 "Warning", 435 1, 436 { 437 "string", 438 }, 439 "Remove the unknown property from the request body and " 440 "resubmit the request if the operation failed.", 441 }}, 442 MessageEntry{"PropertyValueFormatError", 443 { 444 "Indicates that a property was given the correct value " 445 "type but the value of that property was not supported.", 446 "The value %1 for the property %2 is of a different " 447 "format than the property can accept.", 448 "Warning", 449 2, 450 { 451 "string", 452 "string", 453 }, 454 "Correct the value for the property in the request body " 455 "and resubmit the request if the operation failed.", 456 }}, 457 MessageEntry{"PropertyValueModified", 458 { 459 "Indicates that a property was given the correct value " 460 "type but the value of that property was modified. " 461 "Examples are truncated or rounded values.", 462 "The property %1 was assigned the value %2 due to " 463 "modification by the service.", 464 "Warning", 465 2, 466 { 467 "string", 468 "string", 469 }, 470 "No resolution is required.", 471 }}, 472 MessageEntry{ 473 "PropertyValueNotInList", 474 { 475 "Indicates that a property was given the correct value type but " 476 "the value of that property was not supported. This values not in " 477 "an enumeration", 478 "The value %1 for the property %2 is not in the list of acceptable " 479 "values.", 480 "Warning", 481 2, 482 { 483 "string", 484 "string", 485 }, 486 "Choose a value from the enumeration list that the implementation " 487 "can support and resubmit the request if the operation failed.", 488 }}, 489 MessageEntry{ 490 "PropertyValueTypeError", 491 { 492 "Indicates that a property was given the wrong value type, such as " 493 "when a number is supplied for a property that requires a string.", 494 "The value %1 for the property %2 is of a different type than the " 495 "property can accept.", 496 "Warning", 497 2, 498 { 499 "string", 500 "string", 501 }, 502 "Correct the value for the property in the request body and " 503 "resubmit the request if the operation failed.", 504 }}, 505 MessageEntry{ 506 "QueryNotSupported", 507 { 508 "Indicates that query is not supported on the implementation.", 509 "Querying is not supported by the implementation.", 510 "Warning", 511 0, 512 {}, 513 "Remove the query parameters and resubmit the request if the " 514 "operation failed.", 515 }}, 516 MessageEntry{"QueryNotSupportedOnResource", 517 { 518 "Indicates that query is not supported on the given " 519 "resource, such as when a start/count query is attempted " 520 "on a resource that is not a collection.", 521 "Querying is not supported on the requested resource.", 522 "Warning", 523 0, 524 {}, 525 "Remove the query parameters and resubmit the request if " 526 "the operation failed.", 527 }}, 528 MessageEntry{ 529 "QueryParameterOutOfRange", 530 { 531 "Indicates that a query parameter was supplied that is out of " 532 "range for the given resource. This can happen with values that " 533 "are too low or beyond that possible for the supplied resource, " 534 "such as when a page is requested that is beyond the last page.", 535 "The value %1 for the query parameter %2 is out of range %3.", 536 "Warning", 537 3, 538 { 539 "string", 540 "string", 541 "string", 542 }, 543 "Reduce the value for the query parameter to a value that is " 544 "within range, such as a start or count value that is within " 545 "bounds of the number of resources in a collection or a page that " 546 "is within the range of valid pages.", 547 }}, 548 MessageEntry{"QueryParameterValueFormatError", 549 { 550 "Indicates that a query parameter was given the correct " 551 "value type but the value of that parameter was not " 552 "supported. This includes value size/length exceeded.", 553 "The value %1 for the parameter %2 is of a different " 554 "format than the parameter can accept.", 555 "Warning", 556 2, 557 { 558 "string", 559 "string", 560 }, 561 "Correct the value for the query parameter in the request " 562 "and resubmit the request if the operation failed.", 563 }}, 564 MessageEntry{"QueryParameterValueTypeError", 565 { 566 "Indicates that a query parameter was given the wrong " 567 "value type, such as when a number is supplied for a " 568 "query parameter that requires a string.", 569 "The value %1 for the query parameter %2 is of a " 570 "different type than the parameter can accept.", 571 "Warning", 572 2, 573 { 574 "string", 575 "string", 576 }, 577 "Correct the value for the query parameter in the request " 578 "and resubmit the request if the operation failed.", 579 }}, 580 MessageEntry{"ResourceAlreadyExists", 581 { 582 "Indicates that a resource change or creation was " 583 "attempted but that the operation cannot proceed because " 584 "the resource already exists.", 585 "The requested resource of type %1 with the property %2 " 586 "with the value %3 already exists.", 587 "Critical", 588 3, 589 { 590 "string", 591 "string", 592 "string", 593 }, 594 "Do not repeat the create operation as the resource has " 595 "already been created.", 596 }}, 597 MessageEntry{ 598 "ResourceAtUriInUnknownFormat", 599 { 600 "Indicates that the URI was valid but the resource or image at " 601 "that URI was in a format not supported by the service.", 602 "The resource at %1 is in a format not recognized by the service.", 603 "Critical", 604 1, 605 { 606 "string", 607 }, 608 "Place an image or resource or file that is recognized by the " 609 "service at the URI.", 610 }}, 611 MessageEntry{"ResourceAtUriUnauthorized", 612 { 613 "Indicates that the attempt to access the " 614 "resource/file/image at the URI was unauthorized.", 615 "While accessing the resource at %1, the service received " 616 "an authorization error %2.", 617 "Critical", 618 2, 619 { 620 "string", 621 "string", 622 }, 623 "Ensure that the appropriate access is provided for the " 624 "service in order for it to access the URI.", 625 }}, 626 MessageEntry{"ResourceCannotBeDeleted", 627 { 628 "Indicates that a delete operation was attempted on a " 629 "resource that cannot be deleted.", 630 "The delete request failed because the resource requested " 631 "cannot be deleted.", 632 "Critical", 633 0, 634 {}, 635 "Do not attempt to delete a non-deletable resource.", 636 }}, 637 MessageEntry{ 638 "ResourceExhaustion", 639 { 640 "Indicates that a resource could not satisfy the request due to " 641 "some unavailability of resources. An example is that available " 642 "capacity has been allocated.", 643 "The resource %1 was unable to satisfy the request due to " 644 "unavailability of resources.", 645 "Critical", 646 1, 647 { 648 "string", 649 }, 650 "Ensure that the resources are available and resubmit the request.", 651 }}, 652 MessageEntry{"ResourceInStandby", 653 { 654 "Indicates that the request could not be performed " 655 "because the resource is in standby.", 656 "The request could not be performed because the resource " 657 "is in standby.", 658 "Critical", 659 0, 660 {}, 661 "Ensure that the resource is in the correct power state " 662 "and resubmit the request.", 663 }}, 664 MessageEntry{"ResourceInUse", 665 { 666 "Indicates that a change was requested to a resource but " 667 "the change was rejected due to the resource being in use " 668 "or transition.", 669 "The change to the requested resource failed because the " 670 "resource is in use or in transition.", 671 "Warning", 672 0, 673 {}, 674 "Remove the condition and resubmit the request if the " 675 "operation failed.", 676 }}, 677 MessageEntry{ 678 "ResourceMissingAtURI", 679 { 680 "Indicates that the operation expected an image or other resource " 681 "at the provided URI but none was found. Examples of this are in " 682 "requests that require URIs like Firmware Update.", 683 "The resource at the URI %1 was not found.", 684 "Critical", 685 1, 686 { 687 "string", 688 }, 689 "Place a valid resource at the URI or correct the URI and resubmit " 690 "the request.", 691 }}, 692 MessageEntry{ 693 "ResourceNotFound", 694 { 695 "Indicates that the operation expected a resource identifier that " 696 "corresponds to an existing resource but one was not found.", 697 "The requested resource of type %1 named %2 was not found.", 698 "Critical", 699 2, 700 { 701 "string", 702 "string", 703 }, 704 "Provide a valid resource identifier and resubmit the request.", 705 }}, 706 MessageEntry{ 707 "ResourceTypeIncompatible", 708 { 709 "Indicates that the resource type of the operation does not match " 710 "that for the operation destination. Examples of when this can " 711 "happen include during a POST to a collection using the wrong " 712 "resource type, an update where the @odata.types do not match or " 713 "on a major version incompatability.", 714 "The @odata.type of the request body %1 is incompatible with the " 715 "@odata.type of the resource which is %2.", 716 "Critical", 717 2, 718 { 719 "string", 720 "string", 721 }, 722 "Resubmit the request with a payload compatible with the " 723 "resource's schema.", 724 }}, 725 MessageEntry{ 726 "ServiceInUnknownState", 727 { 728 "Indicates that the operation failed because the service is in an " 729 "unknown state and cannot accept additional requests.", 730 "The operation failed because the service is in an unknown state " 731 "and can no longer take incoming requests.", 732 "Critical", 733 0, 734 {}, 735 "Restart the service and resubmit the request if the operation " 736 "failed.", 737 }}, 738 MessageEntry{"ServiceShuttingDown", 739 { 740 "Indicates that the operation failed as the service is " 741 "shutting down, such as when the service reboots.", 742 "The operation failed because the service is shutting " 743 "down and can no longer take incoming requests.", 744 "Critical", 745 0, 746 {}, 747 "When the service becomes available, resubmit the request " 748 "if the operation failed.", 749 }}, 750 MessageEntry{ 751 "ServiceTemporarilyUnavailable", 752 { 753 "Indicates the service is temporarily unavailable.", 754 "The service is temporarily unavailable. Retry in %1 seconds.", 755 "Critical", 756 1, 757 { 758 "string", 759 }, 760 "Wait for the indicated retry duration and retry the operation.", 761 }}, 762 MessageEntry{ 763 "SessionLimitExceeded", 764 { 765 "Indicates that a session establishment has been requested but the " 766 "operation failed due to the number of simultaneous sessions " 767 "exceeding the limit of the implementation.", 768 "The session establishment failed due to the number of " 769 "simultaneous sessions exceeding the limit of the implementation.", 770 "Critical", 771 0, 772 {}, 773 "Reduce the number of other sessions before trying to establish " 774 "the session or increase the limit of simultaneous sessions (if " 775 "supported).", 776 }}, 777 MessageEntry{ 778 "SessionTerminated", 779 { 780 "Indicates that the DELETE operation on the Session resource " 781 "resulted in the successful termination of the session.", 782 "The session was successfully terminated.", 783 "OK", 784 0, 785 {}, 786 "No resolution is required.", 787 }}, 788 MessageEntry{ 789 "SourceDoesNotSupportProtocol", 790 { 791 "Indicates that while attempting to access, connect to or transfer " 792 "a resource/file/image from another location that the other end of " 793 "the connection did not support the protocol", 794 "The other end of the connection at %1 does not support the " 795 "specified protocol %2.", 796 "Critical", 797 2, 798 { 799 "string", 800 "string", 801 }, 802 "Change protocols or URIs. ", 803 }}, 804 MessageEntry{"StringValueTooLong", 805 { 806 "Indicates that a string value passed to the given " 807 "resource exceeded its length limit. An example is when a " 808 "shorter limit is imposed by an implementation than that " 809 "allowed by the specification.", 810 "The string %1 exceeds the length limit %2.", 811 "Warning", 812 2, 813 { 814 "string", 815 "number", 816 }, 817 "Resubmit the request with an appropriate string length.", 818 }}, 819 MessageEntry{"Success", 820 { 821 "Indicates that all conditions of a successful operation " 822 "have been met.", 823 "Successfully Completed Request", 824 "OK", 825 0, 826 {}, 827 "None", 828 }}, 829 MessageEntry{ 830 "UnrecognizedRequestBody", 831 { 832 "Indicates that the service encountered an unrecognizable request " 833 "body that could not even be interpreted as malformed JSON.", 834 "The service detected a malformed request body that it was unable " 835 "to interpret.", 836 "Warning", 837 0, 838 {}, 839 "Correct the request body and resubmit the request if it failed.", 840 }}, 841 }; 842 } // namespace redfish::message_registries::base 843