466 lines
26 KiB
JSON
466 lines
26 KiB
JSON
{
|
|
"@Redfish.Copyright": "Copyright © 2014-2015 Distributed Management Task Force, Inc. (DMTF). All rights reserved.",
|
|
"@odata.type": "#MessageRegistry.1.0.0.MessageRegistry",
|
|
"Id": "Base.1.0.0",
|
|
"Name": "Base Message Registry",
|
|
"Language": "en",
|
|
"Description": "This registry defines the base messages for Redfish",
|
|
"RegistryPrefix": "Base",
|
|
"RegistryVersion": "1.0.0",
|
|
"OwningEntity": "DMTF",
|
|
"Messages": {
|
|
"Success": {
|
|
"Description": "Indicates that all conditions of a successful operation have been met.",
|
|
"Message": "Successfully Completed Request",
|
|
"Severity": "OK",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "None"
|
|
},
|
|
"GeneralError": {
|
|
"Description": "Indicates that a general error has occurred.",
|
|
"Message": "A general error has occurred. See ExtendedInfo for more information.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "See ExtendedInfo for more information."
|
|
},
|
|
"Created": {
|
|
"Description": "Indicates that all conditions of a successful creation operation have been met.",
|
|
"Message": "The resource has been created successfully",
|
|
"Severity": "OK",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "None"
|
|
},
|
|
"PropertyDuplicate": {
|
|
"Description": "Indicates that a duplicate property was included in the request body.",
|
|
"Message": "The property %1 was duplicated in the request.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 1,
|
|
"ParamTypes": [
|
|
"string"
|
|
],
|
|
"Resolution": "Remove the duplicate property from the request body and resubmit the request if the operation failed."
|
|
},
|
|
"PropertyUnknown": {
|
|
"Description": "Indicates that an unknown property was included in the request body.",
|
|
"Message": "The property %1 is not in the list of valid properties for the resource.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 1,
|
|
"ParamTypes": [
|
|
"string"
|
|
],
|
|
"Resolution": "Remove the unknown property from the request body and resubmit the request if the operation failed."
|
|
},
|
|
"PropertyValueTypeError": {
|
|
"Description": "Indicates that a property was given the wrong value type, such as when a number is supplied for a property that requires a string.",
|
|
"Message": "The value %1 for the property %2 is of a different type than the property can accept.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 2,
|
|
"ParamTypes": [
|
|
"string",
|
|
"string"
|
|
],
|
|
"Resolution": "Correct the value for the property in the request body and resubmit the request if the operation failed."
|
|
},
|
|
"PropertyValueFormatError": {
|
|
"Description": "Indicates that a property was given the correct value type but the value of that property was not supported. This includes value size/length exceeded.",
|
|
"Message": "The value %1 for the property %2 is of a different format than the property can accept.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 2,
|
|
"ParamTypes": [
|
|
"string",
|
|
"string"
|
|
],
|
|
"Resolution": "Correct the value for the property in the request body and resubmit the request if the operation failed."
|
|
},
|
|
"PropertyValueNotInList": {
|
|
"Description": "Indicates that a property was given the correct value type but the value of that property was not supported. This values not in an enumeration",
|
|
"Message": "The value %1 for the property %2 is not in the list of acceptable values.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 2,
|
|
"ParamTypes": [
|
|
"string",
|
|
"string"
|
|
],
|
|
"Resolution": "Choose a value from the enumeration list that the implementation can support and resubmit the request if the operation failed."
|
|
},
|
|
"PropertyNotWritable": {
|
|
"Description": "Indicates that a property was given a value in the request body, but the property is a readonly property.",
|
|
"Message": "The property %1 is a read only property and cannot be assigned a value.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 1,
|
|
"ParamTypes": [
|
|
"string"
|
|
],
|
|
"Resolution": "Remove the property from the request body and resubmit the request if the operation failed."
|
|
},
|
|
"PropertyMissing": {
|
|
"Description": "Indicates that a required property was not supplied as part of the request.",
|
|
"Message": "The property %1 is a required property and must be included in the request.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 1,
|
|
"ParamTypes": [
|
|
"string"
|
|
],
|
|
"Resolution": "Ensure that the property is in the request body and has a valid value and resubmit the request if the operation failed."
|
|
},
|
|
"MalformedJSON": {
|
|
"Description": "Indicates that the request body was malformed JSON. Could be duplicate, syntax error,etc.",
|
|
"Message": "The request body submitted was malformed JSON and could not be parsed by the receiving service.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "Ensure that the request body is valid JSON and resubmit the request."
|
|
},
|
|
"ActionNotSupported": {
|
|
"Description": "Indicates that the action supplied with the POST operation is not supported by the resource.",
|
|
"Message": "The action %1 is not supported by the resource.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 1,
|
|
"ParamTypes": [
|
|
"string"
|
|
],
|
|
"Resolution": "The action supplied cannot be resubmitted to the implementation. Perhaps the action was invalid, the wrong resource was the target or the implementation documentation may be of assistance."
|
|
},
|
|
"ActionParameterMissing": {
|
|
"Description": "Indicates that the action requested was missing a parameter that is required to process the action.",
|
|
"Message": "The action %1 requires the parameter %2 to be present in the request body.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 2,
|
|
"ParamTypes": [
|
|
"string",
|
|
"string"
|
|
],
|
|
"Resolution": "Supply the action with the required parameter in the request body when the request is resubmitted."
|
|
},
|
|
"ActionParameterDuplicate": {
|
|
"Description": "Indicates that the action was supplied with a duplicated parameter in the request body.",
|
|
"Message": "The action %1 was submitted with more than one value for the parameter %2.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 2,
|
|
"ParamTypes": [
|
|
"string",
|
|
"string"
|
|
],
|
|
"Resolution": "Resubmit the action with only one instance of the parameter in the request body if the operation failed."
|
|
},
|
|
"ActionParameterUnknown": {
|
|
"Description": "Indicates that an action was submitted but a parameter supplied did not match any of the known parameters.",
|
|
"Message": "The action %1 was submitted with with the invalid parameter %2.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 2,
|
|
"ParamTypes": [
|
|
"string",
|
|
"string"
|
|
],
|
|
"Resolution": "Correct the invalid parameter and resubmit the request if the operation failed."
|
|
},
|
|
"ActionParameterValueTypeError": {
|
|
"Description": "Indicates that a parameter was given the wrong value type, such as when a number is supplied for a parameter that requires a string.",
|
|
"Message": "The value %1 for the parameter %2 in the action %3 is of a different type than the parameter can accept.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 3,
|
|
"ParamTypes": [
|
|
"string",
|
|
"string",
|
|
"string"
|
|
],
|
|
"Resolution": "Correct the value for the parameter in the request body and resubmit the request if the operation failed."
|
|
},
|
|
"ActionParameterValueFormatError": {
|
|
"Description": "Indicates that a parameter was given the correct value type but the value of that parameter was not supported. This includes value size/length exceeded.",
|
|
"Message": "The value %1 for the parameter %2 in the action %3 is of a different format than the parameter can accept.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 3,
|
|
"ParamTypes": [
|
|
"string",
|
|
"string",
|
|
"string"
|
|
],
|
|
"Resolution": "Correct the value for the parameter in the request body and resubmit the request if the operation failed."
|
|
},
|
|
"ActionParameterNotSupported": {
|
|
"Description": "Indicates that the parameter supplied for the action is not supported on the resource.",
|
|
"Message": "The parameter %1 for the action %2 is not supported on the target resource.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 2,
|
|
"ParamTypes": [
|
|
"string",
|
|
"string"
|
|
],
|
|
"Resolution": "Remove the parameter supplied and resubmit the request if the operation failed."
|
|
},
|
|
"QueryParameterValueTypeError": {
|
|
"Description": "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.",
|
|
"Message": "The value %1 for the query parameter %2 is of a different type than the parameter can accept.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 2,
|
|
"ParamTypes": [
|
|
"string",
|
|
"string"
|
|
],
|
|
"Resolution": "Correct the value for the query parameter in the request and resubmit the request if the operation failed."
|
|
},
|
|
"QueryParameterValueFormatError": {
|
|
"Description": "Indicates that a query parameter was given the correct value type but the value of that parameter was not supported. This includes value size/length exceeded.",
|
|
"Message": "The value %1 for the parameter %2 is of a different format than the parameter can accept.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 2,
|
|
"ParamTypes": [
|
|
"string",
|
|
"string"
|
|
],
|
|
"Resolution": "Correct the value for the query parameter in the request and resubmit the request if the operation failed."
|
|
},
|
|
"QueryParameterOutOfRange": {
|
|
"Description": "Indicates that a query parameter was supplied that is out of range for the given resource. This can happen with values that are too low or beyond that possible for the supplied resource, such as when a page is requested that is beyond the last page.",
|
|
"Message": "The value %1 for the query parameter %2 is out of range %3.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 3,
|
|
"ParamTypes": [
|
|
"string",
|
|
"string",
|
|
"string"
|
|
],
|
|
"Resolution": "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 that is within the range of valid pages."
|
|
},
|
|
"QueryNotSupportedOnResource": {
|
|
"Description": "Indicates that query is not supported on the given resource, such as when a start/count query is attempted on a resource that is not a collection.",
|
|
"Message": "Querying is not supported on the requested resource.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "Remove the query parameters and resubmit the request if the operation failed."
|
|
},
|
|
"QueryNotSupported": {
|
|
"Description": "Indicates that query is not supported on the implementation.",
|
|
"Message": "Querying is not supported by the implementation.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "Remove the query parameters and resubmit the request if the operation failed."
|
|
},
|
|
"SessionLimitExceeded": {
|
|
"Description": "Indicates that a session establishment has been requested but the operation failed due to the number of simultaneous sessions exceeding the limit of the implementation.",
|
|
"Message": "The session establishment failed due to the number of simultaneous sessions exceeding the limit of the implementation.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "Reduce the number of other sessions before trying to establish the session or increase the limit of simultaneous sessions (if supported)."
|
|
},
|
|
"EventSubscriptionLimitExceeded": {
|
|
"Description": "Indicates that a event subscription establishment has been requested but the operation failed due to the number of simultaneous connection exceeding the limit of the implementation.",
|
|
"Message": "The event subscription failed due to the number of simultaneous subscriptions exceeding the limit of the implementation.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "Reduce the number of other subscriptions before trying to establish the event subscription or increase the limit of simultaneous subscriptions (if supported)."
|
|
},
|
|
"ResourceCannotBeDeleted": {
|
|
"Description": "Indicates that a delete operation was attempted on a resource that cannot be deleted.",
|
|
"Message": "The delete request failed because the resource requested cannot be deleted.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "Do not attempt to delete a non-deletable resource."
|
|
},
|
|
"ResourceInUse": {
|
|
"Description": "Indicates that a change was requested to a resource but the change was rejected due to the resource being in use or transition.",
|
|
"Message": "The change to the requested resource failed because the resource is in use or in transition.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "Remove the condition and resubmit the request if the operation failed."
|
|
},
|
|
"ResourceAlreadyExists": {
|
|
"Description": "Indicates that a resource change or creation was attempted but that the operation cannot proceed because the resource already exists.",
|
|
"Message": "The requested resource already exists.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "Do not repeat the create operation as the resource has already been created."
|
|
},
|
|
"CreateFailedMissingReqProperties": {
|
|
"Description": "Indicates that a create was attempted on a resource but that properties that are required for the create operation were missing from the request.",
|
|
"Message": "The create operation failed because the required property %1 was missing from the request.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 1,
|
|
"ParamTypes": [
|
|
"string"
|
|
],
|
|
"Resolution": "Correct the body to include the required property with a valid value and resubmit the request if the operation failed."
|
|
},
|
|
"CreateLimitReachedForResource": {
|
|
"Description": "Indicates that no more resources can be created on the resource as it has reached its create limit.",
|
|
"Message": "The create operation failed because the resource has reached the limit of possible resources.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "Either delete resources and resubmit the request if the operation failed or do not resubmit the request."
|
|
},
|
|
"ServiceShuttingDown": {
|
|
"Description": "Indicates that the operation failed as the service is shutting down, such as when the service reboots.",
|
|
"Message": "The operation failed because the service is shutting down and can no longer take incoming requests.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "When the service becomes available, resubmit the request if the operation failed."
|
|
},
|
|
"ServiceInUnknownState": {
|
|
"Description": "Indicates that the operation failed because the service is in an unknown state and cannot accept additional requests.",
|
|
"Message": "The operation failed because the service is in an unknown state and can no longer take incoming requests.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "Restart the service and resubmit the request if the operation failed."
|
|
},
|
|
"NoValidSession": {
|
|
"Description": "Indicates that the operation failed because a valid session is required in order to access any resources.",
|
|
"Message": "There is no valid session established with the implementation.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "Establish as session before attempting any operations."
|
|
},
|
|
"InsufficientPrivilege": {
|
|
"Description": "Indicates that the credentials associated with the established session do not have sufficient privileges for the requested operation",
|
|
"Message": "There are insufficient privileges for the account or credentials associated with the current session to perform the requested operation.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "Either abandon the operation or change the associated access rights and resubmit the request if the operation failed."
|
|
},
|
|
"AccountModified": {
|
|
"Description": "Indicates that the account was successfully modified.",
|
|
"Message": "The account was successfully modifed.",
|
|
"Severity": "OK",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "No resolution is required."
|
|
},
|
|
"AccountNotModified": {
|
|
"Description": "Indicates that the modification requested for the account was not successful.",
|
|
"Message": "The account modification request failed.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "The modification may have failed due to permission issues or issues with the request body."
|
|
},
|
|
"AccountRemoved": {
|
|
"Description": "Indicates that the account was successfully removed.",
|
|
"Message": "The account was successfully removed.",
|
|
"Severity": "OK",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "No resolution is required."
|
|
},
|
|
"AccountForSessionNoLongerExists": {
|
|
"Description": "Indicates that the account for the session has been removed, thus the session has been removed as well.",
|
|
"Message": "The account for the current session has been removed, thus the current session has been removed as well.",
|
|
"Severity": "OK",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "Attempt to connect with a valid account."
|
|
},
|
|
"InvalidObject": {
|
|
"Description": "Indicates that the object in question is invalid according to the implementation. Examples include a firmware update malformed URI.",
|
|
"Message": "The object at %1 is invalid.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 1,
|
|
"ParamTypes": [
|
|
"string"
|
|
],
|
|
"Resolution": "Either the object is malformed or the URI is not correct. Correct the condition and resubmit the request if it failed."
|
|
},
|
|
"InternalError": {
|
|
"Description": "Indicates that the request failed for an unknown internal error but that the service is still operational.",
|
|
"Message": "The request failed due to an internal service error. The service is still operational.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "Resubmit the request. If the problem persists, consider resetting the service."
|
|
},
|
|
"UnrecognizedRequestBody": {
|
|
"Description": "Indicates that the service encountered an unrecognizable request body that could not even be interpreted as malformed JSON.",
|
|
"Message": "The service detected a malformed request body that it was unable to interpret.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 0,
|
|
"Resolution": "Correct the request body and resubmit the request if it failed."
|
|
},
|
|
"ResourceMissingAtURI": {
|
|
"Description": "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 like Firmware Update.",
|
|
"Message": "The resource at the URI %1 was not found.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 1,
|
|
"ParamTypes": [
|
|
"string"
|
|
],
|
|
"Resolution": "Place a valid resource at thr URI or correct the URI and resubmit the request."
|
|
},
|
|
"ResourceAtUriInUnknownFormat": {
|
|
"Description": "Indicates that the URI was valid but the resource or image at that URI was in a format not supported by the service.",
|
|
"Message": "The resource at %1 is in a format not recognized by the service.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 1,
|
|
"ParamTypes": [
|
|
"string"
|
|
],
|
|
"Resolution": "Place an image or resource or file that is recognized by the service at the URI."
|
|
},
|
|
"ResourceAtUriUnauthorized": {
|
|
"Description": "Indicates that the attempt to access the resource/file/image at the URI was unauthorized.",
|
|
"Message": "While accessing the resource at %1, the service received an authorization error %2.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 2,
|
|
"ParamTypes": [
|
|
"string",
|
|
"string"
|
|
],
|
|
"Resolution": "Ensure that the appropriate access is provided for the service in order for it to access the URI."
|
|
},
|
|
"CouldNotEstablishConnection": {
|
|
"Description": "Indicates that the attempt to access the resource/file/image at the URI was unsuccessful because a session could not be established.",
|
|
"Message": "The service failed to establish a connection with the URI %1.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 1,
|
|
"ParamTypes": [
|
|
"string"
|
|
],
|
|
"Resolution": "Ensure that the URI contains a valid and reachable node name, protocol information and other URI components."
|
|
},
|
|
"SourceDoesNotSupportProtocol": {
|
|
"Description": "Indicates that while attempting to access, connect to or transfer a resource/file/image from another location that the other end of the connection did not support the protocol",
|
|
"Message": "The other end of the connection at %1 does not support the specified protocol %2.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 2,
|
|
"ParamTypes": [
|
|
"string",
|
|
"string"
|
|
],
|
|
"Resolution": "Change protocols or URIs. "
|
|
},
|
|
"AccessDenied": {
|
|
"Description": "Indicates that while attempting to access, connect to or transfer to/from another resource, the service was denied access.",
|
|
"Message": "While attempting to establish a connection to %1, the service was denied access.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 1,
|
|
"ParamTypes": [
|
|
"string"
|
|
],
|
|
"Resolution": "Attempt to ensure that the URI is correct and that the service has the appropriate credentials."
|
|
},
|
|
"ServiceTemporarilyUnavailable": {
|
|
"Description": "Indicates the service is temporarily unavailable.",
|
|
"Message": "The service is temporarily unavailable. Retry in %1 seconds.",
|
|
"Severity": "Critical",
|
|
"NumberOfArgs": 1,
|
|
"ParamTypes": [
|
|
"string"
|
|
],
|
|
"Resolution": "Wait for the indicated retry duration and retry the operation."
|
|
},
|
|
"InvalidIndex": {
|
|
"Description": "The Index is not valid.",
|
|
"Message": "The Index %1 is not a valid offset into the array.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 1,
|
|
"ParamTypes": [
|
|
"number"
|
|
],
|
|
"Resolution": "Verify the index value provided is within the bounds of the array."
|
|
},
|
|
"PropertyValueModified": {
|
|
"Description": "Indicates that a property was given the correct value type but the value of that property was modified. Examples are truncated or rounded values.",
|
|
"Message": "The property %1 was assigned the value %2 due to modification by the service.",
|
|
"Severity": "Warning",
|
|
"NumberOfArgs": 2,
|
|
"ParamTypes": [
|
|
"string",
|
|
"string"
|
|
],
|
|
"Resolution": "No resolution is required."
|
|
}
|
|
}
|
|
}
|