pub enum Base {
Show 110 variants
PropertyNotUpdated(String),
SessionLimitExceeded,
SourceDoesNotSupportProtocol(String, String),
Success,
NetworkNameResolutionNotConfigured,
QueryParameterValueTypeError(String, String),
ResourceDeprecated(String),
ResourceAtUriUnauthorized(String, String),
PropertyValueFormatError(String, String),
PropertyValueConflict(String, String),
HeaderInvalid(String),
ServiceInUnknownState,
ResourceMissingAtURI(String),
ServiceDisabled(String),
ResourceNotFound(String, String),
PreconditionRequired,
QueryNotSupportedOnOperation,
CreateLimitReachedForResource,
PropertyValueNotInList(String, String),
PropertyValueModified(String, String),
NetworkNameResolutionNotSupported,
EventBufferExceeded,
InternalError,
NoValidSession,
InsufficientStorage,
ResourceInStandby,
ActionParameterValueTypeError(String, String, String),
StrictAccountTypes(String),
CreateFailedMissingReqProperties(String),
AccountNotModified,
Created,
AccountForSessionNoLongerExists,
OperationTimeout,
ActionDeprecated(String),
ResourceInUse,
EmptyJSON,
QueryNotSupported,
ChassisPowerStateOnRequired(String),
PayloadTooLarge,
CouldNotEstablishConnection(String),
PropertyValueOutOfRange(String, String),
UndeterminedFault(String),
MaximumErrorsExceeded,
LicenseRequired(String),
AccessDenied(String),
MalformedJSON,
PropertyValueDeprecated(String, String),
OperationFailed,
InsufficientPrivilege,
ActionParameterValueConflict(String, String),
PreconditionFailed,
ChassisPowerStateOffRequired(String),
HeaderMissing(String),
PropertyMissing(String),
QueryParameterValueError(String),
UnrecognizedRequestBody,
ResourceCreationConflict(String),
ActionParameterValueError(String, String),
ArraySizeTooShort(String, f64),
InvalidObject(String),
ActionParameterUnknown(String, String),
QueryCombinationInvalid,
ActionNotSupported(String),
SessionTerminated,
NoOperation,
ResetRecommended(String, String),
AccountModified,
ResourceAlreadyExists(String, String, String),
MissingOrMalformedPart,
InvalidJSON(f64),
ActionParameterDuplicate(String, String),
QueryParameterUnsupported(String),
InvalidURI(String),
AccountRemoved,
QueryNotSupportedOnResource,
ServiceShuttingDown,
ResourceExhaustion(String),
SubscriptionTerminated,
ArraySizeTooLong(String, f64),
ResourceCannotBeDeleted,
InvalidIndex(f64),
RestrictedRole(String),
QueryParameterOutOfRange(String, String, String),
ActionParameterValueNotInList(String, String, String),
RestrictedPrivilege(String),
ResourceTypeIncompatible(String, String),
ResetRequired(String, String),
PropertyValueIncorrect(String, String),
ActionParameterMissing(String, String),
ResourceAtUriInUnknownFormat(String),
PropertyValueExternalConflict(String, String),
PropertyUnknown(String),
ActionParameterValueFormatError(String, String, String),
ActionParameterNotSupported(String, String),
StringValueTooLong(String, f64),
PropertyValueResourceConflict(String, String, String),
PropertyNotWritable(String),
AuthenticationTokenRequired,
ServiceTemporarilyUnavailable(String),
ConditionInRelatedResource,
PropertyDeprecated(String),
PropertyDuplicate(String),
PasswordChangeRequired(String),
PropertyValueError(String),
QueryParameterValueFormatError(String, String),
EventSubscriptionLimitExceeded,
OperationNotAllowed,
GeneralError,
PropertyValueTypeError(String, String),
StringValueTooShort(String, f64),
}
Expand description
This registry defines the base messages for Redfish
Variants§
PropertyNotUpdated(String)
This message shall be used to indicate that a property was not updated due to an internal service error, but the service is still functional.
SessionLimitExceeded
This message shall be used to indicate that a session establishment has been requested but the operation failed due to the number of simultaneous sessions exceeding the limit of the implementation.
SourceDoesNotSupportProtocol(String, String)
This message shall be used to 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.
Tuple Fields
Success
This message shall be used to indicate that all conditions of a successful operation have been met.
NetworkNameResolutionNotConfigured
This message shall be used to indicate that network-based name resolution, such as DNS or WINS protocols, has not been configured on the service.
QueryParameterValueTypeError(String, String)
This message shall be used to 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.
Tuple Fields
ResourceDeprecated(String)
This message shall be used to indicate that the resource is deprecated.
This message shall be used to indicate that the attempt to access the resource, file, or image at the URI was unauthorized.
Tuple Fields
This argument shall contain the URI provided for this operation.
This argument shall contain the error message received from the authorization service or software.
PropertyValueFormatError(String, String)
This message shall be used to indicate that a property was given the correct value type but the value of that property was not supported.
Tuple Fields
PropertyValueConflict(String, String)
This message shall be used to indicate that the requested write of a property could not be completed, because of a conflict with the value of another property.
Tuple Fields
HeaderInvalid(String)
This message shall be used to indicate that a request header is known, but is invalid.
Tuple Fields
ServiceInUnknownState
This message shall be used to indicate that the operation failed because the service is in an unknown state and cannot accept additional requests.
ResourceMissingAtURI(String)
This message shall be used to indicate that the operation expected an image or other resource at the provided URI but none was found.
ServiceDisabled(String)
This message shall be used to indicate that the operation failed because the service, such as the account service, is disabled and cannot accept requests.
ResourceNotFound(String, String)
This message shall be used to indicate that the operation expected a resource identifier that corresponds to an existing resource but one was not found.
Tuple Fields
PreconditionRequired
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.
QueryNotSupportedOnOperation
This message shall be used to indicate that query is not supported with the given operation.
CreateLimitReachedForResource
This message shall be used to indicate that no more resources can be created on the resource as it has reached its create limit.
PropertyValueNotInList(String, String)
This message shall be used to indicate that a property was given the correct value type but the value of that property was not supported.
Tuple Fields
PropertyValueModified(String, String)
This message shall be used to indicate that a property was given the correct value type but the value of that property was modified.
Tuple Fields
NetworkNameResolutionNotSupported
This message shall be used to 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.
EventBufferExceeded
This message shall be used to 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.
InternalError
This message shall be used to indicate that the request failed for an unknown internal error but that the service is still operational.
NoValidSession
This message shall be used to indicate that the operation failed because a valid session is required in order to access any resources.
InsufficientStorage
This message shall be used to indicate that the request exceeds the storage or memory available to the serivce. For cases where the payload is larger than the maximum size supported, regardless of available storage, the message PayloadTooLarge
shall be used.
ResourceInStandby
This message shall be used to indicate that the request could not be performed because the resource is in standby.
ActionParameterValueTypeError(String, String, String)
This message shall be used to indicate that a parameter was given the wrong value type, such as when a number is supplied for a parameter that requires a string.
Tuple Fields
StrictAccountTypes(String)
This message shall be used to indicate that the request failed because a set of AccountTypes
or OEMAccountTypes
was not accepted while StrictAccountTypes
is set to true
.
Tuple Fields
CreateFailedMissingReqProperties(String)
This message shall be used to indicate that a create was attempted on a resource but that properties that are required for the create operation were missing from the request.
AccountNotModified
This message shall be used to indicate that the modification requested for the account was not successful.
Created
This message shall be used to indicate that all conditions of a successful create operation have been met.
AccountForSessionNoLongerExists
This message shall be used to indicate that the account for the session has been removed, thus the session has been removed as well.
OperationTimeout
This message shall be used to indicate that one of the internal operations necessary to complete the request timed out. Partial results of the client operation may be returned.
ActionDeprecated(String)
This message shall be used to indicate that the action is deprecated.
ResourceInUse
This message shall be used to indicate that a change was requested to a resource but the change was rejected due to the resource being in use or transition.
EmptyJSON
This message shall be used to indicate that the request body contained an empty JSON object when one or more properties are expected in the body.
QueryNotSupported
This message shall be used to indicate that query is not supported on the implementation.
ChassisPowerStateOnRequired(String)
This message shall be used to indicate that the request requires the specified chassis to be powered on as indicated by its PowerState
property.
Tuple Fields
PayloadTooLarge
This message shall be used to indicate that the payload supplied exceeds the size supported by the service. For cases where the payload size is supported, but there is insufficent available storage space, the message InsufficientStorage
shall be used.
CouldNotEstablishConnection(String)
This message shall be used to indicate that the attempt to access the resource, file, or image at the URI was unsuccessful because a session could not be established.
PropertyValueOutOfRange(String, String)
This value shall be used to indicate that a property was given the correct value type but the value of that property is outside the supported range.
Tuple Fields
UndeterminedFault(String)
This message shall be used to indicate that a fault or error condition has been reported to the service, but the source of the fault cannot be determined or is unknown to the service.
Tuple Fields
MaximumErrorsExceeded
The maximum number of errors that the implementation can report has been exceeded. This shall not be the only message reported by the service. The use of this message should be limited to RDE implementations.
LicenseRequired(String)
This message shall be used to indicate that that a license is required to perform the requested operation.
Tuple Fields
AccessDenied(String)
This message shall be used to indicate that while attempting to access, connect to, or transfer to or from another resource, the service denied access.
MalformedJSON
This message shall be used to indicate that the request body was malformed JSON.
PropertyValueDeprecated(String, String)
This message shall be used to indicate that a property was given a deprecated value.
Tuple Fields
OperationFailed
This message shall be used to indicate that one of the internal operations necessary to complete the request failed. Partial results of the client operation may be returned.
InsufficientPrivilege
This message shall be used to indicate that the credentials associated with the established session do not have sufficient privileges for the requested operation.
ActionParameterValueConflict(String, String)
This message shall be used to indicate that the requested parameter value could not be completed, because of a mismatch with other parameters or properties in the resource.
Tuple Fields
PreconditionFailed
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 thus 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.
ChassisPowerStateOffRequired(String)
This message shall be used to indicate that the request requires the specified chassis to be powered off as indicated by its PowerState
property.
Tuple Fields
HeaderMissing(String)
This message shall be used to indicate that a required request header is missing in the request.
PropertyMissing(String)
This message shall be used to indicate that a required property was not supplied as part of the request.
QueryParameterValueError(String)
This message shall be used to indicate that a query parameter was given an invalid value that can not or should not be included in the message.
UnrecognizedRequestBody
This message shall be used to indicate that the service encountered an unrecognizable request body that could not even be interpreted as malformed JSON.
ResourceCreationConflict(String)
This message shall be used to 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.
Tuple Fields
ActionParameterValueError(String, String)
This message shall be used to indicate that a parameter was given an invalid value, and the value cannot or should not be included in the message.
Tuple Fields
ArraySizeTooShort(String, f64)
This message shall be used to indicate that the size of the array is under the minimum number of elements.
Tuple Fields
InvalidObject(String)
This message shall be used to indicate that the object in question is invalid according to the implementation.
ActionParameterUnknown(String, String)
This message shall be used to indicate that an action was submitted but an action parameter supplied did not match any of the known parameters.
Tuple Fields
QueryCombinationInvalid
This message shall be used to indicate that the request contains multiple query parameters, and that two or more of them cannot be used together.
ActionNotSupported(String)
This message shall be used to indicate that the action supplied with the POST operation is not supported by the resource.
SessionTerminated
This message shall be used to indicate that the DELETE operation on the session resource resulted in the successful termination of the session.
NoOperation
This message shall be used to indicate that the requested operation will not perform any changes on the service.
ResetRecommended(String, String)
This message shall be used to indicate that a component reset is recommended for error recovery while unaffected applications can continue running without any effects on accuracy and performance.
Tuple Fields
AccountModified
This message shall be used to indicate that the account was successfully modified.
ResourceAlreadyExists(String, String, String)
This message shall be used to indicate that a resource change or creation was attempted but that the operation cannot proceed because the resource already exists.
Tuple Fields
MissingOrMalformedPart
This message shall be used to indicate that the request payload supplied as part of an HTTP multipart request is missing one or more required parts or contains malformed parts.
InvalidJSON(f64)
This message shall be used to indicate that the request body contains invalid JSON.
Tuple Fields
ActionParameterDuplicate(String, String)
This message shall be used to indicate that the action was supplied with a duplicated action parameter in the request body.
Tuple Fields
QueryParameterUnsupported(String)
This message shall be used to indicate that a query parameter is not supported by this service.
InvalidURI(String)
This message shall be used to indicate that the operation encountered a URI that does not correspond to a valid resource.
AccountRemoved
This message shall be used to indicate that the account was successfully removed.
QueryNotSupportedOnResource
This message shall be used to indicate that query is not supported on the given resource.
ServiceShuttingDown
This message shall be used to indicate that the operation failed as the service is shutting down.
ResourceExhaustion(String)
This message shall be used to indicate that a resource could not satisfy the request due to some unavailability of resources.
SubscriptionTerminated
This message shall be used to indicate that an event subscription has been terminated by the service.
ArraySizeTooLong(String, f64)
This message shall be used to indicate that the size of the array exceeded the maximum number of elements.
Tuple Fields
ResourceCannotBeDeleted
This message shall be used to indicate that a delete operation was attempted on a resource that cannot be deleted.
InvalidIndex(f64)
This message shall be used to indicate that the index is not valid.
RestrictedRole(String)
This message shall be used to indicate that the operation was not successful because the role is restricted.
QueryParameterOutOfRange(String, String, String)
This message shall be used to indicate that a query parameter was provided that is out of range for the given resource.
Tuple Fields
ActionParameterValueNotInList(String, String, String)
This message shall be used to indicate that a parameter was given the correct value type but the value of that parameter was not supported.
Tuple Fields
RestrictedPrivilege(String)
This message shall be used to indicate that the operation was not successful because a privilege is restricted.
ResourceTypeIncompatible(String, String)
This message shall be used to indicate that the resource type of the operation does not match that for the operation destination.
Tuple Fields
ResetRequired(String, String)
This message shall be used to indicate that a component reset is required for changes, error recovery, or operations to complete.
Tuple Fields
PropertyValueIncorrect(String, String)
This message shall be used to indicate that the requested write of a property could not be completed, because of an incorrect value of the property such as when it does not meet the constraints of the implementation or match the regular expression requirements.
Tuple Fields
ActionParameterMissing(String, String)
This message shall be used to indicate that the action requested was missing an action parameter that is required to process the action.
Tuple Fields
ResourceAtUriInUnknownFormat(String)
This message shall be used to indicate that the URI was valid but the resource or image at that URI was in a format not supported by the service.
PropertyValueExternalConflict(String, String)
This message shall be used to 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 the resource.
Tuple Fields
PropertyUnknown(String)
This message shall be used to indicate that an unknown property was included in the request body.
ActionParameterValueFormatError(String, String, String)
This message shall be used to indicate that a parameter was given the correct value type but the value of that parameter was not supported.
Tuple Fields
ActionParameterNotSupported(String, String)
This message shall be used to indicate that the parameter supplied for the action is not supported on the resource.
Tuple Fields
StringValueTooLong(String, f64)
This message shall be used to indicate that a string value passed to the given resource exceeded its length limit.
Tuple Fields
PropertyValueResourceConflict(String, String, String)
This message shall be used to 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.
Tuple Fields
PropertyNotWritable(String)
This message shall be used to indicate that a property was given a value in the request body, but the property is a readonly property.
AuthenticationTokenRequired
This message shall be used to 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.
This message shall be used to indicate that the service is temporarily unavailable.
ConditionInRelatedResource
This message shall be used to 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.
PropertyDeprecated(String)
This message shall be used to indicate that the property is deprecated.
PropertyDuplicate(String)
This message shall be used to indicate that a duplicate property was included in the request body.
PasswordChangeRequired(String)
This message shall be used to 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.
Tuple Fields
PropertyValueError(String)
This message shall be used to indicate that a property was given an invalid value, and the value cannot or should not be included in the message text.
QueryParameterValueFormatError(String, String)
This message shall be used to indicate that a query parameter was given the correct value type but the value of that parameter was not supported.
Tuple Fields
EventSubscriptionLimitExceeded
This message shall be used to indicate that a event subscription establishment has been requested but the operation failed due to the number of simultaneous connection exceeding the limit of the implementation.
OperationNotAllowed
This message shall be used to indicate that the HTTP method in the request is not allowed on this resource. This error message should be used together with status code 405 Method Not Allowed.
GeneralError
This message shall be used to 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.
PropertyValueTypeError(String, String)
This message shall be used to indicate that a property was given the wrong value type.
Tuple Fields
StringValueTooShort(String, f64)
This message shall be used to indicate that a string value passed to the given resource was under its minimum required length.