Skip to main content

Redfish Settings

Table 1. Redfish Settings Properties

Name

Type

Read only

Description

@odata.typeStringTrue

Refer to OData Support

ETagStringTrue
  1. The entity tag (ETag) of the Resource to which the settings were applied, after the application.

  2. This property shall contain the entity tag (ETag) of the Resource to which the settings were applied, after the application. The client can check this value against the ETag of this Resource to determine whether the Resource had other changes.

MaintenanceWindowResourceObjectTrue
  1. The location of the maintenance window settings.

  2. This property shall contain a link to a Resource that contains the @Redfish.MaintenanceWindow property that governs this Resource.

  3. This property should be supported if the SupportedApplyTimes property contains AtMaintenanceWindowStart or InMaintenanceWindowOnReset.

MessagesArrayTrue
This property shall contain an array of messages associated with the settings.

Name

Type

Read only

Description

MessageId

String

True

This property shall be a key into message registry as described in the Redfish specification.

Message

String

True

This property shall contain an optional human readable message.

MessageArgs

Array

True

This property shall contain the message substitution arguments for the specific message referenced by the MessageId and shall only be included if the MessageId is present.

RelatedProperties

Array

True

This property shall contain an array of JSON Pointers indicating the properties described by the message, if appropriate for the message.

Severity

String

True

The value of this property shall be the severity of the error, as defined in the Status section of the Redfish specification.

Resolution

String

True

This property shall contain an override of the Resolution of the message in message registry, if present.

Oem

Object

True

Refer to Resource Complex Types
SettingsObjectObjectTrueThis property shall contain the URI of the Resource that the client may PUT or PATCH to modify the Resource.
SupportedApplyTimesArrayTrue
The time when the settings can be applied. A service shall advertise its applytime capabilities using this property as to when a Setting resource can be applied.

Enum

Description

Immediate

Apply immediately

OnReset

Apply on a reset

AtMaintenanceWindowStart

Apply during a maintenance window as specified by an administrator.

InMaintenanceWindowOnReset

Apply after a reset but within maintenance window as specified by an adminstrator.

TimeStringTrueThis property shall indicate the time when the settings were applied to the Resource.