{ "@Redfish.Copyright": "Copyright 2014-2026 DMTF. All rights reserved.", "@odata.type": "#MessageRegistry.v1_7_0.MessageRegistry", "Id": "Base.1.21.2", "Name": "Base Message Registry", "Language": "en", "Description": "This registry defines the base messages for Redfish.", "RegistryPrefix": "Base", "RegistryVersion": "1.21.2", "OwningEntity": "DMTF", "Release": "2025.1", "Messages": { "Success": { "Description": "Indicates that all conditions of a successful operation were met.", "LongDescription": "This message shall indicate that all conditions of a successful operation were met.", "Message": "The request completed successfully.", "Example": "The request completed successfully.", "Severity": "OK", "MessageSeverity": "OK", "NumberOfArgs": 0, "Resolution": "None." }, "GeneralError": { "Description": "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.", "LongDescription": "This message shall indicate that a general error has occurred. Implementations should not use this message in `@Message.ExtendedInfo`. If used in `@Message.ExtendedInfo`, implementations should include a `Resolution` property with this message and provide a service-defined resolution to indicate how to resolve the error.", "Message": "A general error has occurred. See Resolution for information on how to resolve the error, or @Message.ExtendedInfo if Resolution is not provided.", "Example": "A general error has occurred. See Resolution for information on how to resolve the error, or @Message.ExtendedInfo if Resolution is not provided.", "Severity": "Critical", "MessageSeverity": "Critical", "NumberOfArgs": 0, "Resolution": "None." }, "Created": { "Description": "Indicates that all conditions of a successful create operation were met.", "LongDescription": "This message shall indicate that all conditions of a successful create operation were met.", "Message": "The resource was created successfully.", "Example": "The resource was created successfully.", "Severity": "OK", "MessageSeverity": "OK", "NumberOfArgs": 0, "Resolution": "None." }, "NoOperation": { "Description": "Indicates that the requested operation will not perform any changes on the service.", "LongDescription": "This message shall indicate that the requested operation will not perform any changes on the service.", "Message": "The request body submitted contain no data to act upon and no changes to the resource took place.", "Example": "The request body submitted contain no data to act upon and no changes to the resource took place.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.4.0", "NumberOfArgs": 0, "Resolution": "Add properties in the JSON object and resubmit the request." }, "PropertyDuplicate": { "Description": "Indicates that a duplicate property was included in the request body.", "LongDescription": "This message shall indicate that a duplicate property was included in the request body.", "Message": "The property '%1' was duplicated in the request.", "Example": "The property 'Name' was duplicated in the request.", "Severity": "Warning", "MessageSeverity": "Warning", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The name of the duplicate property." ], "ArgLongDescriptions": [ "This argument shall contain the name of the duplicate property. The value should follow RFC6901-defined JSON pointer notation rules." ], "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.", "LongDescription": "This message shall indicate 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.", "Example": "The property 'InvalidPropertyName' is not in the list of valid properties for the resource.", "Severity": "Warning", "MessageSeverity": "Warning", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The name of the unknown property." ], "ArgLongDescriptions": [ "This argument shall contain the name of the unknown property. The value should follow RFC6901-defined JSON pointer notation rules." ], "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.", "LongDescription": "This message shall indicate that a property was given the wrong value type.", "Message": "The value '%1' for the property %2 is not a type that the property can accept.", "Example": "The value '123' for the property 'Manufacturer' is not a type that the property can accept.", "Severity": "Warning", "MessageSeverity": "Warning", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The value provided for the property.", "The name of the property." ], "ArgLongDescriptions": [ "This argument shall contain the value provided for the property. Numeric values shall be converted to a string, and null values shall be represented by the string `null`.", "This argument shall contain the name of the property. The value should follow RFC6901-defined JSON pointer notation rules." ], "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 format of the value is not supported.", "LongDescription": "This message shall indicate that a property was given the correct value type but the format of the value is not supported.", "Message": "The value '%1' for the property %2 is not a format that the property can accept.", "Example": "The value '2024-01-01' for the property 'ManufactureDate' is not a format that the property can accept.", "Severity": "Warning", "MessageSeverity": "Warning", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The value provided for the property.", "The name of the property." ], "ArgLongDescriptions": [ "This argument shall contain the value provided for the property. Numeric values shall be converted to a string, and null values shall be represented by the string `null`.", "This argument shall contain the name of the property. The value should follow RFC6901-defined JSON pointer notation rules." ], "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. The value is not in an enumeration.", "LongDescription": "This message shall indicate that a property was given the correct value type but the value of that property was not supported.", "Message": "The value '%1' for the property %2 is not in the list of acceptable values.", "Example": "The value 'InvalidValue' for the property 'Status' is not in the list of acceptable values.", "Severity": "Warning", "MessageSeverity": "Warning", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The value provided for the property.", "The name of the property." ], "ArgLongDescriptions": [ "This argument shall contain the value provided for the property.", "This argument shall contain the name of the property. The value should follow RFC6901-defined JSON pointer notation rules." ], "Resolution": "Choose a value from the enumeration list that the implementation can support and resubmit the request if the operation failed." }, "PropertyValueOutOfRange": { "Description": "Indicates that a property was given the correct value type but the value of that property is outside the supported range.", "LongDescription": "This value shall indicate that a property was given the correct value type but the value of that property is outside the supported range.", "Message": "The value '%1' for the property %2 is not in the supported range of acceptable values.", "Example": "The value '-5' for the property 'MemorySizeGB' is not in the supported range of acceptable values.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.3.0", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The value provided for the property.", "The name of the property." ], "ArgLongDescriptions": [ "This argument shall contain the value provided for the property.", "This argument shall contain the name of the property. The value should follow RFC6901-defined JSON pointer notation rules." ], "Resolution": "Correct the value for the property in the request body and resubmit the request if the operation failed." }, "PropertyValueError": { "Description": "Indicates that a property was given an invalid value.", "LongDescription": "This message shall indicate that a property was given an invalid value, and the value cannot or should not be included in the message text.", "Message": "The value provided for the property '%1' is not valid.", "Example": "The value provided for the property 'Status' is not valid.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.11.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The name of the property." ], "ArgLongDescriptions": [ "This argument shall contain the name of the property. The value should follow RFC6901-defined JSON pointer notation rules." ], "Resolution": "Correct the value for the property in the request body 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 read-only property.", "LongDescription": "This message shall indicate that a property was given a value in the request body, but the property is a read-only property.", "Message": "The property '%1' is a read-only property and cannot be assigned a value.", "Example": "The property 'Manufacturer' is a read-only property and cannot be assigned a value.", "Severity": "Warning", "MessageSeverity": "Warning", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The name of the property." ], "ArgLongDescriptions": [ "This argument shall contain the name of the property. The value should follow RFC6901-defined JSON pointer notation rules." ], "Resolution": "Remove the property from the request body and resubmit the request if the operation failed." }, "PropertyNotUpdated": { "Description": "Indicates that a property was not updated due to an internal service error, but the service is still functional.", "LongDescription": "This message shall indicate that a property was not updated due to an internal service error, but the service is still functional.", "Message": "The property '%1' was not updated due to an internal service error. The service is still operational.", "Example": "The property 'Status' was not updated due to an internal service error. The service is still operational.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.12.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The name of the property." ], "ArgLongDescriptions": [ "This argument shall contain the name of the property. The value should follow RFC6901-defined JSON pointer notation rules." ], "Resolution": "Resubmit the request. If the problem persists, check for additional messages and consider resetting the service." }, "PropertyMissing": { "Description": "Indicates that a required property was not supplied as part of the request.", "LongDescription": "This message shall indicate 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.", "Example": "The property 'Name' is a required property and must be included in the request.", "Severity": "Warning", "MessageSeverity": "Warning", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The name of the property." ], "ArgLongDescriptions": [ "This argument shall contain the name of the property. The value should follow RFC6901-defined JSON pointer notation rules." ], "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.", "LongDescription": "This message shall indicate that the request body was malformed JSON.", "Message": "The request body submitted was malformed JSON and could not be parsed by the receiving service.", "Example": "The request body submitted was malformed JSON and could not be parsed by the receiving service.", "Severity": "Critical", "MessageSeverity": "Critical", "NumberOfArgs": 0, "Resolution": "Ensure that the request body is valid JSON and resubmit the request." }, "InvalidJSON": { "Description": "Indicates that the request body contains invalid JSON.", "LongDescription": "This message shall indicate that the request body contains invalid JSON.", "Message": "The request body submitted is invalid JSON starting at line %1 and could not be parsed by the receiving service.", "Example": "The request body submitted is invalid JSON starting at line 10 and could not be parsed by the receiving service.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.10.0", "NumberOfArgs": 1, "ParamTypes": [ "number" ], "ArgDescriptions": [ "The line number where the invalid JSON starts." ], "ArgLongDescriptions": [ "This argument shall contain the line number where the invalid JSON starts." ], "Resolution": "Ensure that the request body is valid JSON and resubmit the request." }, "EmptyJSON": { "Description": "Indicates that the request body contained an empty JSON object when one or more properties are expected in the body.", "LongDescription": "This message shall indicate that the request body contained an empty JSON object when one or more properties are expected in the body.", "Message": "The request body submitted contained an empty JSON object and the service is unable to process it.", "Example": "The request body submitted contained an empty JSON object and the service is unable to process it.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.2.0", "NumberOfArgs": 0, "Resolution": "Add properties in the JSON object and resubmit the request." }, "ActionNotSupported": { "Description": "Indicates that the action supplied with the `POST` operation is not supported by the resource.", "LongDescription": "This message shall indicate that the action supplied with the `POST` operation is not supported by the resource.", "Message": "The action '%1' is not supported by the resource.", "Example": "The action 'DeactivateCloakingDevice' is not supported by the resource.", "Severity": "Critical", "MessageSeverity": "Critical", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The name of the action." ], "ArgLongDescriptions": [ "This argument shall contain the name of the action." ], "Resolution": "Check the Actions property in the resource for the supported actions." }, "ActionParameterMissing": { "Description": "Indicates that the action requested was missing an action parameter that is required to process the action.", "LongDescription": "This message shall indicate that the action requested was missing an action parameter that is required to process the action.", "Message": "The action '%1' requires the parameter '%2' to be present in the request body.", "Example": "The action 'Reset' requires the parameter 'ResetType' to be present in the request body.", "Severity": "Critical", "MessageSeverity": "Critical", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The name of the action.", "The name of the action parameter." ], "ArgLongDescriptions": [ "This argument shall contain the name of the action.", "This argument shall contain the name of the action parameter." ], "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 action parameter in the request body.", "LongDescription": "This message shall indicate that the action was supplied with a duplicated action parameter in the request body.", "Message": "The action '%1' was submitted with more than one value for the parameter '%2'.", "Example": "The action 'Reset' was submitted with more than one value for the parameter 'ResetType'.", "Severity": "Warning", "MessageSeverity": "Warning", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The name of the action.", "The name of the action parameter." ], "ArgLongDescriptions": [ "This argument shall contain the name of the action.", "This argument shall contain the name of the action parameter." ], "Resolution": "Resubmit the action with only one instance of the action parameter in the request body if the operation failed." }, "ActionParameterUnknown": { "Description": "Indicates that an action was submitted but an action parameter supplied did not match any of the known parameters.", "LongDescription": "This message shall indicate that an action was submitted but an action parameter supplied did not match any of the known parameters.", "Message": "The action '%1' was submitted with the invalid parameter '%2'.", "Example": "The action 'Reset' was submitted with the invalid parameter 'InvalidParameter'.", "Severity": "Warning", "MessageSeverity": "Warning", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The name of the action.", "The name of the action parameter." ], "ArgLongDescriptions": [ "This argument shall contain the name of the action.", "This argument shall contain the name of the action parameter." ], "Resolution": "Correct the invalid action 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.", "LongDescription": "This message shall indicate 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 not a type that the parameter can accept.", "Example": "The value '123' for the parameter 'ResetType' in the action 'Reset' is not a type that the parameter can accept.", "Severity": "Warning", "MessageSeverity": "Warning", "NumberOfArgs": 3, "ParamTypes": [ "string", "string", "string" ], "ArgDescriptions": [ "The value provided for the action parameter.", "The name of the action parameter.", "The name of the action." ], "ArgLongDescriptions": [ "This argument shall contain the value provided for the action parameter. Numeric values shall be converted to a string, and null values shall be represented by the string `null`.", "This argument shall contain the name of the action parameter.", "This argument shall contain the name of the action." ], "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 format of the value is not supported.", "LongDescription": "This message shall indicate that a parameter was given the correct value type but the format of the value is not supported.", "Message": "The value '%1' for the parameter %2 in the action %3 is not a format that the parameter can accept.", "Example": "The value '2024-01-01' for the parameter 'ManufactureDate' in the action 'UpdateManufactureDate' is not a format that the parameter can accept.", "Severity": "Warning", "MessageSeverity": "Warning", "NumberOfArgs": 3, "ParamTypes": [ "string", "string", "string" ], "ArgDescriptions": [ "The value provided for the action parameter.", "The name of the action parameter.", "The name of the action." ], "ArgLongDescriptions": [ "This argument shall contain the value provided for the action parameter. Numeric values shall be converted to a string, and null values shall be represented by the string `null`.", "This argument shall contain the name of the action parameter.", "This argument shall contain the name of the action." ], "Resolution": "Correct the value for the parameter in the request body and resubmit the request if the operation failed." }, "ActionParameterValueNotInList": { "Description": "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.", "LongDescription": "This message shall indicate that a parameter was given the correct value type but the value of that parameter was not supported.", "Message": "The value '%1' for the parameter %2 in the action %3 is not in the list of acceptable values.", "Example": "The value 'InvalidValue' for the parameter 'ResetType' in the action 'Reset' is not in the list of acceptable values.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.10.0", "NumberOfArgs": 3, "ParamTypes": [ "string", "string", "string" ], "ArgDescriptions": [ "The value provided for the action parameter.", "The name of the action parameter.", "The name of the action." ], "ArgLongDescriptions": [ "This argument shall contain the value provided for the action parameter.", "This argument shall contain the name of the action parameter.", "This argument shall contain the name of the action." ], "Resolution": "Choose a value from the enumeration list that the implementation can support and resubmit the request if the operation failed." }, "ActionParameterValueOutOfRange": { "Description": "Indicates that a parameter was given the correct value type but the value of that parameter is outside the supported range.", "LongDescription": "This value shall indicate that a parameter was given the correct value type but the value of that parameter is outside the supported range.", "Message": "The value '%1' for the parameter %2 in the action %3 is not in the supported range of acceptable values.", "Example": "The value '-5' for the parameter 'MemorySizeGB' in the action 'UpdateMemorySize' is not in the supported range of acceptable values.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.18.0", "NumberOfArgs": 3, "ParamTypes": [ "string", "string", "string" ], "ArgDescriptions": [ "The value provided for the parameter.", "The name of the parameter.", "The name of the action." ], "ArgLongDescriptions": [ "This argument shall contain the value provided for the parameter.", "This argument shall contain the name of the parameter.", "This argument shall contain the name of the action." ], "Resolution": "Correct the value for the parameter in the request body and resubmit the request if the operation failed." }, "ActionParameterValueError": { "Description": "Indicates that a parameter was given an invalid value.", "LongDescription": "This message shall indicate that a parameter was given an invalid value, and the value cannot or should not be included in the message.", "Message": "The value for the parameter '%1' in the action '%2' is invalid.", "Example": "The value 'InvalidValue' for the parameter 'ResetType' in the action 'Reset' is invalid.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.11.0", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The name of the action parameter.", "The name of the action." ], "ArgLongDescriptions": [ "This argument shall contain the name of the action parameter.", "This argument shall contain the name of the action." ], "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.", "LongDescription": "This message shall indicate 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.", "Example": "The parameter 'InvalidParameter' for the action 'Reset' is not supported on the target resource.", "Severity": "Warning", "MessageSeverity": "Warning", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The name of the action parameter.", "The name of the action." ], "ArgLongDescriptions": [ "This argument shall contain the name of the action parameter.", "This argument shall contain the name of the action." ], "Resolution": "Remove the parameter supplied and resubmit the request if the operation failed." }, "ArraySizeTooLong": { "Description": "Indicates that the size of the array exceeded the maximum number of elements.", "LongDescription": "This message shall indicate that the size of the array exceeded the maximum number of elements.", "Message": "The array provided for property '%1' exceeds the size limit %2.", "Example": "The array provided for property 'AssociatedDrives' exceeds the size limit 100.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.16.0", "NumberOfArgs": 2, "ParamTypes": [ "string", "number" ], "ArgDescriptions": [ "The name of the property.", "The maximum number of elements supported for the array." ], "ArgLongDescriptions": [ "This argument shall contain the name of the property.", "This argument shall contain the maximum number of elements supported for the array for this property." ], "Resolution": "Resubmit the request with an appropriate array size." }, "ArraySizeTooShort": { "Description": "Indicates that the size of the array is less than the minimum number of elements.", "LongDescription": "This message shall indicate that the size of the array is less than the minimum number of elements.", "Message": "The array provided for property '%1' is under the minimum size limit %2.", "Example": "The array provided for property 'AssociatedDrives' is under the minimum size limit 1.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.16.0", "NumberOfArgs": 2, "ParamTypes": [ "string", "number" ], "ArgDescriptions": [ "The name of the property.", "The minimum number of elements supported for the array." ], "ArgLongDescriptions": [ "This argument shall contain the name of the property.", "This argument shall contain the minimum number of elements supported for the array for this property." ], "Resolution": "Resubmit the request with an appropriate array size." }, "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.", "LongDescription": "This message shall indicate 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 not a type that the parameter can accept.", "Example": "The value '123' for the query parameter '$filter' is not a type that the parameter can accept.", "Severity": "Warning", "MessageSeverity": "Warning", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The value provided for the query parameter.", "The query parameter." ], "ArgLongDescriptions": [ "This argument shall contain the value provided for the query parameter.", "This argument shall contain the name of the query parameter." ], "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 format of the value is not supported.", "LongDescription": "This message shall indicate that a query parameter was given the correct value type but the format of the value is not supported.", "Message": "The value '%1' for the parameter %2 is not a format that the parameter can accept.", "Example": "The value '2024-01-01' for the query parameter '$filter' is not a format that the parameter can accept.", "Severity": "Warning", "MessageSeverity": "Warning", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The value provided for the query parameter.", "The query parameter." ], "ArgLongDescriptions": [ "This argument shall contain the value provided for the query parameter.", "This argument shall contain the name of the query parameter." ], "Resolution": "Correct the value for the query parameter in the request and resubmit the request if the operation failed." }, "QueryParameterValueError": { "Description": "Indicates that a query parameter was given an invalid value.", "LongDescription": "This message shall indicate that a query parameter was given an invalid value that cannot or should not be included in the message.", "Message": "The value for the parameter '%1' is invalid.", "Example": "The value 'Contoso' for the parameter '$top' is invalid.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.11.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The query parameter." ], "ArgLongDescriptions": [ "This argument shall contain the name of the query parameter." ], "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 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.", "LongDescription": "This message shall indicate that a query parameter was provided that is out of range for the given resource.", "Message": "The value '%1' for the query parameter %2 is out of range %3.", "Example": "The value '1000' for the query parameter '$top' is out of range. The maximum supported value is 100.", "Severity": "Warning", "MessageSeverity": "Warning", "NumberOfArgs": 3, "ParamTypes": [ "string", "string", "string" ], "ArgDescriptions": [ "The value provided for the query parameter.", "The query parameter.", "The valid range for the query parameter." ], "ArgLongDescriptions": [ "This argument shall contain the value provided for the query parameter.", "This argument shall contain the name of the query parameter.", "This argument shall contain a string representation of the valid range of values supported for the query parameter." ], "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 number that is within the range of valid pages." }, "QueryNotSupportedOnResource": { "Description": "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.", "LongDescription": "This message shall indicate that query is not supported on the given resource.", "Message": "Querying is not supported on the requested resource.", "Severity": "Warning", "MessageSeverity": "Warning", "NumberOfArgs": 0, "Example": "Querying is not supported on the requested resource.", "Resolution": "Remove the query parameters and resubmit the request if the operation failed." }, "QueryNotSupportedOnOperation": { "Description": "Indicates that query is not supported with the given operation, such as when the `$expand` query is attempted with a `PATCH` operation.", "LongDescription": "This message shall indicate that query is not supported with the given operation.", "Message": "Querying is not supported with the requested operation.", "Example": "Querying is not supported with the requested operation.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.6.0", "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.", "LongDescription": "This message shall indicate that query is not supported on the implementation.", "Message": "Querying is not supported by the implementation.", "Example": "Querying is not supported by the implementation.", "Severity": "Warning", "MessageSeverity": "Warning", "NumberOfArgs": 0, "Resolution": "Remove the query parameters and resubmit the request if the operation failed." }, "QueryCombinationInvalid": { "Description": "Indicates the request contains multiple query parameters and that two or more of them cannot be used together.", "LongDescription": "This message shall indicate that the request contains multiple query parameters and that two or more of them cannot be used together.", "Message": "Two or more query parameters in the request cannot be used together.", "Example": "Two or more query parameters in the request cannot be used together.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.6.0", "NumberOfArgs": 0, "Resolution": "Remove one or more of the query parameters and resubmit the request if the operation failed." }, "QueryParameterUnsupported": { "Description": "Indicates that a query parameter is not supported.", "LongDescription": "This message shall indicate that a query parameter is not supported by this service.", "Message": "Query parameter '%1' is not supported.", "Example": "Query parameter 'InvalidParameter' is not supported.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.15.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The query parameter." ], "ArgLongDescriptions": [ "This argument shall contain the name of the query parameter." ], "Resolution": "Correct or remove the query parameter and resubmit the request." }, "SessionLimitExceeded": { "Description": "Indicates that a session establishment was requested but the operation failed due to the number of simultaneous sessions exceeding the limit of the implementation.", "LongDescription": "This message shall indicate that a session establishment was 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.", "Example": "The session establishment failed due to the number of simultaneous sessions exceeding the limit of the implementation.", "Severity": "Critical", "MessageSeverity": "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 an event subscription establishment was requested but the operation failed due to the number of simultaneous connections exceeding the limit of the implementation.", "LongDescription": "This message shall indicate that an event subscription establishment was requested but the operation failed due to the number of simultaneous connections exceeding the limit of the implementation.", "Message": "The event subscription failed due to the number of simultaneous subscriptions exceeding the limit of the implementation.", "Example": "The event subscription failed due to the number of simultaneous subscriptions exceeding the limit of the implementation.", "Severity": "Critical", "MessageSeverity": "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.", "LongDescription": "This message shall indicate 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.", "Example": "The delete request failed because the resource requested cannot be deleted.", "Severity": "Critical", "MessageSeverity": "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.", "LongDescription": "This message shall indicate 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.", "Example": "The change to the requested resource failed because the resource is in use or in transition.", "Severity": "Warning", "MessageSeverity": "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.", "LongDescription": "This message shall indicate that a resource change or creation was attempted but that the operation cannot proceed because the resource already exists.", "Message": "The requested resource of type '%1' with the property '%2' with the value '%3' already exists.", "Example": "The requested resource of type 'Drive' with the property 'PredictedMediaLifeLeftThreshold' with the value '20' already exists.", "Severity": "Critical", "MessageSeverity": "Critical", "NumberOfArgs": 3, "ParamTypes": [ "string", "string", "string" ], "ArgDescriptions": [ "The type of resource.", "The name of the property.", "The value of the property." ], "ArgLongDescriptions": [ "This argument shall contain the schema name of the resource.", "This argument shall contain the name of the property.", "This argument shall contain the value provided for the property. Numeric values shall be converted to a string, and null values shall be represented by the string `null`." ], "Resolution": "Do not repeat the create operation as the resource was already created." }, "ResourceNotFound": { "Description": "Indicates that the operation expected a resource identifier that corresponds to an existing resource but one was not found.", "LongDescription": "This message shall indicate that the operation expected a resource identifier that corresponds to an existing resource but one was not found.", "Message": "The requested resource of type '%1' named '%2' was not found.", "Example": "The requested resource of type 'Drive' named 'Drive1' was not found.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.2.0", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The type of resource.", "The `Id` of the resource." ], "ArgLongDescriptions": [ "This argument shall contain the schema name of the resource.", "This argument shall contain the value of the `Id` property of the requested resource." ], "Resolution": "Provide a valid resource identifier and resubmit the request." }, "PayloadTooLarge": { "Description": "Indicates that the supplied payload is too large to be accepted by the service.", "LongDescription": "This message shall indicate that the payload supplied exceeds the size supported by the service. For cases where the payload size is supported but there is insufficient available storage space, the message `InsufficientStorage` shall be used.", "Message": "The supplied payload exceeds the maximum size supported by the service.", "Example": "The supplied payload exceeds the maximum size supported by the service.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.13.0", "NumberOfArgs": 0, "Resolution": "Check that the supplied payload is correct and supported by this service." }, "InsufficientStorage": { "Description": "Indicates that the operation could not be completed due to a lack of storage or memory available to the service.", "LongDescription": "This message shall indicate that the request exceeds the storage or memory available to the service. For cases where the payload is larger than the maximum size supported, regardless of available storage, the message `PayloadTooLarge` shall be used.", "Message": "Insufficient storage or memory available to complete the request.", "Example": "Insufficient storage or memory available to complete the request.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.13.0", "NumberOfArgs": 0, "Resolution": "Increase the free storage space available to the service and resubmit the request." }, "MissingOrMalformedPart": { "Description": "Indicates that a multipart request is missing a required part or contains malformed parts.", "LongDescription": "This message shall indicate that the request payload supplied as part of an HTTP multipart request is missing one or more required parts or contains malformed parts.", "Message": "The multipart request contains malformed parts or is missing required parts.", "Example": "The multipart request contains malformed parts or is missing required parts.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.13.0", "NumberOfArgs": 0, "Resolution": "Add any missing required parts or correct the malformed parts and resubmit the request." }, "InvalidURI": { "Description": "Indicates that the operation encountered a URI that does not correspond to a valid resource.", "LongDescription": "This message shall indicate that the operation encountered a URI that does not correspond to a valid resource.", "Message": "The URI '%1' was not found.", "Example": "The URI '/redfish/v1/Systems/InvalidSystem' was not found.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.10.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The supplied URI." ], "ArgLongDescriptions": [ "This argument shall contain the invalid URI that was encountered." ], "Resolution": "Provide a valid URI and resubmit the request." }, "CreateFailedMissingReqProperties": { "Description": "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.", "LongDescription": "This message shall indicate that a create operation 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.", "Example": "The create operation failed because the required property 'Name' was missing from the request.", "Severity": "Critical", "MessageSeverity": "Critical", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The name of the required property." ], "ArgLongDescriptions": [ "This argument shall contain the name of the required property." ], "Deprecated": "This message was deprecated in favor of `PropertyMissing`.", "VersionDeprecated": "1.14.0", "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.", "LongDescription": "This message shall indicate 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.", "Example": "The create operation failed because the resource has reached the limit of possible resources.", "Severity": "Critical", "MessageSeverity": "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 because the service is shutting down, such as when the service reboots.", "LongDescription": "This message shall indicate that the operation failed because the service is shutting down.", "Message": "The operation failed because the service is shutting down and can no longer take incoming requests.", "Example": "The operation failed because the service is shutting down and can no longer take incoming requests.", "Severity": "Critical", "MessageSeverity": "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.", "LongDescription": "This message shall indicate 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.", "Example": "The operation failed because the service is in an unknown state and can no longer take incoming requests.", "Severity": "Critical", "MessageSeverity": "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.", "LongDescription": "This message shall indicate 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.", "Example": "There is no valid session established with the implementation.", "Severity": "Critical", "MessageSeverity": "Critical", "NumberOfArgs": 0, "Resolution": "Establish a 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.", "LongDescription": "This message shall indicate 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.", "Example": "There are insufficient privileges for the account or credentials associated with the current session to perform the requested operation.", "Severity": "Critical", "MessageSeverity": "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.", "LongDescription": "This message shall indicate that the account was successfully modified.", "Message": "The account was successfully modified.", "Example": "The account was successfully modified.", "Severity": "OK", "MessageSeverity": "OK", "NumberOfArgs": 0, "Resolution": "None." }, "AccountNotModified": { "Description": "Indicates that the modification requested for the account was not successful.", "LongDescription": "This message shall indicate that the modification requested for the account was not successful.", "Message": "The account modification request failed.", "Example": "The account modification request failed.", "Severity": "Warning", "MessageSeverity": "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.", "LongDescription": "This message shall indicate that the account was successfully removed.", "Message": "The account was successfully removed.", "Example": "The account was successfully removed.", "Severity": "OK", "MessageSeverity": "OK", "NumberOfArgs": 0, "Resolution": "None." }, "AccountForSessionNoLongerExists": { "Description": "Indicates that the account for the session was removed, and so the session was removed as well.", "LongDescription": "This message shall indicate that the account for the session was removed, and so the session was removed as well.", "Message": "The account for the current session was removed, and so the current session was removed as well.", "Example": "The account for the current session was removed, and so the current session was removed as well.", "Severity": "OK", "MessageSeverity": "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. An example is a firmware update malformed URI.", "LongDescription": "This message shall indicate that the object in question is invalid according to the implementation.", "Message": "The object at '%1' is invalid.", "Example": "The object at '/redfish/v1/Systems/InvalidSystem' is invalid.", "Severity": "Critical", "MessageSeverity": "Critical", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The URI provided." ], "ArgLongDescriptions": [ "This argument shall contain the URI provided for this operation." ], "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.", "LongDescription": "This message shall indicate 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.", "Example": "The request failed due to an internal service error. The service is still operational.", "Severity": "Critical", "MessageSeverity": "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.", "LongDescription": "This message shall indicate 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.", "Example": "The service detected a malformed request body that it was unable to interpret.", "Severity": "Warning", "MessageSeverity": "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 such as firmware updates.", "LongDescription": "This message shall indicate that the operation expected an image or other resource at the provided URI but none was found.", "Message": "The resource at the URI '%1' was not found.", "Example": "The resource at the URI '/redfish/v1/UpdateService/FirmwareInventory/1/Actions/FirmwareInventory.UpdateImage' was not found.", "Severity": "Critical", "MessageSeverity": "Critical", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The URI provided." ], "ArgLongDescriptions": [ "This argument shall contain the URI provided for this operation." ], "Resolution": "Place a valid resource at the 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.", "LongDescription": "This message shall indicate 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.", "Example": "The resource at '/redfish/v1/UpdateService/FirmwareInventory/1/Actions/FirmwareInventory.UpdateImage' is in a format not recognized by the service.", "Severity": "Critical", "MessageSeverity": "Critical", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The URI provided." ], "ArgLongDescriptions": [ "This argument shall contain the URI provided for this operation." ], "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, or image at the URI was unauthorized.", "LongDescription": "This message shall indicate that the attempt to access the resource, file, or image at the URI was unauthorized.", "Message": "While accessing the resource at '%1', the service received an authorization error '%2'.", "Example": "While accessing the resource at '/redfish/v1/UpdateService/FirmwareInventory/1/Actions/FirmwareInventory.UpdateImage', the service received an authorization error 'Unauthorized'.", "Severity": "Critical", "MessageSeverity": "Critical", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The URI provided.", "The error message received from the authorization service." ], "ArgLongDescriptions": [ "This argument shall contain the URI provided for this operation.", "This argument shall contain the error message received from the authorization service or software." ], "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, or image at the URI was unsuccessful because a session could not be established.", "LongDescription": "This message shall indicate that the attempt to access the resource, file, or 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'.", "Example": "The service failed to establish a connection with the URI '/redfish/v1/UpdateService/FirmwareInventory/1/Actions/FirmwareInventory.UpdateImage'.", "Severity": "Critical", "MessageSeverity": "Critical", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The URI provided." ], "ArgLongDescriptions": [ "This argument shall contain the URI provided for this operation." ], "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, or image from another location that the other end of the connection did not support the protocol.", "LongDescription": "This message shall indicate 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.", "Message": "The other end of the connection at '%1' does not support the specified protocol %2.", "Example": "The other end of the connection at '/redfish/v1/UpdateService/FirmwareInventory/1/Actions/FirmwareInventory.UpdateImage' does not support the specified protocol 'HTTPS'.", "Severity": "Critical", "MessageSeverity": "Critical", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The URI provided.", "The protocol specified." ], "ArgLongDescriptions": [ "This argument shall contain the URI provided for this operation.", "This argument shall contain the name of the protocol requested for this operation." ], "Resolution": "Change protocols or URIs." }, "AccessDenied": { "Description": "Indicates that while attempting to access, connect to, or transfer to or from another resource, the service denied access.", "LongDescription": "This message shall indicate that while attempting to access, connect to, or transfer to or from another resource, the service denied access.", "Message": "While attempting to establish a connection to '%1', the service denied access.", "Example": "While attempting to establish a connection to '/redfish/v1/UpdateService/FirmwareInventory/1/Actions/FirmwareInventory.UpdateImage', the service denied access.", "Severity": "Critical", "MessageSeverity": "Critical", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The URI provided." ], "ArgLongDescriptions": [ "This argument shall contain the URI provided for this operation." ], "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.", "LongDescription": "This message shall indicate that the service is temporarily unavailable.", "Message": "The service is temporarily unavailable. Retry in %1 seconds.", "Example": "The service is temporarily unavailable. Retry in 30 seconds.", "Severity": "Critical", "MessageSeverity": "Critical", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The retry duration in seconds." ], "ArgLongDescriptions": [ "This argument shall contain the number of seconds the client should wait before attempting the operation again." ], "Resolution": "Wait for the indicated retry duration and retry the operation." }, "InvalidIndex": { "Description": "The index is not valid.", "LongDescription": "This message shall indicate that the index is not valid.", "Message": "The index %1 is not a valid offset into the array.", "Example": "The index -5 is not a valid offset into the array.", "Severity": "Warning", "MessageSeverity": "Warning", "NumberOfArgs": 1, "ParamTypes": [ "number" ], "ArgDescriptions": [ "The array index." ], "ArgLongDescriptions": [ "This argument shall contain the array index value provided." ], "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.", "LongDescription": "This message shall indicate that a property was given the correct value type but the value of that property was modified.", "Message": "The property '%1' was assigned the value '%2' due to modification by the service.", "Example": "The property 'Temperature' was assigned the value '20' due to modification by the service.", "Severity": "Warning", "MessageSeverity": "Warning", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The name of the property.", "The value assigned for property." ], "ArgLongDescriptions": [ "This argument shall contain the name of the property.", "This argument shall contain the value assigned for property." ], "Resolution": "None." }, "ResourceInStandby": { "Description": "Indicates that the request could not be performed because the resource is in standby.", "LongDescription": "This message shall indicate that the request could not be performed because the resource is in standby.", "Message": "The request could not be performed because the resource is in standby.", "Example": "The request could not be performed because the resource is in standby.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.1.0", "NumberOfArgs": 0, "Resolution": "Ensure that the resource is in the correct power state and resubmit the request." }, "ResourceExhaustion": { "Description": "Indicates that a resource could not satisfy the request due to some unavailability of resources. An example is that available capacity was allocated.", "LongDescription": "This message shall indicate that a resource could not satisfy the request due to some unavailability of resources.", "Message": "The resource '%1' was unable to satisfy the request due to unavailability of resources.", "Example": "The resource at '/redfish/v1/UpdateService/FirmwareInventory/1' was unable to satisfy the request due to unavailability of resources.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.2.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The URI of the resource." ], "ArgLongDescriptions": [ "This argument shall contain the URI of the relevant resource." ], "Resolution": "Ensure that the resources are available and resubmit the request." }, "StringValueTooLong": { "Description": "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.", "LongDescription": "This message shall indicate that a string value passed to the given resource was longer than the maximum allowed length.", "Message": "The string '%1' exceeds the length limit %2.", "Example": "The string 'This is a very long string' exceeds the length limit 10.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.2.0", "NumberOfArgs": 2, "ParamTypes": [ "string", "number" ], "ArgDescriptions": [ "The string provided.", "The maximum string length." ], "ArgLongDescriptions": [ "This argument shall contain the string value provided for this operation.", "This argument shall contain the maximum supported string length for this property." ], "Resolution": "Resubmit the request with an appropriate string length." }, "StringValueTooShort": { "Description": "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. This message also applies to cases of empty strings where the minimum string length is 1.", "LongDescription": "This message shall indicate that a string value passed to the given resource was shorter than the minimum required length.", "Message": "The string '%1' was under the minimum required length %2.", "Example": "The string 'Too short' was under the minimum required length 16.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.16.0", "NumberOfArgs": 2, "ParamTypes": [ "string", "number" ], "ArgDescriptions": [ "The string provided.", "The minimum string length." ], "ArgLongDescriptions": [ "This argument shall contain the string value provided for this operation.", "This argument shall contain the minimum supported string length for this property." ], "Resolution": "Resubmit the request with an appropriate string length." }, "SessionTerminated": { "Description": "Indicates that the `DELETE` operation on the session resource resulted in the successful termination of the session.", "LongDescription": "This message shall indicate that the `DELETE` operation on the session resource resulted in the successful termination of the session.", "Message": "The session was successfully terminated.", "Example": "The session was successfully terminated.", "Severity": "OK", "MessageSeverity": "OK", "VersionAdded": "1.3.0", "NumberOfArgs": 0, "Resolution": "None." }, "SubscriptionTerminated": { "Description": "An event subscription was terminated by the service. No further events will be delivered.", "LongDescription": "This message shall indicate that an event subscription was terminated by the service.", "Message": "The event subscription was terminated.", "Example": "The event subscription was terminated.", "Severity": "OK", "MessageSeverity": "OK", "VersionAdded": "1.5.0", "NumberOfArgs": 0, "Resolution": "None." }, "ResourceTypeIncompatible": { "Description": "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.", "LongDescription": "This message shall indicate that the resource type of the operation does not match that of the operation destination.", "Message": "The @odata.type of the request body '%1' is incompatible with the @odata.type of the resource, which is '%2'.", "Example": "The @odata.type of the request body '#ManagerAccount.v1_3_0.ManagerAccount' is incompatible with the @odata.type of the resource, which is '#ManagerAccount.v1_2_0.ManagerAccount'.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.2.0", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The `@odata.type` of the request.", "The supported `@odata.type` value." ], "ArgLongDescriptions": [ "This argument shall contain the value of the `@odata.type` property provided in the request.", "This argument shall contain the value of the `@odata.type` property supported by the resource." ], "Resolution": "Resubmit the request with a payload compatible with the resource's schema." }, "PasswordChangeRequired": { "Description": "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.", "LongDescription": "This message shall indicate 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.", "Message": "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.", "Example": "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 '/redfish/v1/Managers/1/Accounts/1' to complete this process.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.5.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The URI of the target resource." ], "ArgLongDescriptions": [ "This argument shall contain the URI of the target manager account resource instance." ], "Resolution": "Change the password for this account using a PATCH to the Password property at the URI provided." }, "PasswordIncorrectLength": { "Description": "Indicates that the password for the account provided does not meet the password length requirements of the service. The password for the account was not changed.", "LongDescription": "This message shall indicate that the password for the account provided does not meet the length requirements of the service. The length of the supplied password is either too short or too long.", "Message": "The password provided for this account does not meet the password length requirements of the service.", "Example": "The password provided for this account does not meet the password length requirements of the service.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.21.0", "NumberOfArgs": 0, "Resolution": "Resubmit the request with a password that meets the password length requirements as specified by the `MinPasswordLength` and `MaxPasswordLength` properties in the `AccountService` resource." }, "PasswordReuseTooRecent": { "Description": "Indicates that the password for the account provided does not meet the password reuse requirements of the service. The password for the account was not changed.", "LongDescription": "This message shall indicate that the password for the account provided does not meet the password reuse requirements of the service. The supplied password was used too recently.", "Message": "The password provided for this account does not meet the password reuse requirements of the service.", "Example": "The password provided for this account does not meet the password reuse requirements of the service.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.21.0", "NumberOfArgs": 0, "Resolution": "Resubmit the request with a password that meets the password reuse requirements specified by the `EnforcePasswordHistoryCount` property in the `AccountService` resource." }, "PasswordComplexityNotMet": { "Description": "Indicates that the password for the account provided does not meet the password complexity requirements of the service. The password for the account was not changed.", "LongDescription": "This message shall indicate that the password for the account provided does not meet the password complexity requirements of the service.", "Message": "The password provided for this account does not meet the password complexity requirements of the service.", "Example": "The password provided for this account does not meet the password complexity requirements of the service.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.21.0", "NumberOfArgs": 0, "Resolution": "Resubmit the request with a password that meets the password complexity requirements as specified by the `PasswordGuidanceMessage` property in the `AccountService` resource." }, "ResetRequired": { "Description": "Indicates that a component reset is required for changes, error recovery, or operations to complete.", "LongDescription": "This message shall indicate that a component reset is required for changes, error recovery, or operations to complete.", "Message": "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'.", "Example": "In order to apply changes, recover from errors, or complete the operation, a component reset is required with the Reset action URI '/redfish/v1/Systems/1/Actions/ComputerSystem.Reset' and ResetType 'ForceRestart'.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.6.0", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The URI for the reset action of the component that requires a reset.", "The `ResetType` required in a reset action on the component URI." ], "ArgLongDescriptions": [ "This argument shall contain the URI for the reset action that is required to be invoked for changes, error recovery or operations to complete.", "This argument shall contain the `ResetType` required in a reset action on the component URI for changes, error recovery or operations to complete. A reset action `POST` shall contain this `ResetType` parameter." ], "Resolution": "Perform the required reset action on the specified component." }, "ResetRecommended": { "Description": "Indicates that a component reset is recommended for error recovery while unaffected applications can continue running without any effect on accuracy and performance.", "LongDescription": "This message shall indicate that a component reset is recommended for error recovery while unaffected applications can continue running without any effect on accuracy and performance.", "Message": "In order to recover from errors, a component reset is recommended with the Reset action URI '%1' and ResetType '%2'.", "Example": "In order to recover from errors, a component reset is recommended with the Reset action URI '/redfish/v1/Systems/1/Actions/ComputerSystem.Reset' and ResetType 'ForceRestart'.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.12.0", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The URI for the reset action of the component that recommends a reset.", "The `ResetType` required in a reset action on the component URI." ], "ArgLongDescriptions": [ "This argument shall contain the URI for the reset action that is recommended to be invoked for error recovery.", "This argument shall contain the `ResetType` required in a reset action on the component URI for error recovery while unaffected applications can continue running without any effect on accuracy and performance. A reset action `POST` shall contain this `ResetType` parameter." ], "Resolution": "Perform the recommended reset action on the specified component." }, "ChassisPowerStateOnRequired": { "Description": "Indicates that the request requires a specified chassis to be powered on.", "LongDescription": "This message shall indicate that the request requires the specified `Chassis` resource to be powered on as indicated by its `PowerState` property.", "Message": "The chassis with Id '%1' is required to be powered on to perform this request.", "Example": "The chassis with Id 'Chassis1' is required to be powered on to perform this request.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.6.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The Id of the chassis that is required to be powered on." ], "ArgLongDescriptions": [ "This argument shall contain the value of the `Id` property of the `Chassis` resource that is required to be powered on." ], "Resolution": "Power on the specified chassis and resubmit the request." }, "ChassisPowerStateOffRequired": { "Description": "Indicates that the request requires a specified chassis to be powered off.", "LongDescription": "This message shall indicate that the request requires the specified `Chassis` resource to be powered off as indicated by its `PowerState` property.", "Message": "The chassis with Id '%1' is required to be powered off to perform this request.", "Example": "The chassis with Id 'Chassis1' is required to be powered off to perform this request.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.6.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The `Id` of the chassis that is required to be powered off." ], "ArgLongDescriptions": [ "This argument shall contain the value of the `Id` property of the `Chassis` resource that is required to be powered off." ], "Resolution": "Power off the specified chassis and resubmit the request." }, "PropertyValueConflict": { "Description": "Indicates that the requested write of a property value could not be completed because of a conflict with another property value.", "LongDescription": "This message shall indicate that the requested write of a property could not be completed because of a conflict with the value of another property.", "Message": "The property '%1' could not be written because its value would conflict with the value of the '%2' property.", "Example": "The property 'BootSourceOverrideTarget' could not be written because its value would conflict with the value of the 'BootSourceOverrideEnabled' property.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.6.0", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The name of the property for which a write was requested.", "The name of the property with which there is a conflict." ], "ArgLongDescriptions": [ "This argument shall contain the name of the property for which a write was requested.", "This argument shall contain the name of the property with which there is a conflict." ], "Resolution": "None." }, "PropertyValueResourceConflict": { "Description": "Indicates that the requested write of a property value could not be completed due to the current state or configuration of another resource.", "LongDescription": "This message shall indicate that the requested write of a property could not be completed because the requested value of the property, which is a value supported by the implementation, cannot be accepted due to conflicts in the state or configuration of another resource.", "Message": "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'.", "Example": "The property 'BootSourceOverrideTarget' with the requested value of 'Pxe' could not be written because the value conflicts with the state or configuration of the resource at '/redfish/v1/Systems/1'.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.10.0", "NumberOfArgs": 3, "ParamTypes": [ "string", "string", "string" ], "ArgDescriptions": [ "The name of the property for which a write was requested.", "The value of the property that is in conflict.", "The URI of the resource in conflict." ], "ArgLongDescriptions": [ "This argument shall contain the name of the property for which a write was requested.", "This argument shall contain the value of the property that is in conflict.", "This argument shall contain the URI of the resource that is in conflict with the value of the requested property." ], "Resolution": "None." }, "PropertyValueExternalConflict": { "Description": "Indicates that the requested write of a property value could not be completed due to conflicts with other configurations in the service managed with non-Redfish interfaces.", "LongDescription": "This message shall indicate that the requested write of a property could not be completed because the requested value of the property, which is a value supported by the implementation, cannot be accepted due to conflicts with other configurations in the service managed with non-Redfish interfaces.", "Message": "The property '%1' with the requested value of '%2' could not be written because the value is not available due to a configuration conflict.", "Example": "The property 'BootSourceOverrideTarget' with the requested value of 'Pxe' could not be written because the value is not available due to a configuration conflict.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.10.0", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The name of the property for which a write was requested.", "The value of the property that is in conflict." ], "ArgLongDescriptions": [ "This argument shall contain the name of the property for which a write was requested.", "This argument shall contain the value of the property that is in conflict." ], "Resolution": "None." }, "PropertyValueIncorrect": { "Description": "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, passwords that do not match the implementation constraints, or specifying an invalid URI in a reference property.", "LongDescription": "This message shall indicate that the requested write of a property could not be completed because of an incorrect value for the property.", "Message": "The property '%1' with the requested value of '%2' could not be written because the value is not acceptable for the property.", "Example": "The property 'UserName' with the requested value of 'Admin!' could not be written because the value is not acceptable for the property.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.7.0", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "Name of the property for which a write was requested.", "Value of the property that is incorrect." ], "ArgLongDescriptions": [ "This argument shall contain the name of the property for which a write was requested.", "This argument shall contain the value of the property that is incorrect." ], "Resolution": "None." }, "ResourceCreationConflict": { "Description": "Indicates that the requested resource creation could not be completed because the service has a resource that conflicts with the request.", "LongDescription": "This message shall indicate that the requested creation of a resource could not be completed because the service has a resource that conflicts with the request, such as when the resource already exists or an existing resource has similar property values.", "Message": "The resource could not be created. The service has a resource at URI '%1' that conflicts with the creation request.", "Example": "The resource could not be created. The service has a resource at URI '/redfish/v1/Systems/1' that conflicts with the creation request.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.7.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "URI of the resource that conflicts with the creation request." ], "ArgLongDescriptions": [ "This argument shall contain the URI of the resource with which there is a conflict." ], "Resolution": "None." }, "ActionParameterValueConflict": { "Description": "Indicates that the requested parameter value could not be completed because of a mismatch with other parameters or properties in the resource.", "LongDescription": "This message shall indicate that the requested parameter value could not be completed because of a mismatch with other parameters or properties in the resource.", "Message": "The parameter '%1' with the requested value of '%2' does not meet the constraints of the implementation.", "Example": "The parameter 'ResetType' with the requested value of 'ForceRestart' does not meet the constraints of the implementation.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.12.0", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The name of the parameter for which a write was requested.", "The value of the parameter with which there is a conflict." ], "ArgLongDescriptions": [ "This argument shall contain the name of the parameter provided in the action request.", "This argument shall contain the value of the parameter with which there is a conflict." ], "Resolution": "None." }, "MaximumErrorsExceeded": { "Description": "Indicates that so many errors have occurred that the reporting service cannot return them all.", "LongDescription": "The maximum number of errors that the implementation can report was exceeded. This shall not be the only message reported by the service. The use of this message should be limited to RDE implementations.", "Message": "Too many errors have occurred to report them all.", "Example": "Too many errors have occurred to report them all.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.8.0", "NumberOfArgs": 0, "Resolution": "Resolve other reported errors and retry the current operation." }, "PreconditionFailed": { "Description": "Indicates that the ETag supplied did not match the current ETag of the resource.", "LongDescription": "Indicates that the ETag supplied either in the header or using that `@odata.etag` annotation in the resource did not match the one expected by the service and so the operation on this resource failed. The use of this message shall only be used in responses for deep operations, since HTTP status code 412 is typically used for this.", "Message": "The ETag supplied did not match the ETag required to change this resource.", "Example": "The ETag supplied did not match the ETag required to change this resource.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.8.0", "NumberOfArgs": 0, "Resolution": "Try the operation again using the appropriate ETag." }, "PreconditionRequired": { "Description": "Indicates that the request did not provide the required precondition such as an `If-Match` or `If-None-Match` header or `@odata.etag` annotations.", "LongDescription": "Indicates that the request did not provide the required precondition such as an `If-Match` or `If-None-Match` header or `@odata.etag` annotations. The use of this message shall only be used in responses for deep operations, since HTTP status code 428 is typically used for this.", "Message": "A precondition header or annotation is required to change this resource.", "Example": "A precondition header or annotation is required to change this resource.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.8.0", "NumberOfArgs": 0, "Resolution": "Try the operation again using an If-Match or If-None-Match header and appropriate ETag." }, "HeaderMissing": { "Description": "Indicates that a required request header is missing.", "LongDescription": "This message shall indicate that a required request header is missing in the request.", "Message": "Required header '%1' is missing in the request.", "Example": "Required header 'X-Auth-Token' is missing in the request.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.13.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The missing required request header." ], "ArgLongDescriptions": [ "This argument shall contain the missing required request header." ], "Resolution": "Resubmit the request with the required request header." }, "HeaderInvalid": { "Description": "Indicates that a request header is invalid.", "LongDescription": "This message shall indicate that a request header is known but is invalid.", "Message": "Header '%1' is invalid.", "Example": "Header 'X-Auth-Token' is invalid.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.13.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The request header." ], "ArgLongDescriptions": [ "This argument shall contain the full request header, including the field name and field value." ], "Resolution": "Resubmit the request with a valid request header." }, "OperationFailed": { "Description": "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.", "LongDescription": "This message shall indicate that one of the internal operations necessary to complete the request failed. Partial results of the client operation may be returned.", "Message": "An error occurred internal to the service as part of the overall request. Partial results may have been returned.", "Example": "An error occurred internal to the service as part of the overall request. Partial results may have been returned.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.8.0", "NumberOfArgs": 0, "Resolution": "Resubmit the request. If the problem persists, consider resetting the service or provider." }, "OperationTimeout": { "Description": "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.", "LongDescription": "This message shall indicate that one of the internal operations necessary to complete the request timed out. Partial results of the client operation may be returned.", "Message": "A timeout internal to the service occurred as part of the request. Partial results may have been returned.", "Example": "A timeout internal to the service occurred as part of the request. Partial results may have been returned.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.8.0", "NumberOfArgs": 0, "Resolution": "Resubmit the request. If the problem persists, consider resetting the service or provider." }, "OperationNotAllowed": { "Description": "Indicates that the HTTP method in the request is not allowed on this resource.", "LongDescription": "This message shall indicate that the HTTP method in the request is not allowed on this resource. This error message should be used together with HTTP status code 405 Method Not Allowed.", "Message": "The HTTP method is not allowed on this resource.", "Example": "The HTTP method is not allowed on this resource.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.13.0", "NumberOfArgs": 0, "Resolution": "None." }, "UndeterminedFault": { "Description": "Indicates that a fault or error condition exists but the source of the fault cannot be determined or is unknown to the service.", "LongDescription": "This message shall indicate that a fault or error condition was reported to the service, but the source of the fault cannot be determined or is unknown to the service.", "Message": "An undetermined fault condition was reported by '%1'.", "Example": "An undetermined fault condition was reported by 'Service1'.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.9.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The software, provider, or service that reported the fault condition." ], "ArgLongDescriptions": [ "This argument shall contain the name of the entity that reported the fault condition." ], "Resolution": "None." }, "ConditionInRelatedResource": { "Description": "Indicates that one or more fault or error conditions exist in a related resource.", "LongDescription": "This message shall indicate that one or more conditions that require attention exist in a resource that affects the Health or HealthRollup of this resource. This message can be used in place of multiple messages in a `Conditions` property to roll up conditions from a single resource. The resource can be located using the `OriginOfCondition` property. The value of the `MessageSeverity` property should match the highest severity of any conditions in the resource referenced by the `OriginOfCondition` property.", "Message": "One or more conditions exist in a related resource. See the OriginOfCondition property.", "Example": "One or more conditions exist in a related resource. See the OriginOfCondition property.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.9.0", "NumberOfArgs": 0, "Resolution": "Check the Conditions array in the resource shown in the OriginOfCondition property to determine the conditions that need attention." }, "RestrictedRole": { "Description": "Indicates that the operation was not successful because the role is restricted.", "LongDescription": "This message shall indicate that the operation was not successful because the role is restricted.", "Message": "The operation was not successful because the role '%1' is restricted.", "Example": "The operation was not successful because the role 'ReadOnly' is restricted.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.9.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The name of the restricted role." ], "ArgLongDescriptions": [ "This argument shall contain the name of the restricted role." ], "Resolution": "No resolution is required. For standard roles, consider using the role specified in the AlternateRoleId property in the Role resource." }, "RestrictedPrivilege": { "Description": "Indicates that the operation was not successful because a privilege is restricted.", "LongDescription": "This message shall indicate that the operation was not successful because a privilege is restricted.", "Message": "The operation was not successful because the privilege '%1' is restricted.", "Example": "The operation was not successful because the privilege 'Login' is restricted.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.9.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The name of the restricted privilege." ], "ArgLongDescriptions": [ "This argument shall contain the name of the restricted privilege." ], "Resolution": "Remove restricted privileges from the request body and resubmit the request." }, "StrictAccountTypes": { "Description": "Indicates the request failed because a set of `AccountTypes` or `OEMAccountTypes` was not accepted while `StrictAccountTypes` is set to `true`.", "LongDescription": "This message shall indicate that the request failed because a set of `AccountTypes` or `OEMAccountTypes` was not accepted while `StrictAccountTypes` is set to `true`.", "Message": "The request could not be fulfilled with the account types included in property '%1' because the property StrictAccountTypes is set to true.", "Example": "The request could not be fulfilled with the account types included in property 'AccountTypes' because the property StrictAccountTypes is set to true.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.9.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The name of the property." ], "ArgLongDescriptions": [ "This argument shall contain the name of the property `AccountTypes` or `OEMAccountTypes`." ], "Resolution": "Resubmit the request either with an acceptable set of AccountTypes and OEMAccountTypes or with StrictAccountTypes set to false." }, "PropertyDeprecated": { "Description": "Indicates the property is deprecated.", "LongDescription": "This message shall indicate that the property is deprecated.", "Message": "The deprecated property '%1' was included in the request body.", "Example": "The deprecated property 'OldProperty' was included in the request body.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.10.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The name of the property." ], "ArgLongDescriptions": [ "This argument shall contain the name of the property that is deprecated." ], "Resolution": "Refer to the schema guide for more information." }, "ResourceDeprecated": { "Description": "Indicates the resource is deprecated.", "LongDescription": "This message shall indicate that the resource is deprecated.", "Message": "The operation was performed on a deprecated resource '%1'.", "Example": "The operation was performed on a deprecated resource '/redfish/v1/OldResource'.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.10.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The URI of the resource." ], "ArgLongDescriptions": [ "This argument shall contain the URI of the resource that is deprecated." ], "Resolution": "Refer to the schema guide for more information." }, "PropertyValueDeprecated": { "Description": "Indicates that a property was given a deprecated value.", "LongDescription": "This message shall indicate that a property was given a deprecated value.", "Message": "The value '%1' for the property %2 is deprecated.", "Example": "The value 'OldValue' for the property 'OldProperty' is deprecated.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.10.0", "NumberOfArgs": 2, "ParamTypes": [ "string", "string" ], "ArgDescriptions": [ "The value provided for the property.", "The name of the property." ], "ArgLongDescriptions": [ "This argument shall contain the deprecated value provided for the property.", "This argument shall contain the name of the property." ], "Resolution": "Refer to the schema guide for more information." }, "ActionDeprecated": { "Description": "Indicates the action is deprecated.", "LongDescription": "This message shall indicate that the action is deprecated.", "Message": "The action '%1' is deprecated.", "Example": "The action 'OldAction' is deprecated.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.10.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The name of the action." ], "ArgLongDescriptions": [ "This argument shall contain the name of the action that is deprecated." ], "Resolution": "Refer to the schema guide for more information." }, "NetworkNameResolutionNotConfigured": { "Description": "Indicates that network-based name resolution is not configured on the service.", "LongDescription": "This message shall indicate that network-based name resolution, such as DNS or WINS protocols, is not configured on the service.", "Message": "Network name resolution is not configured on this service.", "Example": "Network name resolution is not configured on this service.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.11.0", "NumberOfArgs": 0, "Resolution": "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." }, "NetworkNameResolutionNotSupported": { "Description": "Indicates the service does not support network-based name resolution.", "LongDescription": "This message shall indicate that the service does not support network-based name resolution, such as DNS or WINS protocols. URIs provided as property values must contain an IP address as the service cannot resolve a network name.", "Message": "Resolution of network-based names is not supported by this service.", "Example": "Resolution of network-based names is not supported by this service.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.11.0", "NumberOfArgs": 0, "Resolution": "Update any URI values to include an IP address instead of a network name and resubmit the request." }, "ServiceDisabled": { "Description": "Indicates that the operation failed because the service, such as the account service, is disabled and cannot accept requests.", "LongDescription": "This message shall indicate that the operation failed because the service, such as the account service, is disabled and cannot accept requests.", "Message": "The operation failed because the service at '%1' is disabled and cannot accept requests.", "Example": "The operation failed because the service at '/redfish/v1/AccountService' is disabled and cannot accept requests.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.11.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The URI of the disabled service." ], "ArgLongDescriptions": [ "This argument shall contain the URI of the disabled service." ], "Resolution": "Enable the service and resubmit the request if the operation failed." }, "EventBufferExceeded": { "Description": "Indicates undelivered events may have been lost due to a lack of buffer space in the service.", "LongDescription": "This message shall indicate that event buffer space used by the service has been exceeded, and as a result one or more undelivered events may have been lost.", "Message": "Undelivered events may have been lost due to exceeding the event buffer.", "Example": "Undelivered events may have been lost due to exceeding the event buffer.", "Severity": "Warning", "MessageSeverity": "Warning", "VersionAdded": "1.13.0", "NumberOfArgs": 0, "Resolution": "None." }, "AuthenticationTokenRequired": { "Description": "Indicates that the request could not be performed because an authentication token was not provided.", "LongDescription": "This message shall indicate that the request could not be performed because the user provided in the request requires multifactor authentication and an authentication token was not provided.", "Message": "The request could not be performed because an authentication token was not provided.", "Example": "The request could not be performed because an authentication token was not provided.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.15.0", "NumberOfArgs": 0, "Resolution": "Obtain an authentication token and resubmit the request." }, "OneTimePasscodeSent": { "Description": "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.", "LongDescription": "This message shall indicate that a one-time passcode was generated by the service as the result of a request to create a session. The one-time passcode shall be sent to the delivery address associated with account credentials supplied in the request.", "Message": "A one-time passcode was sent to: '%1'. Supply the passcode as the `Token` property in the request to create a session.", "Example": "A one-time passcode was sent to: 'joe@contoso.com'. Supply the passcode as the `Token` property in the request to create a session.", "Severity": "OK", "MessageSeverity": "OK", "VersionAdded": "1.17.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The delivery address for the one-time passcode. The address is at least partially redacted." ], "ArgLongDescriptions": [ "This argument shall contain the delivery address for the one-time passcode. The value shall be partially or fully redacted to prevent receipt by unauthorized clients." ], "Resolution": "Obtain the one-time passcode sent to the delivery address and resubmit the request using the passcode as the `Token` property." }, "LicenseRequired": { "Description": "Indicates that a license is required to perform the requested operation.", "LongDescription": "This message shall indicate that that a license is required to perform the requested operation.", "Message": "A license is required for this operation: '%1'.", "Example": "A license is required for this operation: 'AdvancedPowerManagement'.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.16.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The vendor description of the license required to perform the operation." ], "ArgLongDescriptions": [ "This argument shall contain the vendor description of the license required to perform the operation." ], "Resolution": "Install the requested license and resubmit the request." }, "PropertyModified": { "Description": "Indicates that all properties listed in `RelatedProperties` in the message were successfully modified.", "LongDescription": "This message shall indicate that the properties listed in RelatedProperties were successfully modified.", "Message": "One or more properties were successfully modified.", "Example": "One or more properties were successfully modified.", "Severity": "OK", "MessageSeverity": "OK", "VersionAdded": "1.19.0", "NumberOfArgs": 0, "Resolution": "None." }, "GenerateSecretKeyRequired": { "Description": "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.", "LongDescription": "This message shall indicate that the RFC6238-defined 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.", "Message": "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.", "Example": "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 '/redfish/v1/AccountService/Accounts/1/GenerateSecretKey' and retain the secret key from the response.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.19.0", "NumberOfArgs": 1, "ParamTypes": [ "string" ], "ArgDescriptions": [ "The URI for the `GenerateSecretKey` action of the account that requires a new Time-based One-Time Password (TOTP) secret key." ], "ArgLongDescriptions": [ "This argument shall contain the URI for the `GenerateSecretKey` action of the account that requires a new RFC6238-defined Time-based One-Time Password (TOTP) secret key." ], "Resolution": "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." }, "AccessUnauthorized": { "Description": "Indicates that the request did not contain valid credentials.", "LongDescription": "This message shall indicate that the request did not contain valid credentials, such as those found in the `Authorization` and `X-Auth-Token` HTTP request headers.", "Message": "Unauthorized.", "Example": "Unauthorized.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.20.0", "NumberOfArgs": 0, "Resolution": "Resubmit the request with valid credentials." }, "AccessForbidden": { "Description": "Indicates that the request contained valid credentials, but the user does not have the necessary privileges to perform the requested operation.", "LongDescription": "This message shall indicate that the request contained valid credentials, but the user does not have the necessary privileges to perform the requested operation.", "Message": "Forbidden.", "Example": "Forbidden.", "Severity": "Critical", "MessageSeverity": "Critical", "VersionAdded": "1.20.0", "NumberOfArgs": 0, "Deprecated": "This message was deprecated in favor of the existing `InsufficientPrivilege` message.", "VersionDeprecated": "1.22.0", "Resolution": "Resubmit the request with credentials that contain the necessary privileges to perform the requested operation." } } }