DMTF Redfish

Document Identifier: DSP2046

Date: 2019-04-01

Version: 2019.1




Redfish Resource and Schema Guide










Document Class: Informative

Document Status: Published

Document Language: en-US


Copyright Notice

Copyright © 2016-2019 DMTF. All rights reserved.

DMTF is a not-for-profit association of industry members dedicated to promoting enterprise and systems management and interoperability. Members and non-members may reproduce DMTF specifications and documents, provided that correct attribution is given. As DMTF specifications may be revised from time to time, the particular version and release date should always be noted.

Implementation of certain elements of this standard or proposed standard may be subject to third party patent rights, including provisional patent rights (herein "patent rights"). DMTF makes no representations to users of the standard as to the existence of such rights, and is not responsible to recognize, disclose, or identify any or all such third party patent right, owners or claimants, nor for any incomplete or inaccurate identification or disclosure of such rights, owners or claimants. DMTF shall have no liability to any party, in any manner or circumstance, under any legal theory whatsoever, for failure to recognize, disclose, or identify any such third party patent rights, or for such party's reliance on the standard or incorporation thereof in its product, protocols or testing procedures. DMTF shall have no liability to any party implementing such standard, whether such implementation is foreseeable or not, nor to any patent owner or claimant, and shall have no liability or responsibility for costs or losses incurred if a standard is withdrawn or modified after publication, and shall be indemnified and held harmless by any party implementing the standard from any and all claims of infringement by a patent owner for such implementations.

For information about patents held by third-parties which have notified the DMTF that, in their opinion, such patent may relate to or impact implementations of DMTF standards, visit http://www.dmtf.org/about/policies/disclosures.php.

This document's normative language is English. Translation into other languages is permitted.


Contents

Overview

The Redfish standard comprises a set of specifications maintained by the Redfish Forum, a working group within the DMTF. The standard defines a protocol that uses RESTful interfaces to provide access to data and operations associated with the management of systems and networks. One of the strengths of the Redfish protocol is that it works with a wide range of servers: from stand-alone servers to rack-mount and bladed environments to large-scale data centers and cloud environments.

The Redfish standard addresses several key issues for infrastructures that require scalability. Large infrastructures often consist of many simple servers of different makes and types. This hyper-scale usage model requires a new approach to systems management. The Redfish Scalable Platforms Management ("Redfish") protocol addresses these needs by providing a standard protocol based on out-of-band systems management.

With the above goals in mind, the Redfish protocol was designed as an open industry standard to meet scalability requirements in multi-vendor deployments. It easily integrates with commonly used tools, using RESTful interfaces to perform operations and using JSON and OData formats for data payloads.

Who should read this document?

This document is useful to people who want to understand how to use the Redfish API. This includes application developers who want to create client-side software to communicate with a Redfish service, and other consumers of the API.

Where can I find more information?

The following web sites provide more information about the Redfish standard:

Using this guide

Every Redfish response consists of a JSON payload containing properties that are strictly defined by a schema for that resource. The schema defining a particular resource can be determined from the value of the "@odata.type" property returned in every Redfish response. This guide details the definitions for every Redfish standard schema.

Each schema section contains:


The property-level details include:

Column Purpose
Property Name The name of the JSON property as it will appear (case sensitive) in the JSON payload. For properties added to the schema after the initial release (v1.0.0), the version that the property was added will be shown in parenthesis. Properties that have been deprecated will also be indicated (along with the version where the deprecation occurred).
Type The JSON data type(s) for the property. This can include boolean, number, string or object. String types that use defined enumerations will state "(enum)". Number types will state their units where used.
Attributes Designates whether the property is read-only or read-write (if supported by the implementation), and whether a 'null' value may be returned by the Service if the value of the property is temporarily unavailable.
Description The description of the property, as copied directly from the schema 'Description' definition.

URI listings

The Redfish Specification v1.6.0 added mandatory support for the OpenAPI Specification v3.0. As part of this support, the URIs for every Redfish Resource are defined to appear at known, fixed locations. Resource Collections also appear at fixed locations, with the Members of each collection appearing at URIs constructed using a fixed path structure, with appropriate path segments equal to the value of "Id" properties of Members along the path.

Support for v1.6.0 and OpenAPI can be determined by comparing the value of the "RedfishVersion" property in the Service Root (\redfish\v1). Services reporting a value of "1.6.0" or higher (such as "1.6.1" or "1.7.0") adhere to the URI definitions shown.

The URI listings do not apply to Redfish Services reporting support of Specification versions prior to v1.6.0. For those Services, clients must utilize the hypermedia features of the API to discover links from the Service Root to each resource. While Services will typically match the URIs listed in this documents for many of their resources, this is not guaranteed and will result in errors.

Common properties

Properties defined for all Redfish schemas

The following properties are defined for inclusion in every Redfish schema, and therefore may be encountered in any Response payload. They are documented here to avoid repetition in the Reference Guide property tables. Note that several of these properties are payload annotations, but are listed here as they are required for all Redfish resources.

@odata.contextstringread-onlyThe @odata.context property is a URL to a metadata document with a fragment describing the data (typically rooted at the top-level singleton or collection). Technically the metadata document only has to define, or reference, any of the types that it directly uses, and different payloads could reference different metadata documents. However, since the @odata.context provides a root URL for resolving relative references (such as @odata.id's), we return the canonical metadata document.
@odata.etagstringread-onlyThe current ETag for the resource.
@odata.idstringread-only requiredThe @odata.id property is a string that indicates the unique identifier of a resource.
@odata.typestringread-only requiredThe type of a resource.
Descriptionstringread-onlyThe Description property is used to convey a human-readable description of the resource.
Idstringread-onlyThe Id property of a resource uniquely identifies the resource within the Resource Collection that contains it. The value of Id is unique within a Resource Collection.
Namestringread-only requiredThe Name property is used to convey a human-readable moniker for a resource. The type of the Name property is a string. The value of Name is NOT necessarily unique across resource instances within a Resource Collection.
Oem { }objectThis is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.

Frequently used properties

In addition, the following properties are frequently defined in Redfish schemas. Their definition and usage is the same throughout the Redfish data model.

Actions { }objectThis object contains definitions for the Redfish Actions available for this resource.
Links { }objectThe Links property represents the links associated with the resource, as defined by that resource's schema definition. All associated reference properties defined for a resource are nested under the Links property. All directly referenced (subordinate) properties defined for a resource can be found from the root of the resource.
RelatedItem [ {arrayThe RelatedItem property is represented as a set of links. The links point to a resource, or part of a resource, as defined by that resource's schema definition. This representation is not intended to be a strong linking methodology like other references. Instead it is used to show a relationship between elements or sub-elements in disparate parts of the service. For example, Fans may be in one area of the system and Processors in another area of the system. It could be that the relationship between the two is not obvious. The RelatedItem property can be used to show that one is related to the other. In this example, it might indicate that a specific fan is cooling a specific processor.
      @odata.id
} ]
stringread-onlyThe unique identifier for a resource.

Payload annotations

Payload annotations are a mechanism in which a service provides additional information about a given property or object. Redfish limits usage of these annotations to OData core terms, Redfish Extensions or Redfish Messages.

Property-level annotations

A payload annotation for a single property takes the form of an additional property named Property@Schema.Term, where Property is the JSON property being annotated, Schema is the schema file where the definition for the annotation is found, and Term is the name of the Annotation.

@Message.ExtendedInfo { }objectAllows the service to provide a set of Message structures for a given property to indicate additional information; this can be useful when a property is null due to an error condition, and the service wants to convey why the property is null.
@odata.countintegerread-onlyThe number of items in a collection.
@Redfish.AllowableValues [ ] array
(string)
read-onlyIndicates to the client the different string values the service accepts for a given property or action parameter.

In the example below, the property ResetType is being annotated with the AllowableValues term, which is defined in the Redfish schema (an alias for RedfishExtensions). This is used to indicate to the client that the service supports the values On and ForceOff for ResetType.

{
    "ResetType@Redfish.AllowableValues": [
        "On",
        "ForceOff"
    ]
}

Resource or object-level annotations

A payload annotation for an entire resource or a JSON object takes the form of @Schema.Term, where Namespace is the schema file where the definition is found and Term is the name of the Annotation. These payload annotations are used to provide further information about the object itself.

@Redfish.ActionInfostringread-onlyThe term can be applied to an Action to specify a URI to an ActionInfo resource which describes the parameters supported by this instance of the Action.
@Redfish.CollectionCapabilities { }objectReference to the resource that represents the POST capabilities of a given collection.
See the CollectionCapabilities object for details on this property.
@Redfish.MaintenanceWindow { }objectMaintenance window configuration of a resource for when to apply settings or operations.
See the MaintenanceWindow object for details on this property.
@Redfish.OperationApplyTimestring
(enum)
read-writeThe requested apply time from a client when performing a Create, Delete, or Action operation.
See @Redfish.OperationApplyTime in Property Details, below, for the possible values of this property.
@Redfish.OperationApplyTimeSupport { }objectIndicates if a client is allowed to request for a specific apply time of a Create, Delete, or Action operation of a given resource via the OperationApplyTime term.
See the OperationApplyTimeSupport object for details on this property.
@Redfish.Settings { }objectReference to the resource that represents the settings to be applied to this object.
See the Settings object for details on this property.
@Redfish.SettingsApplyTime { }objectConfiguration settings for when the values in the settings object are applied to a given resource.
See the PreferredApplyTime object for details on this property.

Property Details

@Redfish.OperationApplyTime:

The requested apply time from a client when performing a Create, Delete, or Action operation.

stringDescription
AtMaintenanceWindowStartApply the requested operation during a maintenance window as specified by an administrator.
ImmediateApply the requested operation immediately.
InMaintenanceWindowOnResetApply the requested operation after a reset but within maintenance window as specified by an adminstrator.
OnResetApply the requested operation on a reset.

In the example below, the object is being annotated with the ActionInfo term, which is defined in the Redfish schema (an alias for RedfishExtensions). This is used to indicate to the client that it can find more information about the given action, in this case #ComputerSystem.Reset, at the URI /redfish/v1/Systems/1/ResetActionInfo.

{
    "#ComputerSystem.Reset": {
        "target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset",
        "@Redfish.ActionInfo": "/redfish/v1/Systems/1/ResetActionInfo"
    }
}

Common objects

The following JSON objects are frequently defined in Redfish schemas. Like the individual common properties listed above, these objects share a common definition which is shown here to avoid repetition in the Reference Guide property tables.

Actions

The Actions object contains descriptions of the actions defined and available for this resource.

#{action name} {objectThis object describes a single Redfish Action.
      @Redfish.ActionInfostringread-onlyThe URI for an ActionInfo resource describing this action.
      target
}
stringread-onlyThe target URI for the POST operation to invoke the action.

Identifier

This type describes any additional identifiers for a resource.

DurableName (v1.1+)stringread-only (null)This indicates the world wide, persistent name of the resource.
DurableNameFormat (v1.1+)string
(enum)
read-only (null)This represents the format of the DurableName property.
See DurableNameFormat in Property Details, below, for the possible values of this property.

Property Details

DurableNameFormat:

This represents the format of the DurableName property.

stringDescription
EUIIEEE-defined 64-bit Extended Unique Identifier.
FC_WWNFibre Channel World Wide Name.
iQNiSCSI Qualified Name.
NAAName Address Authority Format.
NQNNVMe Qualified Name.
NSIDNVM Namespace Identifier.
UUIDUniversally Unique Identifier.

IPv4Address

This type describes an IPv4 Address.

Addressstringread-write (null)This is the IPv4 Address.
AddressOriginstring
(enum)
read-only (null)This indicates how the address was determined.
See AddressOrigin in Property Details, below, for the possible values of this property.
Gatewaystringread-write (null)This is the IPv4 gateway for this address.
Oem { }objectSee the OEM object definition in the Common properties section.
SubnetMaskstringread-write (null)This is the IPv4 Subnet mask.

Property Details

AddressOrigin:

This indicates how the address was determined.

stringDescription
BOOTPAddress is provided by a BOOTP service.
DHCPAddress is provided by a DHCPv4 service.
IPv4LinkLocalAddress is valid only for this network segment (link).
StaticA static address as configured by the user.

IPv6Address

This type describes an IPv6 Address.

Addressstringread-write (null)This is the IPv6 Address.
AddressOriginstring
(enum)
read-only (null)This indicates how the address was determined.
See AddressOrigin in Property Details, below, for the possible values of this property.
AddressStatestring
(enum)
read-only (null)The current state of this address as defined in RFC 4862.
See AddressState in Property Details, below, for the possible values of this property.
Oem { }objectSee the OEM object definition in the Common properties section.
PrefixLengthintegerread-only (null)This is the IPv6 Address Prefix Length.

Property Details

AddressOrigin:

This indicates how the address was determined.

stringDescription
DHCPv6Address is provided by a DHCPv6 service.
LinkLocalAddress is valid only for this network segment (link).
SLAACAddress is provided by a Stateless Address AutoConfiguration (SLAAC) service.
StaticA static address as configured by the user.

AddressState:

The current state of this address as defined in RFC 4862.

stringDescription
DeprecatedThis address is currently within it's valid lifetime, but is now outside of it's preferred lifetime as defined in RFC 4862.
FailedThis address has failed Duplicate Address Detection testing as defined in RFC 4862 section 5.4 and is not currently in use.
PreferredThis address is currently within both it's valid and preferred lifetimes as defined in RFC 4862.
TentativeThis address is currently undergoing Duplicate Address Detection testing as defined in RFC 4862 section 5.4.

IPv6GatewayStaticAddress

This object represents a single IPv6 static address to be assigned on a network interface.

Addressstringread-write required (null)A valid IPv6 address.
Oem { }objectSee the OEM object definition in the Common properties section.
PrefixLengthintegerread-write (null)The Prefix Length of this IPv6 address.

IPv6StaticAddress

This object represents a single IPv6 static address to be assigned on a network interface.

Addressstringread-write required (null)A valid IPv6 address.
Oem { }objectSee the OEM object definition in the Common properties section.
PrefixLengthintegerread-write required (null)The Prefix Length of this IPv6 address.

Location

This type describes the location of a resource.

AltitudeMeters (v1.6+)number
(meters)
read-write (null)The altitude of the resource in meters.
Contacts (v1.7+) [ {arrayArray of contact information.
      ContactNamestringread-write (null)Name of this contact.
      EmailAddressstringread-write (null)Email address for this contact.
      PhoneNumber
} ]
stringread-write (null)Phone number for this contact.
Info (v1.1+, deprecated v1.5)stringread-only (null)This indicates the location of the resource. Deprecated v1.5+. This property has been Deprecated in favor of new properties defined in Resource.v1_3_0.Location and Resource.v1_5_0.Location.
InfoFormat (v1.1+, deprecated v1.5)stringread-only (null)This represents the format of the Info property. Deprecated v1.5+. This property has been Deprecated in favor of new properties defined in Resource.v1_3_0.Location and Resource.v1_5_0.Location.
Latitude (v1.6+)number
(deg)
read-write (null)The latitude resource.
Longitude (v1.6+)number
(deg)
read-write (null)The longitude resource in degrees.
Oem (v1.1+) {objectSee the OEM object definition in the Common properties section.
      (pattern) { } [ ] array, boolean, integer, number, object, string (null)Property names follow regular expression pattern "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$"
      (pattern) {objectProperty names follow regular expression pattern "^[A-Za-z0-9_]+$"
            (pattern) { } [ ]
      }
}
array, boolean, integer, number, object, string (null)Property names follow regular expression pattern "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$"
PartLocation (v1.5+) {objectThe part location within the placement.
      LocationOrdinalValueintegerread-only (null)The number that represents the location of the part. If LocationType is slot and this unit is in slot 2 then the LocationOrdinalValue will be 2.
      LocationTypestring
(enum)
read-only (null)The type of location of the part, such as slot, bay, socket and slot.
See LocationType in Property Details, below, for the possible values of this property.
      Orientationstring
(enum)
read-only (null)The orientation for the ordering of the slot enumeration used by the LocationOrdinalValue property.
See Orientation in Property Details, below, for the possible values of this property.
      Referencestring
(enum)
read-only (null)The reference point for the part location. This is used to give guidance as to the general location of the part.
See Reference in Property Details, below, for the possible values of this property.
      ServiceLabel
}
stringread-only (null)This is the label of the part location, such as a silk screened name or a printed label.
Placement (v1.3+) {objectA place within the addressed location.
      AdditionalInfo (v1.7+)stringread-write (null)Area designation or other additional info.
      Rackstringread-write (null)Name of a rack location within a row.
      RackOffsetintegerread-write (null)Vertical location of the item in terms of RackOffsetUnits.
      RackOffsetUnitsstring
(enum)
read-write (null)The type of Rack Units in use.
See RackOffsetUnits in Property Details, below, for the possible values of this property.
      Row
}
stringread-write (null)Name of row.
PostalAddress (v1.3+) {objectPostal address of the addressed resource.
      AdditionalCodestringread-write (null)Additional code.
      AdditionalInfo (v1.7+)stringread-write (null)Room designation or other additional info.
      Buildingstringread-write (null)Name of the building.
      Citystringread-write (null)City, township, or shi (JP).
      Communitystringread-write (null)Postal community name.
      Countrystringread-write (null)Country.
      Districtstringread-write (null)A county, parish, gun (JP), or district (IN).
      Divisionstringread-write (null)City division, borough, dity district, ward, chou (JP).
      Floorstringread-write (null)Floor.
      GPSCoords (deprecated v1.6)stringread-write (null)The GPS coordinates of the part. Deprecated v1.6+. This property has been Deprecated in favor of Location.v1_6_0.Longitude and Location.v1_6_0.Latitude
      HouseNumberintegerread-write (null)Numeric portion of house number.
      HouseNumberSuffixstringread-write (null)House number suffix.
      Landmarkstringread-write (null)Landmark.
      LeadingStreetDirectionstringread-write (null)A leading street direction.
      Location (deprecated v1.7)stringread-write (null)Room designation or other additional info. Deprecated v1.7+. This property has been Deprecated in favor of the property AdditionalInfo found in the 1.7.0 definition of PostalAddress.
      Namestringread-write (null)Name.
      Neighborhoodstringread-write (null)Neighborhood or block.
      PlaceTypestringread-write (null)A description of the type of place that is addressed.
      POBoxstringread-write (null)Post office box (P.O. box).
      PostalCodestringread-write (null)Postal code (or zip code).
      Roadstringread-write (null)A primary road or street.
      RoadBranchstringread-write (null)Road branch.
      RoadPostModifierstringread-write (null)Road post-modifier.
      RoadPreModifierstringread-write (null)Road pre-modifier.
      RoadSectionstringread-write (null)Road Section.
      RoadSubBranchstringread-write (null)Road sub branch.
      Roomstringread-write (null)Name or number of the room.
      Seatstringread-write (null)Seat (desk, cubicle, workstation).
      Streetstringread-write (null)Street name.
      StreetSuffixstringread-write (null)Avenue, Platz, Street, Circle.
      Territorystringread-write (null)A top-level subdivision within a country.
      TrailingStreetSuffixstringread-write (null)A trailing street suffix.
      Unit
}
stringread-write (null)Name or number of the unit (apartment, suite).

Property Details

LocationType:

The type of location of the part, such as slot, bay, socket and slot.

stringDescription
BayDefines a bay as the type of location.
ConnectorDefines a connector as the type of location.
SlotDefines a slot as the type of location.
SocketDefines a socket as the type of location.

Orientation:

The orientation for the ordering of the slot enumeration used by the LocationOrdinalValue property.

stringDescription
BackToFrontDefines the ordering for the LocationOrdinalValue is back to front.
BottomToTopDefines the ordering for the LocationOrdinalValue is bottom to top.
FrontToBackDefines the ordering for the LocationOrdinalValue is front to back.
LeftToRightDefines the ordering for the LocationOrdinalValue is left to right.
RightToLeftDefines the ordering for the LocationOrdinalValue is right to left.
TopToBottomDefines the ordering for the LocationOrdinalValue is top to bottom.

RackOffsetUnits:

The type of Rack Units in use.

stringDescription
EIA_310Defines a rack unit as being equal to 1.75 in (44.45 mm).
OpenUDefines a rack unit as being equal to 48 mm (1.89 in).

Reference:

The reference point for the part location. This is used to give guidance as to the general location of the part.

stringDescription
BottomDefines the part as being in the bottom of the unit.
FrontDefines the part as being in the front of the unit.
LeftDefines the part as being in the left of the unit.
MiddleDefines the part as being in the middle of the unit.
RearDefines the part as being in the rear of the unit.
RightDefines the part as being in the right of the unit.
TopDefines the part as being in the top of the unit.

MaintenanceWindow

This object indicates if a given resource has a maintenance window assignment for applying settings or operations.

MaintenanceWindowDurationInSeconds (v1.2+)integer
(seconds)
read-write requiredThe value of this property as specified by client indicates the expiry time of maintenance window in seconds.
MaintenanceWindowStartTime (v1.2+)stringread-write requiredThe value of this property as specified by client to indicate the start time of a maintenance window.

Message

This type describes a Message returned by the Redfish service.

Messagestringread-only (null)This is the human readable message, if provided.
MessageArgs [ ] array
(string)
read-onlyThis array of message arguments are substituted for the arguments in the message when looked up in the message registry.
MessageIdstringread-only requiredThis is the key for this message which can be used to look up the message in a message registry.
Oem { }objectSee the OEM object definition in the Common properties section.
RelatedProperties [ ] array
(string)
read-onlyThis is an array of properties described by the message.
Resolutionstringread-only (null)Used to provide suggestions on how to resolve the situation that caused the error.
Severitystringread-only (null)This is the severity of the errors.

OperationApplyTimeSupport

This object indicates if a client is allowed to request for a specific apply time of a Create, Delete, or Action operation of a given resource.

MaintenanceWindowDurationInSeconds (v1.2+)integer
(seconds)
read-onlyThe value of this property as specified by client indicates the expiry time of maintenance window in seconds.
MaintenanceWindowResource (v1.2+) {objectThe value of this property is used to indicate the location of the maintenance window settings.
      @odata.id
}
stringread-onlyThe unique identifier for a resource.
MaintenanceWindowStartTime (v1.2+)stringread-onlyThe value of this property as specified by client to indicate the start time of a maintenance window.
SupportedValues [ ] array (string
(enum))
read-onlyThis property indicates the types of apply times the client is allowed request when performing a Create, Delete, or Action operation.
See SupportedValues in Property Details, below, for the possible values of this property.

Property Details

SupportedValues:

This property indicates the types of apply times the client is allowed request when performing a Create, Delete, or Action operation.

stringDescription
AtMaintenanceWindowStartApply the requested operation during a maintenance window as specified by an administrator.
ImmediateApply the requested operation immediately.
InMaintenanceWindowOnResetApply the requested operation after a reset but within maintenance window as specified by an adminstrator.
OnResetApply the requested operation on a reset.

PreferredApplyTime

This object indicates when the future configuration (i.e. Settings resource) should be applied.

ApplyTime (v1.1+)string
(enum)
read-writeThis property indicates when the future configuration (i.e. Settings resource) should be applied.
See ApplyTime in Property Details, below, for the possible values of this property.
MaintenanceWindowDurationInSeconds (v1.1+)integer
(seconds)
read-writeThe value of this property as specified by client indicates the expiry time of maintenance window in seconds.
MaintenanceWindowStartTime (v1.1+)stringread-writeThe value of this property as specified by client to indicate the start time of a maintenance window.

Property Details

ApplyTime:

This property indicates when the future configuration (i.e. Settings resource) should be applied.

stringDescription
AtMaintenanceWindowStartApply during a maintenance window as specified by an administrator.
ImmediateApply immediately.
InMaintenanceWindowOnResetApply after a reset but within maintenance window as specified by an adminstrator.
OnResetApply on a reset.

Schedule

Schedule a series of occurrences.

EnabledDaysOfMonth [ ] array
(integer, null)
read-writeDays of month when scheduled occurrences are enabled. Zero indicates that every day of the month is enabled.
EnabledDaysOfWeek [ ] array (string
(enum))
read-write (null)Days of the week when scheduled occurrences are enabled, for enabled days of month and months of year. Days of the Week.
See EnabledDaysOfWeek in Property Details, below, for the possible values of this property.
EnabledIntervals (v1.1+) [ ] array
(string, null)
read-writeIntervals when scheduled occurrences are enabled.
EnabledMonthsOfYear [ ] array (string
(enum))
read-write (null)Months of year when scheduled occurrences are enabled. Months of the year.
See EnabledMonthsOfYear in Property Details, below, for the possible values of this property.
InitialStartTimestringread-write (null)Time for initial occurrence.
Lifetimestringread-write (null)The time after provisioning when the schedule as a whole expires.
MaxOccurrencesintegerread-write (null)Maximum number of scheduled occurrences.
Namestringread-write (null)The Schedule name.
RecurrenceIntervalstringread-write (null)Distance until the next occurrences.

Property Details

EnabledDaysOfWeek:

Days of the week when scheduled occurrences are enabled, for enabled days of month and months of year. Days of the Week.

stringDescription
EveryEvery day of the week.
FridayFriday.
MondayMonday.
SaturdaySaturday.
SundaySunday.
ThursdayThursday.
TuesdayTuesday.
WednesdayWednesday.

EnabledMonthsOfYear:

Months of year when scheduled occurrences are enabled. Months of the year.

stringDescription
AprilApril.
AugustAugust.
DecemberDecember.
EveryEvery month of the year.
FebruaryFebruary.
JanuaryJanuary.
JulyJuly.
JuneJune.
MarchMarch.
MayMay.
NovemberNovember.
OctoberOctober.
SeptemberSeptember.

Settings

This type describes the settings of a resouce.

ETagstringread-only (null)The ETag of the resource to which the settings were applied, after the application.
MaintenanceWindowResource (v1.2+) {objectThe value of this property is used to indicate the location of the maintenance window settings.
      @odata.id
}
stringread-onlyThe unique identifier for a resource.
Messages [ { } ]array (object)This is an array of messages associated with the task. This type describes a Message returned by the Redfish service.
See the Message object for details on this property.
SettingsObject {objectReference to the resource the client may PUT/PATCH to in order to change this resource.
      @odata.id
}
stringread-onlyThe unique identifier for a resource.
SupportedApplyTimes [ ] array (string
(enum))
read-onlyThis property indicates when a Settings resource can be applied.
See SupportedApplyTimes in Property Details, below, for the possible values of this property.
Timestringread-only (null)Indicates the time the settings were applied.

Property Details

SupportedApplyTimes:

This property indicates when a Settings resource can be applied.

stringDescription
AtMaintenanceWindowStartApply during a maintenance window as specified by an administrator.
ImmediateApply immediately.
InMaintenanceWindowOnResetApply after a reset but within maintenance window as specified by an adminstrator.
OnResetApply on a reset.

Status

This type describes the status and health of a resource and its children.

Healthstring
(enum)
read-only (null)This represents the health state of this resource in the absence of its dependent resources.
See Health in Property Details, below, for the possible values of this property.
HealthRollupstring
(enum)
read-only (null)This represents the overall health state from the view of this resource.
See HealthRollup in Property Details, below, for the possible values of this property.
Oem {objectSee the OEM object definition in the Common properties section.
      (pattern) { } [ ] array, boolean, integer, number, object, string (null)Property names follow regular expression pattern "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$"
      (pattern) {objectProperty names follow regular expression pattern "^[A-Za-z0-9_]+$"
            (pattern) { } [ ]
      }
}
array, boolean, integer, number, object, string (null)Property names follow regular expression pattern "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$"
Statestring
(enum)
read-only (null)This indicates the known state of the resource, such as if it is enabled.
See State in Property Details, below, for the possible values of this property.

Property Details

Health:

This represents the health state of this resource in the absence of its dependent resources.

stringDescription
CriticalA critical condition exists that requires immediate attention.
OKNormal.
WarningA condition exists that requires attention.

HealthRollup:

This represents the overall health state from the view of this resource.

stringDescription
CriticalA critical condition exists that requires immediate attention.
OKNormal.
WarningA condition exists that requires attention.

State:

This indicates the known state of the resource, such as if it is enabled.

stringDescription
AbsentThis function or resource is not present or not detected.
DeferringThe element will not process any commands but will queue new requests.
DisabledThis function or resource has been disabled.
EnabledThis function or resource has been enabled.
InTestThis function or resource is undergoing testing.
QuiescedThe element is enabled but only processes a restricted set of commands.
StandbyOfflineThis function or resource is enabled, but awaiting an external action to activate it.
StandbySpareThis function or resource is part of a redundancy set and is awaiting a failover or other external action to activate it.
StartingThis function or resource is starting.
UnavailableOfflineThis function or resource is present but cannot be used.
UpdatingThe element is updating and may be unavailable or degraded.

Redundancy

This is the redundancy definition to be used in other resource schemas.

@odata.idstringread-only requiredThe unique identifier for a resource.
Actions { }objectThe available actions for this resource.
MaxNumSupportedintegerread-only required (null)This is the maximum number of members allowable for this particular redundancy group.
MemberIdstringread-only requiredThis is the identifier for the member within the collection.
MinNumNeededintegerread-only required (null)This is the minumum number of members needed for this group to be redundant.
Modestring
(enum)
read-write required (null)This is the redundancy mode of the group.
See Mode in Property Details, below, for the possible values of this property.
Namestringread-only requiredThe name of the resource or array element.
Oem { }objectThis is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.
See the Oem object for details on this property.
RedundancyEnabledbooleanread-write (null)This indicates whether redundancy is enabled.
RedundancySet [ {array requiredContains any ids that represent components of this redundancy set.
      @odata.id
} ]
stringread-onlyThe unique identifier for a resource.
RedundancySet@odata.countintegerread-onlyThe number of items in a collection.
Status { }object requiredThis property describes the status and health of the resource and its children.
See the Status object for details on this property.

Property Details

Mode:

This is the redundancy mode of the group.

stringDescription
FailoverFailure of one unit will automatically cause its functions to be taken over by a standby or offline unit in the redundancy set.
N+mMultiple units are available and active such that normal operation will continue if one or more units fail.
NotRedundantThe subsystem is not configured in a redundancy mode, either due to configuration or the functionality has been disabled by the user.
SharingMultiple units contribute or share such that operation will continue, but at a reduced capacity, if one or more units fail.
SparingOne or more spare units are available to take over the function of a failed unit, but takeover is not automatic.

Resource collections

A core concept in Redfish is a Collection of resources. A Collection is a group of like resources where the number of instances in the group can shrink or grow depending on the scope of the Redfish Service or the configuration of the devices being managed. Every Resource Collection resource has the same set of supported properties, and all contain "Collection" in the name of their schema. Every resource linked in the "Members" array within a Resource Collection will have the same resource type (same schema with the same major version, but can vary in minor or errata schema versions, which are all compatible).

The properties of a Resource Collection are as follows:

@odata.contextstringread-onlyThe OData description of a payload.
@odata.idstringread-only requiredThe unique identifier for a resource.
@odata.typestringread-only requiredThe type of a resource.
Descriptionstringread-only (null)Provides a description of this resource and is used for commonality in the schema definitions.
Members [ {array requiredContains the members of this collection.
      @odata.id
} ]
stringread-onlyA link to a resource instance which is a member of this collection.
Members@odata.countintegerread-onlyThe number of items in a collection.
Members@odata.navigationLinkstringread-write
Namestringread-only requiredThe name of the resource or array element.
Oem { }objectThis is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.

As shown in the example below, a Redfish Service may provide management functionality for several Computer Systems, and therefore a ComputerSystemCollection resource is provided. This example shows a Service with four ComputerSystem instances ("Members").

{
    "@odata.type": "#ComputerSystemCollection.ComputerSystemCollection",
    "Name": "Computer System Collection",
    "Members@odata.count": 4,
    "Members": [
        {
            "@odata.id": "/redfish/v1/Systems/529QB9450R6"
        },
        {
            "@odata.id": "/redfish/v1/Systems/529QB9451R6"
        },
        {
            "@odata.id": "/redfish/v1/Systems/529QB9452R6"
        },
        {
            "@odata.id": "/redfish/v1/Systems/529QB9453R6"
        }
    ],
    "@odata.context": "/redfish/v1/$metadata#ComputerSystemCollection.ComputerSystemCollection",
    "@odata.id": "/redfish/v1/Systems"
}

Resource Collection URIs (Redfish v1.6+)

The following table lists all of the Redfish-defined Resource Collections and the URIs where they can appear. NOTE: The URIs listed are valid for Redfish Services conforming to the Redfish Specification v1.6.0 or higher. Services built on earlier versions of the Specification may use different URIs which must be discovered by following the links from the Service Root (/redfish/v1/).

Collection TypeURIs
AccelerationFunctionCollection/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/AccelerationFunctions
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/AccelerationFunctions
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/AccelerationFunctions
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/AccelerationFunctions
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/AccelerationFunctions
BootOptionCollection/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/BootOptions
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/BootOptions
/redfish/v1/Systems/{ComputerSystemId}/BootOptions
CertificateCollection/redfish/v1/AccountService/Accounts/{ManagerAccountId}/Certificates
/redfish/v1/AccountService/ActiveDirectory/Certificates
/redfish/v1/AccountService/ExternalAccountProviders/{ExternalAccountProviderId}/Certificates
/redfish/v1/AccountService/LDAP/Certificates
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Boot/Certificates
/redfish/v1/Managers/{ManagerId}/NetworkProtocol/HTTPS/Certificates
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/Accounts/{ManagerAccountId}/Certificates
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/ActiveDirectory/Certificates
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/ExternalAccountProviders/{ExternalAccountProviderId}/Certificates
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/LDAP/Certificates
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Boot/Certificates
/redfish/v1/Systems/{ComputerSystemId}/Boot/Certificates
ChassisCollection/redfish/v1/Chassis
ComputerSystemCollection/redfish/v1/Systems
EndpointCollection/redfish/v1/Fabrics/{FabricId}/Endpoints
EthernetInterfaceCollection/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/EthernetInterfaces
/redfish/v1/Managers/{ManagerId}/EthernetInterfaces
/redfish/v1/Managers/{ManagerId}/HostInterfaces/{HostInterfaceId}/HostEthernetInterfaces
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/EthernetInterfaces
/redfish/v1/Systems/{ComputerSystemId}/EthernetInterfaces
EventDestinationCollection/redfish/v1/EventService/Subscriptions
ExternalAccountProviderCollection/redfish/v1/AccountService/ExternalAccountProviders
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/ExternalAccountProviders
FabricCollection/redfish/v1/Fabrics
HostInterfaceCollection/redfish/v1/Managers/{ManagerId}/HostInterfaces
JobCollection/redfish/v1/JobService/Jobs
/redfish/v1/JobService/Jobs/{JobId}/Steps
JsonSchemaFileCollection/redfish/v1/JsonSchemas
LogEntryCollection/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices/{LogServiceId}/Entries
/redfish/v1/Managers/{ManagerId}/LogServices/{LogServiceId}/Entries
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices/{LogServiceId}/Entries
/redfish/v1/Systems/{ComputerSystemId}/LogServices/{LogServiceId}/Entries
LogServiceCollection/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices
/redfish/v1/Managers/{ManagerId}/LogServices
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices
/redfish/v1/Systems/{ComputerSystemId}/LogServices
ManagerAccountCollection/redfish/v1/AccountService/Accounts
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/Accounts
ManagerCollection/redfish/v1/Managers
MemoryChunksCollection/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/MemoryDomains/{MemoryDomainId}/MemoryChunks
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/MemoryDomains/{MemoryDomainId}/MemoryChunks
/redfish/v1/Systems/{ComputerSystemId}/MemoryDomains/{MemoryDomainId}/MemoryChunks
MemoryCollection/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory
/redfish/v1/Systems/{ComputerSystemId}/Memory
MemoryDomainCollection/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/MemoryDomains
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/MemoryDomains
/redfish/v1/Systems/{ComputerSystemId}/MemoryDomains
MessageRegistryCollection
MessageRegistryFileCollection/redfish/v1/Registries
MetricDefinitionCollection/redfish/v1/TelemetryService/MetricDefinitions
MetricReportCollection/redfish/v1/TelemetryService/MetricReports
MetricReportDefinitionCollection/redfish/v1/TelemetryService/MetricReportDefinitions
NetworkAdapterCollection/redfish/v1/Chassis/{ChassisId}/NetworkAdapters
NetworkDeviceFunctionCollection/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkDeviceFunctions
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions
/redfish/v1/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions
/redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions
NetworkInterfaceCollection/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces
/redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces
NetworkPortCollection/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkPorts
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts
/redfish/v1/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts
/redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts
PortCollection/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageController/{StorageControllerMemberId}/Ports
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageController/{StorageControllerMemberId}/Ports
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageController/{StorageControllerMemberId}/Ports
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageController/{StorageControllerMemberId}/Ports
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageController/{StorageControllerMemberId}/Ports
ProcessorCollection/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors
/redfish/v1/Systems/{ComputerSystemId}/Processors
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors
ResourceBlockCollection/redfish/v1/CompositionService/ResourceBlocks
/redfish/v1/ResourceBlocks
RoleCollection/redfish/v1/AccountService/Roles
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/Roles
SensorCollection/redfish/v1/Chassis/{ChassisId}/Sensors
SerialInterfaceCollection/redfish/v1/Managers/{ManagerId}/SerialInterfaces
SessionCollection/redfish/v1/SessionService/Sessions
SimpleStorageCollection/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/SimpleStorage
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/SimpleStorage
/redfish/v1/Systems/{ComputerSystemId}/SimpleStorage
SoftwareInventoryCollection/redfish/v1/UpdateService/FirmwareInventory
/redfish/v1/UpdateService/SoftwareInventory
StorageCollection/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage
/redfish/v1/Systems/{ComputerSystemId}/Storage
SwitchCollection/redfish/v1/Fabrics/{FabricId}/Switches
TaskCollection/redfish/v1/TaskService/Tasks
TriggersCollection/redfish/v1/TelemetryService/Triggers
VirtualMediaCollection/redfish/v1/Managers/{ManagerId}/VirtualMedia
VLanNetworkInterfaceCollection/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/Ethernet/VLANs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs
/redfish/v1/Managers/{ManagerId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs
/redfish/v1/ResourceBlocks/{ResourceBlockId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs
/redfish/v1/Systems/{ComputerSystemId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs
VolumeCollection/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Volumes
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Volumes
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes
ZoneCollection/redfish/v1/CompositionService/ResourceZones
/redfish/v1/Fabrics/{FabricId}/Zones

Reference Guide

This guide was produced using the contents of the schema files from DMTF Redfish Schema bundle DSP8010 and merged with supplemental text using the DMTF's Redfish Documentation Generator. The version of this guide corresponds to the version of DSP8010 used to generate the text.

AccelerationFunction 1.0.1

v1.0
2018.3

The AccelerationFunction schema defines the accelerator implemented in a Processor device.

URIs:

AccelerationFunctionTypestring
(enum)
read-only (null)The type of acceleration function.
See AccelerationFunctionType in Property Details, below, for the possible values of this property.
FpgaReconfigurationSlots [ ] array
(string)
read-onlyAn array of the reconfiguration slot identifiers for an FPGA.
Links {objectContains references to other resources that are related to this resource.
      Endpoints [ {arrayAn array of references to the endpoints that connect to this acceleartion function.
            @odata.id
      } ]
stringread-onlyLink to a Endpoint resource. See the Links section and the Endpoint schema for details.
      Oem { }objectSee the OEM object definition in the Common properties section.
      PCIeFunctions [ {arrayAn array of references to the PCIeFunctions associated with this acceleration function.
            @odata.id
      } ]
}
stringread-onlyLink to a PCIeFunction resource. See the Links section and the PCIeFunction schema for details.
Manufacturerstringread-onlyThe acceleration function code manufacturer.
PowerWattsinteger
(Watts)
read-onlyThe acceleration function power consumption.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
UUIDstringread-only (null)The universal unique identifier (UUID) for this acceleration function.
Versionstringread-onlyThe acceleration function version.

Property Details

AccelerationFunctionType:

The type of acceleration function.

stringDescription
AudioProcessingAn audio processing function.
CompressionA compression function.
EncryptionAn encryption function.
OEMAn OEM-defined acceleration function.
PacketInspectionA packet inspection function.
PacketSwitchA packet switch function.
SchedulerA scheduler function.
VideoProcessingA video processing function.

Example Response

{
    "@odata.type": "#AccelerationFunction.v1_0_0.AccelerationFunction",
    "Id": "Compression",
    "Name": "Compression Accelerator",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "FpgaReconfigurationSlots": [
        "AFU0"
    ],
    "AccelerationFunctionType": "Compression",
    "Manufacturer": "Intel (R) Corporation",
    "Version": "Green Compression Type 1 v.1.00.86",
    "PowerWatts": 15,
    "Links": {
        "Endpoints": [],
        "PCIeFunctions": []
    },
    "Oem": {},
    "@odata.id": "/redfish/v1/Systems/1/Processors/FPGA1/AccelerationFunctions/Compression"
}

AccountService 1.5.0

v1.5v1.4v1.3v1.2v1.1v1.0
2019.12018.32018.12017.12016.31.0

The AccountService schema contains properties for managing user accounts. The properties are common to all user accounts, such as password requirements, and control features such as account lockout. The schema also contains links to the collections of Manager Accounts and Roles.

URIs:

AccountLockoutCounterResetAfterinteger
(seconds)
read-writeThe interval of time in seconds between the last failed login attempt and reset of the lockout threshold counter. This value must be less than or equal to AccountLockoutDuration. Reset sets the counter to zero.
AccountLockoutCounterResetEnabled (v1.5+)booleanread-writeThe value indicates whether the threshold counter will be reset after AccountLockoutCounterResetAfter expires.
AccountLockoutDurationinteger
(seconds)
read-write (null)The time in seconds an account is locked out. The value must be greater than or equal to the value of the AccountLockoutCounterResetAfter property. If set to 0, no lockout occurs.
AccountLockoutThresholdintegerread-write (null)The number of failed login attempts allowed before a user account is locked for a specified duration. A value of 0 means it is never locked.
Accounts {objectA link to a collection of Manager Accounts.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of ManagerAccount. See the ManagerAccount schema for details.
ActiveDirectory (v1.3+) {objectThe first ActiveDirectory external account provider this AccountService supports.
      AccountProviderType (deprecated v1.5)string
(enum)
read-only (null)This property contains the type of external account provider this resource references.
See AccountProviderType in Property Details, below, for the possible values of this property. Deprecated v1.5+. This property has been Deprecated as the Account Provider type is known when used in the LDAP and ActiveDirectory objects.
      Authentication {objectThis property contains the authentication information for the external account provider.
            AuthenticationTypestring
(enum)
read-write (null)This property contains the type of authentication used to connect to the external account provider.
See AuthenticationType in Property Details, below, for the possible values of this property.
            KerberosKeytabstringread-write (null)This property is used with a PATCH or PUT to write a base64 encoded version of the kerberos keytab for the account. This property is null on a GET.
            Oem { }objectSee the OEM object definition in the Common properties section.
            Passwordstringread-write (null)This property is used with a PATCH or PUT to write the password for the account service. This property is null on a GET.
            Tokenstringread-write (null)This property is used with a PATCH or PUT to write the token for the account. This property is null on a GET.
            Username
      }
stringread-writeThis property contains the user name for the account service.
      Certificates (v1.4+) {objectThis is a reference to a collection of certificates used for the external account provider.
Contains a link to a resource.
            @odata.id
      }
stringread-onlyLink to Collection of Certificate. See the Certificate schema for details.
      LDAPService {objectThis property contains additional mapping information needed to parse a generic LDAP service.
            Oem { }objectSee the OEM object definition in the Common properties section.
            SearchSettings {objectThis property contains the settings needed to search an external LDAP service.
                  BaseDistinguishedNames [ ] array
(string, null)
read-writeThe base distinguished names to use when searching the LDAP service.
                  GroupNameAttributestringread-write (null)The attribute name that contains the name of the Group on the group LDAP entry.
                  GroupsAttributestringread-write (null)The attribute name that contains the Groups for a user on the user LDAP entry.
                  UsernameAttribute
            }
      }
stringread-write (null)The attribute name that contains the Username on the user LDAP entry.
      RemoteRoleMapping [ {arrayThis property contains a collection of the mapping rules to convert the external account providers account information to the local Redfish Role.
            LocalRolestringread-write (null)The name of the local role in which to map the remote user or group.
            Oem { }objectSee the OEM object definition in the Common properties section.
            RemoteGroupstringread-write (null)This property is the name of the remote group (or in the case of a Redfish Service, remote role) that will be mapped to the local role referenced by this entity.
            RemoteUser
      } ]
stringread-write (null)This property is the name of the remote user that will be mapped to the local role referenced by this entity.
      ServiceAddresses [ ] array
(string, null)
read-writeThis property contains the addresses of the user account providers this resource references. The format of this field depends on the Type.
      ServiceEnabled
}
booleanread-write (null)This indicates whether this service is enabled.
AdditionalExternalAccountProviders (v1.3+) {objectThe additional external account providers this AccountService is using.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of ExternalAccountProvider. See the ExternalAccountProvider schema for details.
AuthFailureLoggingThresholdintegerread-writeThe number of authorization failures allowed before the failure attempt is logged to the manager log.
LDAP (v1.3+) {objectThe first LDAP external account provider this AccountService supports.
      AccountProviderType (deprecated v1.5)string
(enum)
read-only (null)This property contains the type of external account provider this resource references.
See AccountProviderType in Property Details, below, for the possible values of this property. Deprecated v1.5+. This property has been Deprecated as the Account Provider type is known when used in the LDAP and ActiveDirectory objects.
      Authentication {objectThis property contains the authentication information for the external account provider.
            AuthenticationTypestring
(enum)
read-write (null)This property contains the type of authentication used to connect to the external account provider.
See AuthenticationType in Property Details, below, for the possible values of this property.
            KerberosKeytabstringread-write (null)This property is used with a PATCH or PUT to write a base64 encoded version of the kerberos keytab for the account. This property is null on a GET.
            Oem { }objectSee the OEM object definition in the Common properties section.
            Passwordstringread-write (null)This property is used with a PATCH or PUT to write the password for the account service. This property is null on a GET.
            Tokenstringread-write (null)This property is used with a PATCH or PUT to write the token for the account. This property is null on a GET.
            Username
      }
stringread-writeThis property contains the user name for the account service.
      Certificates (v1.4+) {objectThis is a reference to a collection of certificates used for the external account provider.
Contains a link to a resource.
            @odata.id
      }
stringread-onlyLink to Collection of Certificate. See the Certificate schema for details.
      LDAPService {objectThis property contains additional mapping information needed to parse a generic LDAP service.
            Oem { }objectSee the OEM object definition in the Common properties section.
            SearchSettings {objectThis property contains the settings needed to search an external LDAP service.
                  BaseDistinguishedNames [ ] array
(string, null)
read-writeThe base distinguished names to use when searching the LDAP service.
                  GroupNameAttributestringread-write (null)The attribute name that contains the name of the Group on the group LDAP entry.
                  GroupsAttributestringread-write (null)The attribute name that contains the Groups for a user on the user LDAP entry.
                  UsernameAttribute
            }
      }
stringread-write (null)The attribute name that contains the Username on the user LDAP entry.
      RemoteRoleMapping [ {arrayThis property contains a collection of the mapping rules to convert the external account providers account information to the local Redfish Role.
            LocalRolestringread-write (null)The name of the local role in which to map the remote user or group.
            Oem { }objectSee the OEM object definition in the Common properties section.
            RemoteGroupstringread-write (null)This property is the name of the remote group (or in the case of a Redfish Service, remote role) that will be mapped to the local role referenced by this entity.
            RemoteUser
      } ]
stringread-write (null)This property is the name of the remote user that will be mapped to the local role referenced by this entity.
      ServiceAddresses [ ] array
(string, null)
read-writeThis property contains the addresses of the user account providers this resource references. The format of this field depends on the Type.
      ServiceEnabled
}
booleanread-write (null)This indicates whether this service is enabled.
LocalAccountAuth (v1.3+)string
(enum)
read-writeControls when this service will use the accounts defined withing this AccountService as part of authentication.
See LocalAccountAuth in Property Details, below, for the possible values of this property.
MaxPasswordLengthintegerread-onlyThe maximum password length for this service.
MinPasswordLengthintegerread-onlyThe minimum password length for this service.
PrivilegeMap (v1.1+) {objectA reference to the Privilege mapping that defines the privileges needed to perform a requested operation on a URI associated with this service.
See the PrivilegeRegistry schema for details on this property.
      @odata.id
}
stringread-onlyLink to a PrivilegeRegistry resource. See the Links section and the PrivilegeRegistry schema for details.
Roles {objectA link to a collection of Roles.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of Role. See the Role schema for details.
ServiceEnabledbooleanread-write (null)Indicates whether this service is enabled. If set to false, the AccountService is disabled. This means no users can be created, deleted or modified. Any service attempting to access the AccountService resource (for example, the Session Service) will fail. New sessions cannot be started when the service is disabled. However, established sessions may still continue operating. This does not affect Basic AUTH connections.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.

Property Details

AccountProviderType:

This property contains the type of external account provider this resource references.

stringDescription
ActiveDirectoryServiceAn external Active Directory Service.
LDAPServiceA generic external LDAP Service.
OEMAn OEM specific external authentication or directory service.
RedfishServiceAn external Redfish Service.

AuthenticationType:

This property contains the type of authentication used to connect to the external account provider.

stringDescription
KerberosKeytabA kerberos keytab.
OEMAn OEM specific authentication mechanism.
TokenAn opaque authentication token.
UsernameAndPasswordUsername and password combination.

LocalAccountAuth:

Controls when this service will use the accounts defined withing this AccountService as part of authentication.

stringDescription
DisabledAuthentication via accounts defined in this AccountService is disabled.
EnabledAuthentication via accounts defined in this AccountService is enabled.
FallbackAuthentication via accounts defined in this AccountService is only used if there are external account providers that are currently unreachable.

Example Response

{
    "@odata.type": "#AccountService.v1_3_1.AccountService",
    "Id": "AccountService",
    "Name": "Account Service",
    "Description": "Local Manager Account Service",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "ServiceEnabled": true,
    "AuthFailureLoggingThreshold": 3,
    "MinPasswordLength": 8,
    "AccountLockoutThreshold": 5,
    "AccountLockoutDuration": 30,
    "AccountLockoutCounterResetAfter": 30,
    "Accounts": {
        "@odata.id": "/redfish/v1/AccountService/Accounts"
    },
    "Roles": {
        "@odata.id": "/redfish/v1/AccountService/Roles"
    },
    "LocalAccountAuth": "Enabled",
    "LDAP": {
        "AccountProviderType": "LDAPService",
        "ServiceEnabled": false,
        "ServiceAddresses": [
            "ldaps://ldap.example.org:636"
        ],
        "Authentication": {
            "AuthenticationType": "UsernameAndPassword",
            "Username": "cn=Manager,dc=example,dc=org",
            "Password": null
        },
        "LDAPService": {
            "SearchSettings": {
                "BaseDistinguishedNames": [
                    "dc=example,dc=org"
                ],
                "UsernameAttribute": "uid",
                "GroupsAttribute": "memberof"
            }
        },
        "RemoteRoleMapping": [
            {
                "RemoteUser": "cn=Manager,dc=example,dc=org",
                "LocalRole": "Administrator"
            },
            {
                "RemoteGroup": "cn=Admins,ou=Groups,dc=example,dc=org",
                "LocalRole": "Administrator"
            },
            {
                "RemoteGroup": "cn=PowerUsers,ou=Groups,dc=example,dc=org",
                "LocalRole": "Operator"
            },
            {
                "RemoteGroup": "(cn=*)",
                "LocalRole": "ReadOnly"
            }
        ]
    },
    "ActiveDirectory": {
        "AccountProviderType": "ActiveDirectoryService",
        "ServiceEnabled": true,
        "ServiceAddresses": [
            "ad1.example.org",
            "ad2.example.org",
            null,
            null
        ],
        "Authentication": {
            "AuthenticationType": "KerberosKeytab",
            "KerberosKeytab": null
        },
        "RemoteRoleMapping": [
            {
                "RemoteGroup": "Administrators",
                "LocalRole": "Administrator"
            },
            {
                "RemoteUser": "DOMAIN\\Bob",
                "LocalRole": "Operator"
            },
            {
                "RemoteGroup": "PowerUsers",
                "LocalRole": "Operator"
            },
            {
                "RemoteGroup": "Everybody",
                "LocalRole": "ReadOnly"
            }
        ]
    },
    "AdditionalExternalAccountProviders": {
        "@odata.id": "/redfish/v1/AccountService/ExternalAccountProviders"
    },
    "@odata.context": "/redfish/v1/$metadata#AccountService.AccountService",
    "@odata.id": "/redfish/v1/AccountService"
}

ActionInfo 1.1.1

v1.1v1.0
2018.22016.2

The ActionInfo schema describes the parameters and other information necessary to perform a Redfish Action on a particular Action target. Parameter support can differ between vendors and even between instances of a resource. This data can be used to ensure Action requests from applications contain supported parameters.

Parameters [ {arrayThe parameters associated with the specified Redfish Action.
      AllowableValues [ ] array
(string, null)
read-onlyA list of values for this parameter supported by this Action target.
      DataTypestring
(enum)
read-only (null)The JSON property type used for this parameter.
See DataType in Property Details, below, for the possible values of this property.
      MaximumValue (v1.1+)numberread-only (null)The maximum supported value of this parameter.
      MinimumValue (v1.1+)numberread-only (null)The minimum supported value for this parameter.
      Namestringread-only requiredThe name of the parameter for this Action.
      ObjectDataTypestringread-only (null)The OData Type of an object-based parameter.
      Required
} ]
booleanread-onlyIndicates whether the parameter is required to perform this Action.

Property Details

DataType:

The JSON property type used for this parameter.

stringDescription
BooleanA boolean (true or false).
NumberA number.
NumberArrayAn array of numbers.
ObjectAn embedded JSON object.
ObjectArrayAn array of JSON objects.
StringA string.
StringArrayAn array of strings.

Example Response

{
    "@odata.type": "#ActionInfo.v1_1_0.ActionInfo",
    "Id": "ResetActionInfo",
    "Name": "Reset Action Info",
    "Parameters": [
        {
            "Name": "ResetType",
            "Required": true,
            "DataType": "String",
            "AllowableValues": [
                "On",
                "ForceOff",
                "GracefulShutdown",
                "GracefulRestart",
                "ForceRestart",
                "Nmi",
                "ForceOn",
                "PushPowerButton"
            ]
        }
    ],
    "Oem": {},
    "@odata.context": "/redfish/v1/$metadata#ActionInfo.ActionInfo",
    "@odata.id": "/redfish/v1/Systems/1/ResetActionInfo"
}

Assembly 1.2.1

v1.2v1.1v1.0
2018.22018.12017.3

This is the schema definition for the Assembly properties.

URIs:

Assemblies [ {arrayThis is the definition for an assembly information record.
      @odata.id (v1.2+)stringread-only requiredThe unique identifier for a resource.
      Actions { }objectThe available actions for this resource.
      BinaryDataURIstringread-only (null)URI that provides the ability to access an image of the assembly information.
      Descriptionstringread-only (null)Description of the Assembly.
      EngineeringChangeLevelstringread-only (null)Engineering change level of the Assembly.
      MemberIdstringread-only requiredThis is the identifier for the member within the collection.
      Modelstringread-only (null)Model number of the Assembly.
      Namestringread-only (null)Name of the Assembly.
      Oem { }objectSee the OEM object definition in the Common properties section.
      PartNumberstringread-only (null)Part number of the Assembly.
      PhysicalContext (v1.2+)string
(enum)
read-onlyDescribes the area or device to which this assembly data applies.
See PhysicalContext in Property Details, below, for the possible values of this property.
      Producerstringread-only (null)Producer or manufacturer of the Assembly.
      ProductionDatestringread-only (null)Production date of the Assembly.
      SerialNumber (v1.2+)stringread-only (null)The serial number of this assembly.
      SKUstringread-only (null)SKU of the Assembly.
      SparePartNumberstringread-only (null)Spare part number of the Assembly.
      Status (v1.1+) { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
      Vendorstringread-only (null)Vendor of the Assembly.
      Version
} ]
stringread-only (null)Version of the Assembly.

Property Details

PhysicalContext:

Describes the area or device to which this assembly data applies.

stringDescription
AcceleratorAn Accelerator.
ACInputAn AC Input.
ACMaintenanceBypassInputAn AC Maintenance Bypass Input.
ACOutputAn AC Output.
ACStaticBypassInputAn AC Static Bypass Input.
ACUtilityInputAn AC Utility Input.
ASICAn ASIC device, such as networking chip or a chipset component.
BackThe back of the chassis.
BackplaneA backplane within the chassis.
ChassisThe entire chassis.
ComputeBayWithin a compute bay.
CoolingSubsystemThe entire cooling (air and liquid) subsystem.
CPUA Processor (CPU).
CPUSubsystemThe entire Processor (CPU) subsystem.
DCBusA DC Bus.
ExhaustThe air exhaust point(s) or region of the chassis.
ExpansionBayWithin an expansion bay.
FanA fan.
FPGAA Field Programmable Gate Array (FPGA).
FrontThe front of the chassis.
GPUA Graphics Processor (GPU).
GPUSubsystemThe entire Graphics Processor (GPU) subsystem.
IntakeThe air intake point(s) or region of the chassis.
LiquidInletThe liquid inlet point of the chassis.
LiquidOutletThe liquid outlet point of the chassis.
LowerThe lower portion of the chassis.
MemoryA memory device.
MemorySubsystemThe entire Memory subsystem.
MotorA motor.
NetworkBayWithin a networking bay.
NetworkingDeviceA networking device.
PowerSubsystemThe entire power subsystem.
PowerSupplyA power supply.
PowerSupplyBayWithin a power supply bay.
RectifierA rectifier device.
RoomThe room.
StorageBayWithin a storage bay.
StorageDeviceA storage device.
SystemBoardThe system board (PCB).
TransformerA Transformer.
UpperThe upper portion of the chassis.
VoltageRegulatorA voltage regulator device.

Example Response

{
    "@odata.type": "#Assembly.v1_2_0.Assembly",
    "Id": "Assembly",
    "Name": "System-related Assembly data",
    "Assemblies": [
        {
            "@odata.id": "/redfish/v1/Chassis/1/Assembly#/Assemblies/0",
            "MemberId": "0",
            "Name": "System Board",
            "Description": "PCA System Board",
            "Model": "345TTT",
            "PartNumber": "923943",
            "SparePartNumber": "55-434",
            "SKU": "55ZZATR",
            "SerialNumber": "345394834",
            "Vendor": "Contoso",
            "ProductionDate": "2017-04-01T14:55:33+03:00",
            "Producer": "Contoso Supply Co.",
            "Version": "1.44B",
            "EngineeringChangeLevel": "9",
            "BinaryDataURI": "/dumpster/434",
            "Oem": {
                "Contoso": {
                    "Region": "C",
                    "Packaging": "Retail"
                }
            }
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/Assembly#/Assemblies/1",
            "MemberId": "1",
            "Name": "Fan Controller",
            "Description": "PCA Fan Controller",
            "Model": "F58AS",
            "PartNumber": "3434-149",
            "Vendor": "Contoso",
            "Version": "2.4.481",
            "BinaryDataURI": "/dumpster/422",
            "Status": {
                "State": "Enabled",
                "Health": "Warning"
            }
        }
    ],
    "@odata.id": "/redfish/v1/Chassis/1/Assembly"
}

AttributeRegistry 1.3.1

v1.3v1.2v1.1v1.0
2018.32018.12017.12016.1

The AttributeRegistry schema contains a set of key-value pairs that represents the structure of a Registry. It includes mechanisms for building user interfaces (menus), allowing consistent navigation of the contents. The Attribute Registry is specific to a particular implementation or product. The attributes and property names are not standardized.

Languagestringread-only requiredThis is the RFC 5646 compliant language code for the registry.
OwningEntitystringread-only requiredThis is the organization or company that publishes this registry.
RegistryEntries {objectList of all attributes and their metadata for this component.
      Attributes [ {arrayThe array containing the attributes and their possible values.
            AttributeNamestringread-only requiredThe unique name of the attribute.
            CurrentValuestring, boolean, numberread-only (null)Placeholder of the current value of the attribute.
            DefaultValuestring, boolean, numberread-only (null)The default current value of the attribute.
            DisplayNamestringread-only (null)The user-readable display string of the attribute in the defined 'Language'.
            DisplayOrderintegerread-only (null)The numeric value describing the ascending order that the attribute is displayed relative to other attributes.
            GrayOutbooleanread-only (null)The gray-out state of this attribute.
            HelpTextstringread-only (null)The help text for the attribute.
            Hiddenbooleanread-only (null)The hidden state of this attribute.
            Immutablebooleanread-only (null)Defines whether this attribute is immutable or not.
            IsSystemUniquePropertybooleanread-only (null)Defines whether this attribute is unique for this system and should not be replicated.
            LowerBoundintegerread-only (null)The lower limit of the value of an attribute of type 'Integer'.
            MaxLengthintegerread-only (null)The maximum character length of the value of an attribute of type 'String'.
            MenuPathstringread-only (null)A path that describes the menu hierarchy of this attribute.
            MinLengthintegerread-only (null)The minimum character length of the value of an attribute of type 'String'.
            Oem (v1.3+) { }objectSee the OEM object definition in the Common properties section.
            ReadOnlybooleanread-only (null)The read-only state of this attribute.
            ResetRequired (v1.2+)booleanread-only (null)True if changing the value of this attribute requires a system or device reset in order to take effect.
            ScalarIncrementintegerread-only (null)The amount to increment or decrement the value of an attribute of type 'Integer' each time a user requests a value change.
            Typestring
(enum)
read-onlyThe type of the attribute.
See Type in Property Details, below, for the possible values of this property.
            UefiDevicePath (v1.2+)stringread-only (null)The UEFI device path that qualifies this attribute.
            UefiKeywordName (v1.2+)stringread-onlyThe UEFI KeywordString of the attribute.
            UefiNamespaceId (v1.2+)stringread-onlyThe UEFI NamespaceId of the attribute.
            UpperBoundintegerread-only (null)The upper limit of the value of an attribute of type 'Integer'.
            Value [ {arrayThe array containing possible values for attributes of type 'Enumeration'.
                  ValueDisplayNamestringread-only (null)A user-readable display string of the value of the attribute in the defined 'Language'.
                  ValueName
            } ]
stringread-only requiredThe unique value name of the attribute.
            ValueExpressionstringread-only (null)A regular expression that is used to validate the value of the attribute. This is only applicable to attributes of type 'String' or 'Integer'.
            WarningTextstringread-only (null)The warning text for changing the attribute.
            WriteOnly
      } ]
booleanread-only (null)Defines whether this attribute is write-only. Such attributes revert back to their initial value after settings are applied.
      Dependencies [ {arrayThe array containing a list of dependencies of attributes on this component.
            Dependency {objectThe dependency expression for one or more Attributes in this Attribute Registry.
                  MapFrom [ {arrayArray of the map-from conditions for mapping dependency.
                        MapFromAttributestringread-onlyThe attribute that is used to evaluate this dependency expression.
                        MapFromConditionstring
(enum)
read-onlyThe condition that is used to evaluate this dependency expression.
See MapFromCondition in Property Details, below, for the possible values of this property.
                        MapFromPropertystring
(enum)
read-onlyThe meta-data property of the attribute specified in MapFromAttribute that is used to evaluate this dependency expression.
See MapFromProperty in Property Details, below, for the possible values of this property.
                        MapFromValuestring, boolean, numberread-only (null)The value that the is used property specified in MapFromProperty that is used to evaluate this dependency expression.
                        MapTerms
                  } ]
string
(enum)
read-onlyThe logical term used to combine two or more MapFrom conditions in this dependency expression.
See MapTerms in Property Details, below, for the possible values of this property.
                  MapToAttributestringread-onlyThe Name of the attribute that is affected by this dependency expression.
                  MapToPropertystring
(enum)
read-onlyThe meta-data property of the attribute specified in MapFromAttribute that is used to evaluate this dependency expression.
See MapToProperty in Property Details, below, for the possible values of this property.
                  MapToValue
            }
string, boolean, numberread-only (null)The value that MapToProperty is changed to if the dependency expression evaluates to true.
            DependencyForstringread-onlyThe AttributeName of the attribute whose change triggers the evaluation of this dependency expression.
            Type
      } ]
string
(enum)
read-onlyThe type of the dependency structure.
See Type in Property Details, below, for the possible values of this property.
      Menus [ {arrayThe array containing the attributes menus and their hierarchy.
            DisplayNamestringread-only (null)The user-readable display string of this menu in the defined 'Language'.
            DisplayOrderintegerread-only (null)The numeric value describing the ascending order in which this menu is displayed relative to other menus.
            GrayOutbooleanread-only (null)The gray-out state of this menu. A grayed-only menu is not accessible in user interfaces.
            Hidden (v1.3+)booleanread-only (null)The hidden state of this menu.
            MenuNamestringread-onlyThe unique name string of this menu.
            MenuPathstringread-only (null)A path that describes this menu hierarchy relative to other menus.
            Oem (v1.3+) { }objectSee the OEM object definition in the Common properties section.
            ReadOnly
      } ]
}
booleanread-only (null)The read-only state of this menu.
RegistryVersionstringread-only requiredThis is the attribute registry version which is used in the middle portion of a AttributeRegistry.
SupportedSystems [ {arrayArray of systems supported by this attribute registry.
      FirmwareVersion (v1.1+)stringread-only (null)Firmware version.
      ProductNamestringread-only (null)The product name of the system.
      SystemId
} ]
stringread-only (null)The system ID of the system.

Property Details

MapFromCondition:

The condition that is used to evaluate this dependency expression.

stringDescription
EQUThe logical operation for 'Equal'.
GEQThe logical operation for 'Greater than or Equal'.
GTRThe logical operation for 'Greater than'.
LEQThe logical operation for 'Less than or Equal'.
LSSThe logical operation for 'Less than'.
NEQThe logical operation for 'Not Equal'.

MapFromProperty:

The meta-data property of the attribute specified in MapFromAttribute that is used to evaluate this dependency expression.

stringDescription
CurrentValueThe dependency on an attribute's CurrentValue.
DefaultValueThe dependency on an attribute's DefaultValue.
GrayOutThe dependency on an attribute's GrayOut state.
HiddenThe dependency on an attribute's Hidden state.
LowerBoundThe dependency on an attribute's LowerBound.
MaxLengthThe dependency on an attribute's MaxLength.
MinLengthThe dependency on an attribute's MinLength.
ReadOnlyThe dependency on an attribute's ReadOnly state.
ScalarIncrementThe dependency on an attribute's ScalarIncrement.
UpperBoundThe dependency on an attribute's UpperBound.
WriteOnlyThe dependency on an attribute's WriteOnly state.

MapTerms:

The logical term used to combine two or more MapFrom conditions in this dependency expression.

stringDescription
ANDThe operation used for logical 'AND' of dependency terms.
ORThe operation used for logical 'OR' of dependency terms.

MapToProperty:

The meta-data property of the attribute specified in MapFromAttribute that is used to evaluate this dependency expression.

stringDescription
CurrentValueThe dependency that affects an attribute's CurrentValue.
DefaultValueThe dependency that affects an attribute's DefaultValue.
DisplayNameThe dependency that affects an attribute's DisplayName.
DisplayOrderThe dependency that affects an attribute's DisplayName.
GrayOutThe dependency that affects an attribute's GrayOut state.
HelpTextThe dependency that affects an attribute's HelpText.
HiddenThe dependency that affects an attribute's Hidden state.
ImmutableThe dependency that affects an attribute's Immutable state.
LowerBoundThe dependency that affects an attribute's LowerBound.
MaxLengthThe dependency that affects an attribute's MaxLength.
MinLengthThe dependency that affects an attribute's MinLength.
ReadOnlyThe dependency that affects an attribute's ReadOnly state.
ScalarIncrementThe dependency that affects an attribute's ScalarIncrement.
UpperBoundThe dependency that affects an attribute's UpperBound.
ValueExpressionThe dependency that affects an attribute's ValueExpression.
WarningTextThe dependency that affects an attribute's WarningText.
WriteOnlyThe dependency that affects an attribute's WriteOnly state.

Type:

The type of the dependency structure.

stringDescription
MapA simple mapping dependency. The attribute value or state is changed to the mapped value if the condition evaluates to true.

Example Response

{
    "@odata.type": "#AttributeRegistry.v1_1_0.AttributeRegistry",
    "Description": "This registry defines a representation of BIOS Attribute instances",
    "Id": "BiosAttributeRegistryG9000.v1_0_0",
    "Language": "en",
    "Name": "G9000 BIOS Attribute Registry",
    "OwningEntity": "Contoso",
    "RegistryVersion": "1.0.0",
    "SupportedSystems": [{
        "ProductName": "Contoso Server GLH9000",
        "SystemId": "G9000",
        "FirmwareVersion": "v1.00 (06/02/2014)"
    }],
    "RegistryEntries": {
        "Attributes": [{
                "CurrentValue": null,
                "DisplayName": "Embedded NIC 1 Boot",
                "DisplayOrder": 5,
                "HelpText": "Select this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You may need to configure the NIC firmware for the boot option to be active.",
                "MenuPath": "./SystemOptions/NetworkBootOptions",
                "AttributeName": "NicBoot1",
                "ReadOnly": false,
                "Hidden": false,
                "Type": "Enumeration",
                "Value": [{
                        "ValueDisplayName": "Network Boot",
                        "ValueName": "NetworkBoot"
                    },
                    {
                        "ValueDisplayName": "Disabled",
                        "ValueName": "Disabled"
                    }
                ],
                "WarningText": "Important: When enabling network boot support for an embedded NIC, the NIC boot option does not appear in the UEFI Boot Order or Legacy IPL lists until the next system reboot."
            },
            {
                "CurrentValue": null,
                "DisplayName": "Embedded SATA Configuration",
                "DisplayOrder": 74,
                "HelpText": "Important: Select this option to configure the embedded chipset SATA controller.",
                "MenuPath": "./SystemOptions/SataOptions",
                "AttributeName": "EmbeddedSata",
                "ReadOnly": false,
                "Hidden": false,
                "Type": "Enumeration",
                "Value": [{
                        "ValueDisplayName": "Enable SATA AHCI Support",
                        "ValueName": "Ahci"
                    },
                    {
                        "ValueDisplayName": "Enable Software RAID Support",
                        "ValueName": "Raid"
                    }
                ],
                "WarningText": "Important: Software RAID is not supported when the Boot Mode is configured in Legacy BIOS Mode."
            }
        ],
        "Dependencies": [{
            "Dependency": {
                "MapFrom": [{
                    "MapFromAttribute": "BootMode",
                    "MapFromCondition": "EQU",
                    "MapFromProperty": "CurrentValue",
                    "MapFromValue": "LegacyBios"
                }],
                "MapToAttribute": "EmbeddedSata",
                "MapToProperty": "ReadOnly",
                "MapToValue": true
            },
            "DependencyFor": "EmbeddedSata",
            "Type": "Map"
        }],
        "Menus": [{
                "DisplayName": "BIOS Configuration",
                "DisplayOrder": 1,
                "MenuPath": "./",
                "MenuName": "BiosMainMenu",
                "Hidden": false,
                "ReadOnly": false
            },
            {
                "DisplayName": "System Options",
                "DisplayOrder": 2,
                "MenuPath": "./SystemOptions",
                "MenuName": "SystemOptions",
                "Hidden": false,
                "ReadOnly": false
            }
        ]
    }
}

Bios 1.0.6

v1.0
2016.1

The Bios schema contains properties related to the BIOS Attribute Registry. The Attribute Registry describes the system-specific BIOS attributes and Actions for changing to BIOS settings. Changes to the BIOS typically require a system reset before they take effect. It is likely that a client will find the @Redfish.Settings term in this resource, and if it is found, the client makes requests to change BIOS settings by modifying the resource identified by the @Redfish.Settings term.

URIs:

AttributeRegistrystringread-only (null)The Resource ID of the Attribute Registry that has the system-specific information about a BIOS resource.
Attributes {objectThe list of BIOS attributes specific to the manufacturer or provider.
      (pattern) { } [ ] array, boolean, integer, number, object, string (null)Property names follow regular expression pattern "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$"
      (pattern)
}
string, boolean, numberread-write (null)Property names follow regular expression pattern "^[A-Za-z][A-Za-z0-9_]+$"

Actions

ChangePassword

This action is used to change the BIOS passwords.

URIs:

The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.

{
      NewPasswordstringread-write requiredThe value of the new BIOS password.
      OldPasswordstringread-write requiredThe value of the existing password.
      PasswordName
}
stringread-write requiredThe name of the BIOS password to change.

ResetBios

This action is used to reset the BIOS attributes to default.

URIs:

(This action takes no parameters.)

Example Response

{
    "@odata.type": "#Bios.v1_0_4.Bios",
    "Id": "BIOS",
    "Name": "BIOS Configuration Current Settings",
    "AttributeRegistry": "BiosAttributeRegistryP89.v1_0_0",
    "Attributes": {
        "AdminPhone": "",
        "BootMode": "Uefi",
        "EmbeddedSata": "Raid",
        "NicBoot1": "NetworkBoot",
        "NicBoot2": "Disabled",
        "PowerProfile": "MaxPerf",
        "ProcCoreDisable": 0,
        "ProcHyperthreading": "Enabled",
        "ProcTurboMode": "Enabled",
        "UsbControl": "UsbEnabled"
    },
    "@Redfish.Settings": {
        "@odata.type": "#Settings.v1_0_0.Settings",
        "ETag": "9234ac83b9700123cc32",
        "Messages": [
            {
                "MessageId": "Base.1.0.SettingsFailed",
                "RelatedProperties": [
                    "#/Attributes/ProcTurboMode"
                ]
            }
        ],
        "SettingsObject": {
            "@odata.id": "/redfish/v1/Systems/437XR1138R2/BIOS/Settings"
        },
        "Time": "2016-03-07T14:44.30-05:00"
    },
    "Actions": {
        "#Bios.ResetBios": {
            "target": "/redfish/v1/Systems/437XR1138R2/BIOS/Actions/Bios.ResetBios"
        },
        "#Bios.ChangePassword": {
            "target": "/redfish/v1/Systems/437XR1138R2/BIOS/Actions/Bios.ChangePassword"
        }
    },
    "@odata.context": "/redfish/v1/$metadata#Bios.Bios",
    "@odata.id": "/redfish/v1/Systems/437XR1138R2/BIOS"
}

BootOption 1.0.2

v1.0
2017.3

This is the schema definition for the BootOption resource. It represents the properties of a bootable device available in the System.

URIs:

Aliasstring
(enum)
read-only (null)The alias of this Boot Source.
See Alias in Property Details, below, for the possible values of this property.
BootOptionEnabledbooleanread-write (null)A flag that shows if the Boot Option is enabled.
BootOptionReferencestringread-only required (null)The unique boot option string that is referenced in the BootOrder.
DisplayNamestringread-only (null)The user-readable display string of the Boot Option.
RelatedItem [ {arrayThe ID(s) of the resources associated with this Boot Option.
      @odata.id
} ]
stringread-onlyThe unique identifier for a resource.
UefiDevicePathstringread-only (null)The UEFI device path used to access this UEFI Boot Option.

Property Details

Alias:

The alias of this Boot Source.

stringDescription
BiosSetupBoot to the BIOS Setup Utility.
CdBoot from the CD/DVD disc.
DiagsBoot the manufacturer's Diagnostics program.
FloppyBoot from the floppy disk drive.
HddBoot from a hard drive.
NoneBoot from the normal boot device.
PxeBoot from the Pre-Boot EXecution (PXE) environment.
RemoteDriveBoot from a remote drive (e.g. iSCSI).
SDCardBoot from an SD Card.
UefiBootNextBoot to the UEFI Device specified in the BootNext property.
UefiHttpBoot from a UEFI HTTP network location.
UefiShellBoot to the UEFI Shell.
UefiTargetBoot to the UEFI Device specified in the UefiTargetBootSourceOverride property.
UsbBoot from a USB device as specified by the system BIOS.
UtilitiesBoot the manufacturer's Utilities program(s).

Example Response

{
    "@odata.context": "/redfish/v1/$metadata#BootOption.BootOption",
    "@odata.id": "/redfish/v1/Systems/1/BootOptions/1",
    "@odata.type": "#BootOption.v1_0_0.BootOption",
    "Id": "1",
    "Name": "Boot Option",
    "Description": "UEFI Boot Option",
    "BootOptionReference": "Boot0000",
    "DisplayName": "Windows Boot Manager",
    "UefiDevicePath": "PciRoot(0x0)/Pci(0x1,0x0)/Pci(0x0,0x0)/Scsi(0x0,0x0)/HD(2,GPT,B02BF459-8975-4222-A1C4-17915C29E5E5,0x96800,0x31800)/\\EFI\\Microsoft\\Boot\\bootmgfw.efi",
    "Alias": "Hdd",
    "RelatedItem": [
        {
            "@odata.id": "/redfish/v1/Systems/1/SimpleStorage/1"
        }
    ],
    "Oem": {}
}

Certificate 1.1.0

v1.1v1.0
2019.12018.3

The Certificate resource describes a certificate used to prove the identify of a component, account, or service.

URIs:

CertificateStringstringread-only required on create (null)The string for the certificate.
CertificateTypestring
(enum)
read-only required on create (null)The format of the certificate.
See CertificateType in Property Details, below, for the possible values of this property.
Issuer {objectThe issuer of the certificate.
      Citystringread-onlyThe city or locality of the organization of the entity.
      CommonNamestringread-onlyThe fully qualified domain name of the entity.
      Countrystringread-onlyThe country of the organization of the entity.
      Emailstringread-only (null)The email address of the contact within the organization of the entity.
      Organizationstringread-onlyThe name of the organization of the entity.
      OrganizationalUnitstringread-onlyThe name of the unit or division of the organization of the entity.
      State
}
stringread-onlyThe state, province, or region of the organization of the entity.
KeyUsage [ ] array (string
(enum))
read-only (null)The usage of the key contained in the certificate. The usages of a key contained within a certificate.
See KeyUsage in Property Details, below, for the possible values of this property.
Subject {objectThe subject of the certificate.
      Citystringread-onlyThe city or locality of the organization of the entity.
      CommonNamestringread-onlyThe fully qualified domain name of the entity.
      Countrystringread-onlyThe country of the organization of the entity.
      Emailstringread-only (null)The email address of the contact within the organization of the entity.
      Organizationstringread-onlyThe name of the organization of the entity.
      OrganizationalUnitstringread-onlyThe name of the unit or division of the organization of the entity.
      State
}
stringread-onlyThe state, province, or region of the organization of the entity.
ValidNotAfterstringread-onlyThe date when the certificate is no longer valid.
ValidNotBeforestringread-onlyThe date when the certificate becomes valid.

Actions

Rekey

This action is used to generate a new key pair for an existing certificate and produce a certificate signing request.

URIs:

The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.

{
      ChallengePasswordstringread-writeThe challenge password to be applied to the certificate for revocation requests.
      KeyBitLengthintegerread-writeThe length of the key in bits, if needed based on the value of the 'KeyPairAlgorithm' parameter.
      KeyCurveIdstringread-writeThe curve ID to be used with the key, if needed based on the value of the 'KeyPairAlgorithm' parameter.
      KeyPairAlgorithm
}
stringread-writeThe type of key pair for use with signing algorithms.

Renew

This action is used to generate a certificate signing request using the existing information and key pair of the certificate.

URIs:

The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.

{
      ChallengePassword
}
stringread-writeThe challenge password to be applied to the certificate for revocation requests.

Property Details

CertificateType:

The format of the certificate.

stringDescription
PEMA PEM encoded certificate.
PKCS7A PEM encoded PKCS7 certificate.

KeyUsage:

The usage of the key contained in the certificate. The usages of a key contained within a certificate.

stringDescription
ClientAuthenticationThe public key is used for TLS WWW client authentication.
CodeSigningThe public key is used for the signing of executable code.
CRLSigningThe public key is used for verifying signatures on certificate revocation lists (CLRs).
DataEnciphermentThe public key is used for directly enciphering raw user data without the use of an intermediate symmetric cipher.
DecipherOnlyThe public key could be used for deciphering data while performing key agreement.
DigitalSignatureThe public key is used for verifying digital signatures, other than signatures on certificates and CRLs.
EmailProtectionThe public key is used for email protection.
EncipherOnlyThe public key could be used for enciphering data while performing key agreement.
KeyAgreementThe public key is used for key agreement.
KeyCertSignThe public key is used for verifying signatures on public key certificates.
KeyEnciphermentThe public key is used for enciphering private or secret keys.
NonRepudiationThe public key is used to verify digital signatures, other than signatures on certificates and CRLs, and used to provide a non-repudiation service that protects against the signing entity falsely denying some action.
OCSPSigningThe public key is used for signing OCSP responses.
ServerAuthenticationThe public key is used for TLS WWW server authentication.
TimestampingThe public key is used for binding the hash of an object to a time.

Example Response

{
    "@odata.type": "#Certificate.v1_0_0.Certificate",
    "Id": "1",
    "Name": "HTTPS Certificate",
    "CertificateString": "-----BEGIN CERTIFICATE-----\nMIIFsTCC [**truncated example**] GXG5zljlu\n-----END CERTIFICATE-----",
    "CertificateType": "PEM",
    "Issuer": {
        "Country": "US",
        "State": "Oregon",
        "City": "Portland",
        "Organization": "Contoso",
        "OrganizationalUnit": "ABC",
        "CommonName": "manager.contoso.org"
    },
    "Subject": {
        "Country": "US",
        "State": "Oregon",
        "City": "Portland",
        "Organization": "Contoso",
        "OrganizationalUnit": "ABC",
        "CommonName": "manager.contoso.org"
    },
    "ValidNotBefore": "2018-09-07T13:22:05Z",
    "ValidNotAfter": "2019-09-07T13:22:05Z",
    "KeyUsage": [
        "KeyEncipherment",
        "ServerAuthentication"
    ],
    "Oem": {},
    "@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates/1"
}

CertificateLocations 1.0.1

v1.0
2018.3

The CertificateLocations schema defines a resource that an administrator can use in order to locate all certificates installed on a given service.

URIs:

Links {objectContains references to other resources that are related to this resource.
      Certificates [ {arrayThis property is an array of references to the certificates installed on this service.
            @odata.id
      } ]
stringread-onlyLink to a Certificate resource. See the Links section and the Certificate schema for details.
      Oem { }
}
objectSee the OEM object definition in the Common properties section.

Example Response

{
    "@odata.type": "#CertificateLocations.v1_0_0.CertificateLocations",
    "Id": "CertificateLocations",
    "Name": "Certificate Locations",
    "Links": {
        "Certificates": [
            {
                "@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates/1"
            }
        ]
    },
    "Oem": {},
    "@odata.id": "/redfish/v1/CertificateService/CertificateLocations"
}

CertificateService 1.0.1

v1.0
2018.3

The CertificateService schema defines a Certificate Service which represents the actions available to manage certificates and links to where certificates are installed.

URIs:

CertificateLocations {objectInformation regarding the location of certificates.
See the CertificateLocations schema for details on this property.
      @odata.id
}
stringread-onlyLink to a CertificateLocations resource. See the Links section and the CertificateLocations schema for details.

Actions

GenerateCSR

This action is used to perform a certificate signing request.

URIs:

The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.

{
      AlternativeNames [ ] array
(string)
read-writeAdditional hostnames of the component that is being secured.
      CertificateCollection {objectA link to the certificate collection where the certificate will be installed.
Contains a link to a resource.
            @odata.id
      }
stringread-onlyLink to Collection of Certificate. See the Certificate schema for details.
      ChallengePasswordstringread-writeThe challenge password to be applied to the certificate for revocation requests.
      Citystringread-write requiredThe city or locality of the organization making the request.
      CommonNamestringread-write requiredThe fully qualified domain name of the component that is being secured.
      ContactPersonstringread-writeThe name of the user making the request.
      Countrystringread-write requiredThe country of the organization making the request.
      Emailstringread-writeThe email address of the contact within the organization making the request.
      GivenNamestringread-writeThe given name of the user making the request.
      Initialsstringread-writeThe initials of the user making the request.
      KeyBitLengthintegerread-writeThe length of the key in bits, if needed based on the value of the 'KeyPairAlgorithm' parameter.
      KeyCurveIdstringread-writeThe curve ID to be used with the key, if needed based on the value of the 'KeyPairAlgorithm' parameter.
      KeyPairAlgorithmstringread-writeThe type of key pair for use with signing algorithms.
      KeyUsage [ ] array (string
(enum))
read-writeThe usage of the key contained in the certificate. The usages of a key contained within a certificate.
See KeyUsage in Property Details, below, for the possible values of this property.
      Organizationstringread-write requiredThe name of the organization making the request.
      OrganizationalUnitstringread-write requiredThe name of the unit or division of the organization making the request.
      Statestringread-write requiredThe state, province, or region of the organization making the request.
      Surnamestringread-writeThe surname of the user making the request.
      UnstructuredName
}
stringread-writeThe unstructured name of the subject.

ReplaceCertificate

This action is used to replace an existing certificate.

URIs:

The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.

{
      CertificateStringstringread-write requiredThe string for the certificate.
      CertificateTypestring
(enum)
read-writeThe format of the certificate.
See CertificateType in Property Details, below, for the possible values of this property.
      CertificateUri {objectA link to the certificate that is being replaced.
See the Certificate schema for details on this property.
            @odata.id
      }
}
stringread-onlyLink to a Certificate resource. See the Links section and the Certificate schema for details.

Property Details

CertificateType:

The format of the certificate.

stringDescription
PEMA PEM encoded certificate.
PKCS7A PEM encoded PKCS7 certificate.

KeyUsage:

The usage of the key contained in the certificate. The usages of a key contained within a certificate.

stringDescription
ClientAuthenticationThe public key is used for TLS WWW client authentication.
CodeSigningThe public key is used for the signing of executable code.
CRLSigningThe public key is used for verifying signatures on certificate revocation lists (CLRs).
DataEnciphermentThe public key is used for directly enciphering raw user data without the use of an intermediate symmetric cipher.
DecipherOnlyThe public key could be used for deciphering data while performing key agreement.
DigitalSignatureThe public key is used for verifying digital signatures, other than signatures on certificates and CRLs.
EmailProtectionThe public key is used for email protection.
EncipherOnlyThe public key could be used for enciphering data while performing key agreement.
KeyAgreementThe public key is used for key agreement.
KeyCertSignThe public key is used for verifying signatures on public key certificates.
KeyEnciphermentThe public key is used for enciphering private or secret keys.
NonRepudiationThe public key is used to verify digital signatures, other than signatures on certificates and CRLs, and used to provide a non-repudiation service that protects against the signing entity falsely denying some action.
OCSPSigningThe public key is used for signing OCSP responses.
ServerAuthenticationThe public key is used for TLS WWW server authentication.
TimestampingThe public key is used for binding the hash of an object to a time.

Example Response

{
    "@odata.type": "#CertificateService.v1_0_0.CertificateService",
    "Id": "CertificateService",
    "Name": "Certificate Service",
    "Actions": {
        "#CertificateService.GenerateCSR": {
            "target": "/redfish/v1/CertificateService/Actions/CertificateService.GenerateCSR",
            "@Redfish.ActionInfo": "/redfish/v1/CertificateService/GenerateCSRActionInfo"
        },
        "#CertificateService.ReplaceCertificate": {
            "target": "/redfish/v1/CertificateService/Actions/CertificateService.ReplaceCertificate",
            "@Redfish.ActionInfo": "/redfish/v1/CertificateService/ReplaceCertificateActionInfo"
        }
    },
    "CertificateLocations": {
        "@odata.id": "/redfish/v1/CertificateService/CertificateLocations"
    },
    "Oem": {},
    "@odata.id": "/redfish/v1/CertificateService"
}

Chassis 1.9.1

v1.9v1.8v1.7v1.6v1.5v1.4v1.3v1.2v1.1v1.0
2018.32018.22018.12017.32017.12016.32016.22016.11.11.0

The Chassis schema represents the physical components of a system. This resource represents the sheet-metal confined spaces and logical zones such as racks, enclosures, chassis and all other containers. Subsystems (like sensors) that operate outside of a system's data plane (meaning the resources are not accessible to software running on the system) are linked either directly or indirectly through this resource.

URIs:

Assembly (v1.6+) {objectA reference to the Assembly resource associated with this chassis.
See the Assembly schema for details on this property.
      @odata.id
}
stringread-onlyLink to a Assembly resource. See the Links section and the Assembly schema for details.
AssetTagstringread-write (null)The user assigned asset tag of this chassis.
ChassisTypestring
(enum)
read-only requiredThe type of physical form factor of the chassis.
See ChassisType in Property Details, below, for the possible values of this property.
DepthMm (v1.4+)number
(mm)
read-only (null)The depth of the chassis.
EnvironmentalClass (v1.9+)string
(enum)
read-only (null)The ASHRAE Environmental Class for this Chassis.
See EnvironmentalClass in Property Details, below, for the possible values of this property.
HeightMm (v1.4+)number
(mm)
read-only (null)The height of the chassis.
IndicatorLEDstring
(enum)
read-write (null)The state of the indicator LED, used to identify the chassis.
See IndicatorLED in Property Details, below, for the possible values of this property.
Links {objectContains references to other resources that are related to this resource.
      ComputerSystems [ {arrayAn array of references to the computer systems contained in this chassis. This will only reference ComputerSystems that are directly and wholly contained in this chassis.
            @odata.id
      } ]
stringread-onlyLink to a ComputerSystem resource. See the Links section and the ComputerSystem schema for details.
      ContainedBy {objectA reference to the chassis that this chassis is contained by.
            @odata.id
      }
stringread-onlyLink to another Chassis resource.
      Contains [ {arrayAn array of references to any other chassis that this chassis has in it.
            @odata.id
      } ]
stringread-onlyLink to another Chassis resource.
      CooledBy [ {arrayAn array of ID[s] of resources that cool this chassis. Normally the ID will be a chassis or a specific set of fans.
            @odata.id
      } ]
stringread-onlyThe unique identifier for a resource.
      Drives (v1.2+) [ {arrayAn array of references to the disk drives located in this Chassis.
            @odata.id
      } ]
stringread-onlyLink to a Drive resource. See the Links section and the Drive schema for details.
      ManagedBy [ {arrayAn array of references to the Managers responsible for managing this chassis.
            @odata.id
      } ]
stringread-onlyLink to a Manager resource. See the Links section and the Manager schema for details.
      ManagersInChassis (v1.2+) [ {arrayAn array of references to the managers located in this Chassis.
            @odata.id
      } ]
stringread-onlyLink to a Manager resource. See the Links section and the Manager schema for details.
      Oem { }objectSee the OEM object definition in the Common properties section.
      PCIeDevices (v1.4+) [ {arrayAn array of references to the PCIe Devices located in this Chassis.
            @odata.id
      } ]
stringread-onlyLink to a PCIeDevice resource. See the Links section and the PCIeDevice schema for details.
      PoweredBy [ {arrayAn array of ID[s] of resources that power this chassis. Normally the ID will be a chassis or a specific set of Power Supplies.
            @odata.id
      } ]
stringread-onlyThe unique identifier for a resource.
      Processors (v1.9+) [ {arrayAn array of references to the Processors located in this Chassis.
            @odata.id
      } ]
stringread-onlyLink to a Processor resource. See the Links section and the Processor schema for details.
      ResourceBlocks (v1.5+) [ {arrayAn array of references to the Resource Blocks located in this Chassis.
            @odata.id
      } ]
stringread-onlyLink to a ResourceBlock resource. See the Links section and the ResourceBlock schema for details.
      Storage (v1.2+) [ {arrayAn array of references to the storage subsystems connected to or inside this Chassis.
            @odata.id
      } ]
stringread-onlyLink to a Storage resource. See the Links section and the Storage schema for details.
      Switches (v1.7+) [ {arrayAn array of references to the Switches located in this Chassis.
            @odata.id
      } ]
}
stringread-onlyLink to a Switch resource. See the Links section and the Switch schema for details.
Location (v1.2+) { }objectThe Location of the chassis.
See the Location object for details on this property.
LogServices {objectA reference to the logs for this chassis.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of LogService. See the LogService schema for details.
Manufacturerstringread-only (null)The manufacturer of this chassis.
Modelstringread-only (null)The model number of the chassis.
NetworkAdapters (v1.4+) {objectA reference to the collection of Network Adapters associated with this chassis.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of NetworkAdapter. See the NetworkAdapter schema for details.
PartNumberstringread-only (null)The part number of the chassis.
PCIeSlots (v1.8+) {objectA reference to the PCIe Slot properties of this chassis.
See the PCIeSlots schema for details on this property.
      @odata.id
}
stringread-onlyLink to a PCIeSlots resource. See the Links section and the PCIeSlots schema for details.
PhysicalSecurity (v1.1+) {objectThe state of the physical security sensor.
      IntrusionSensorstring
(enum)
read-write (null)This indicates the known state of the physical security sensor, such as if it is hardware intrusion detected.
See IntrusionSensor in Property Details, below, for the possible values of this property.
      IntrusionSensorNumberintegerread-only (null)A numerical identifier to represent the physical security sensor.
      IntrusionSensorReArm
}
string
(enum)
read-only (null)This indicates how the Normal state to be restored.
See IntrusionSensorReArm in Property Details, below, for the possible values of this property.
Power {objectA reference to the power properties (power supplies, power policies, sensors) of this chassis.
See the Power schema for details on this property.
      @odata.id
}
stringread-onlyLink to a Power resource. See the Links section and the Power schema for details.
PowerState (v1.1+)string
(enum)
read-only (null)The current power state of the chassis.
See PowerState in Property Details, below, for the possible values of this property.
Sensors (v1.9+) {objectThe naivgation pointer to the collection of sensors located in the equipment and sub-components.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of Sensor. See the Sensor schema for details.
SerialNumberstringread-only (null)The serial number of the chassis.
SKUstringread-only (null)The SKU of the chassis.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
Thermal {objectA reference to the thermal properties (fans, cooling, sensors) of this chassis.
See the Thermal schema for details on this property.
      @odata.id
}
stringread-onlyLink to a Thermal resource. See the Links section and the Thermal schema for details.
UUIDstringread-only (null)The Universal Unique Identifier (UUID) for this Chassis.
WeightKg (v1.4+)number
(kg)
read-only (null)The weight of the chassis.
WidthMm (v1.4+)number
(mm)
read-only (null)The width of the chassis.

Actions

Reset

This action is used to reset the chassis. This action resets the chassis, not Systems or other contained resources, although side effects may occur which affect those resources.

URIs:

The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.

{
      ResetType
}
string
(enum)
read-writeThe type of reset to be performed.
See ResetType in Property Details, below, for the possible values of this property.

Property Details

ChassisType:

The type of physical form factor of the chassis.

stringDescription
BladeAn enclosed or semi-enclosed, typically vertically-oriented, system chassis which must be plugged into a multi-system chassis to function normally.
CardA loose device or circuit board intended to be installed in a system or other enclosure.
CartridgeA small self-contained system intended to be plugged into a multi-system chassis.
ComponentA small chassis, card, or device which contains devices for a particular subsystem or function.
DrawerAn enclosed or semi-enclosed, typically horizontally-oriented, system chassis which may be slid into a multi-system chassis.
EnclosureA generic term for a chassis that does not fit any other description.
ExpansionA chassis which expands the capabilities or capacity of another chassis.
IPBasedDrive (v1.3+)A chassis in a drive form factor with IP-based network connections.
ModuleA small, typically removable, chassis or card which contains devices for a particular subsystem or function.
OtherA chassis that does not fit any of these definitions.
PodA collection of equipment racks in a large, likely transportable, container.
RackAn equipment rack, typically a 19-inch wide freestanding unit.
RackGroup (v1.4+)A group of racks which form a single entity or share infrastructure.
RackMountA single system chassis designed specifically for mounting in an equipment rack.
RowA collection of equipment racks.
ShelfAn enclosed or semi-enclosed, typically horizontally-oriented, system chassis which must be plugged into a multi-system chassis to function normally.
SidecarA chassis that mates mechanically with another chassis to expand its capabilities or capacity.
SledAn enclosed or semi-enclosed, system chassis which must be plugged into a multi-system chassis to function normally similar to a blade type chassis.
StandAloneA single, free-standing system, commonly called a tower or desktop chassis.
StorageEnclosure (v1.6+)A chassis which encloses storage.
ZoneA logical division or portion of a physical chassis that contains multiple devices or systems that cannot be physically separated.

EnvironmentalClass:

The ASHRAE Environmental Class for this Chassis.

stringDescription
A1ASHRAE Environmental Specification Class 'A1'.
A2ASHRAE Environmental Specification Class 'A2'.
A3ASHRAE Environmental Specification Class 'A3'.
A4ASHRAE Environmental Specification Class 'A4'.

IndicatorLED:

The state of the indicator LED, used to identify the chassis.

stringDescription
BlinkingThe Indicator LED is blinking.
LitThe Indicator LED is lit.
OffThe Indicator LED is off.
Unknown (deprecated v1.5)The state of the Indicator LED cannot be determined. Deprecated v1.5+. This value has been Deprecated in favor of returning null if the state is unknown.

IntrusionSensor:

This indicates the known state of the physical security sensor, such as if it is hardware intrusion detected.

stringDescription
HardwareIntrusionA door, lock, or other mechanism protecting the internal system hardware from being accessed is detected as being in an insecure state.
NormalNo abnormal physical security conditions are detected at this time.
TamperingDetectedPhysical tampering of the monitored entity is detected.

IntrusionSensorReArm:

This indicates how the Normal state to be restored.

stringDescription
AutomaticThis sensor would be restored to the Normal state automatically as no abnormal physical security conditions are detected.
ManualThis sensor would be restored to the Normal state by a manual re-arm.

PowerState:

The current power state of the chassis.

stringDescription
OffThe components within the chassis has no power, except some components may continue to have AUX power such as management controller.
OnThe components within the chassis has power on.
PoweringOffA temporary state between On and Off. The components within the chassis can take time to process the power off action.
PoweringOnA temporary state between Off and On. The components within the chassis can take time to process the power on action.

ResetType:

The type of reset to be performed.

stringDescription
ForceOffTurn the unit off immediately (non-graceful shutdown).
ForceOnTurn the unit on immediately.
ForceRestartPerform an immediate (non-graceful) shutdown, followed by a restart.
GracefulRestartPerform a graceful shutdown followed by a restart of the system.
GracefulShutdownPerform a graceful shutdown and power off.
NmiGenerate a Diagnostic Interrupt (usually an NMI on x86 systems) to cease normal operations, perform diagnostic actions and typically halt the system.
OnTurn the unit on.
PowerCyclePerform a power cycle of the unit.
PushPowerButtonSimulate the pressing of the physical power button on this unit.

Example Response

{
    "@odata.type": "#Chassis.v1_8_0.Chassis",
    "Id": "1U",
    "Name": "Computer System Chassis",
    "ChassisType": "RackMount",
    "AssetTag": "Chicago-45Z-2381",
    "Manufacturer": "Contoso",
    "Model": "3500RX",
    "SKU": "8675309",
    "SerialNumber": "437XR1138R2",
    "PartNumber": "224071-J23",
    "PowerState": "On",
    "IndicatorLED": "Lit",
    "HeightMm": 44.45,
    "WidthMm": 431.8,
    "DepthMm": 711,
    "WeightKg": 15.31,
    "Location": {
        "PostalAddress": {
            "Country": "US",
            "Territory": "OR",
            "City": "Portland",
            "Street": "1001 SW 5th Avenue",
            "HouseNumber": 1100,
            "Name": "DMTF",
            "PostalCode": "97204"
        },
        "Placement": {
            "Row": "North",
            "Rack": "WEB43",
            "RackOffsetUnits": "EIA_310",
            "RackOffset": 12
        }
    },
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "Thermal": {
        "@odata.id": "/redfish/v1/Chassis/1U/Thermal"
    },
    "Power": {
        "@odata.id": "/redfish/v1/Chassis/1U/Power"
    },
    "Assembly": {
        "@odata.id": "/redfish/v1/Chassis/1U/Assembly"
    },
    "Links": {
        "ComputerSystems": [
            {
                "@odata.id": "/redfish/v1/Systems/437XR1138R2"
            }
        ],
        "ManagedBy": [
            {
                "@odata.id": "/redfish/v1/Managers/BMC"
            }
        ],
        "ManagersInChassis": [
            {
                "@odata.id": "/redfish/v1/Managers/BMC"
            }
        ]
    },
    "@odata.context": "/redfish/v1/$metadata#Chassis.Chassis",
    "@odata.id": "/redfish/v1/Chassis/1U"
}

CompositionService 1.1.1

v1.1v1.0
2018.22017.1

The CompositionService schema defines a Composition Service which represents the properties for the service and links to the resources available for composition.

URIs:

AllowOverprovisioning (v1.1+)booleanread-write (null)This indicates whether this service is allowed to overprovision a composition relative to the composition request.
AllowZoneAffinity (v1.1+)booleanread-only (null)This indicates whether a client is allowed to request that given composition request is fulfilled by a specified Resource Zone.
ResourceBlocks {objectThe resource blocks available on the service.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of ResourceBlock. See the ResourceBlock schema for details.
ResourceZones {objectThe resource zones available on the service.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of Zone. See the Zone schema for details.
ServiceEnabledbooleanread-write (null)This indicates whether this service is enabled.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.

Example Response

{
    "@odata.type": "#CompositionService.v1_1_0.CompositionService",
    "Id": "CompositionService",
    "Name": "Composition Service",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "ServiceEnabled": true,
    "AllowOverprovisioning": true,
    "AllowZoneAffinity": true,
    "ResourceBlocks": {
        "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks"
    },
    "ResourceZones": {
        "@odata.id": "/redfish/v1/CompositionService/ResourceZones"
    },
    "Oem": {},
    "@odata.context": "/redfish/v1/$metadata#CompositionService.CompositionService",
    "@odata.id": "/redfish/v1/CompositionService"
}

ComputerSystem 1.7.0

v1.7v1.6v1.5v1.4v1.3v1.2v1.1v1.0
2019.12018.32017.32017.12016.32016.22016.11.0

This schema defines a computer system and its respective properties. A computer system represents a machine (physical or virtual) and the local resources such as memory, cpu and other devices that can be accessed from that machine.

URIs:

AssetTagstringread-write (null)The user definable tag that can be used to track this computer system for inventory or other client purposes.
Bios (v1.1+) {objectA reference to the BIOS settings associated with this system.
See the Bios schema for details on this property.
      @odata.id
}
stringread-onlyLink to a Bios resource. See the Links section and the Bios schema for details.
BiosVersionstringread-only (null)The version of the system BIOS or primary system firmware.
Boot {objectInformation about the boot settings for this system.
      AliasBootOrder [ ] array (string
(enum))
read-write (null)Ordered array of boot source aliases representing the persistent Boot Order associated with this computer system.
See AliasBootOrder in Property Details, below, for the possible values of this property.
      BootNext (v1.5+)stringread-write (null)This property is the BootOptionReference of the Boot Option to perform a one time boot from when BootSourceOverrideTarget is UefiBootNext.
      BootOptions (v1.5+) {objectA reference to the collection of the UEFI Boot Options associated with this Computer System.
Contains a link to a resource.
            @odata.id
      }
stringread-onlyLink to Collection of BootOption. See the BootOption schema for details.
      BootOrder (v1.5+) [ ] array
(string, null)
read-writeOrdered array of BootOptionReference strings representing the persistent Boot Order associated with this computer system.
      BootOrderPropertySelection (v1.6+)string
(enum)
read-write (null)Choice of which boot order property to use when specifying the boot order.
See BootOrderPropertySelection in Property Details, below, for the possible values of this property.
      BootSourceOverrideEnabledstring
(enum)
read-write (null)Describes the state of the Boot Source Override feature.
See BootSourceOverrideEnabled in Property Details, below, for the possible values of this property.
      BootSourceOverrideMode (v1.1+)string
(enum)
read-write (null)The BIOS Boot Mode (either Legacy or UEFI) to be used when BootSourceOverrideTarget boot source is booted from.
See BootSourceOverrideMode in Property Details, below, for the possible values of this property.
      BootSourceOverrideTargetstring
(enum)
read-write (null)The current boot source to be used at next boot instead of the normal boot device, if BootSourceOverrideEnabled is true.
See BootSourceOverrideTarget in Property Details, below, for the possible values of this property.
      Certificates (v1.7+) {objectThis is a reference to a collection of certificates used for booting via HTTPS by this ComputerSystem.
Contains a link to a resource.
            @odata.id
      }
stringread-onlyLink to Collection of Certificate. See the Certificate schema for details.
      UefiTargetBootSourceOverride
}
stringread-write (null)This property is the UEFI Device Path of the device to boot from when BootSourceOverrideTarget is UefiTarget.
EthernetInterfaces {objectA reference to the collection of Ethernet interfaces associated with this system.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of EthernetInterface. See the EthernetInterface schema for details.
HostedServices (v1.2+) {objectThe services that this computer system supports.
      Oem { }objectSee the OEM object definition in the Common properties section.
      StorageServices {objectA reference to a collection of storage services supported by this computer system.
            @odata.id
      }
}
stringread-onlyThe unique identifier for a resource.
HostingRoles (v1.2+) [ ] array (string
(enum))
read-onlyThe hosing roles that this computer system supports. The enumerations of HostingRoles specify different features that the hosting ComputerSystem supports.
See HostingRoles in Property Details, below, for the possible values of this property.
HostNamestringread-write (null)The DNS Host Name, without any domain information.
HostWatchdogTimer (v1.5+) {objectThis object describes the Host Watchdog Timer functionality for this system.
      FunctionEnabledbooleanread-write required (null)This indicates if the Host Watchdog Timer functionality has been enabled. Additional host-based software is necessary to activate the timer function.
      Oem { }objectSee the OEM object definition in the Common properties section.
      Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
      TimeoutActionstring
(enum)
read-write required (null)This property indicates the action to perform when the Watchdog Timer reaches its timeout value.
See TimeoutAction in Property Details, below, for the possible values of this property.
      WarningAction
}
string
(enum)
read-write (null)This property indicates the action to perform when the Watchdog Timer is close (typically 3-10 seconds) to reaching its timeout value.
See WarningAction in Property Details, below, for the possible values of this property.
IndicatorLEDstring
(enum)
read-write (null)The state of the indicator LED, used to identify the system.
See IndicatorLED in Property Details, below, for the possible values of this property.
Links {objectContains references to other resources that are related to this resource.
      Chassis [ {arrayAn array of references to the chassis in which this system is contained.
            @odata.id
      } ]
stringread-onlyLink to a Chassis resource. See the Links section and the Chassis schema for details.
      ConsumingComputerSystems (v1.5+) [ {arrayAn array of references to ComputerSystems that are realized, in whole or in part, from this ComputerSystem.
            @odata.id
      } ]
stringread-onlyLink to another ComputerSystem resource.
      CooledBy [ {arrayAn array of ID[s] of resources that cool this computer system. Normally the ID will be a chassis or a specific set of fans.
            @odata.id
      } ]
stringread-onlyThe unique identifier for a resource.
      Endpoints (v1.2+) [ {arrayAn array of references to the endpoints that connect to this system.
            @odata.id
      } ]
stringread-onlyLink to a Endpoint resource. See the Links section and the Endpoint schema for details.
      ManagedBy [ {arrayAn array of references to the Managers responsible for this system.
            @odata.id
      } ]
stringread-onlyLink to a Manager resource. See the Links section and the Manager schema for details.
      Oem { }objectSee the OEM object definition in the Common properties section.
      PoweredBy [ {arrayAn array of ID[s] of resources that power this computer system. Normally the ID will be a chassis or a specific set of Power Supplies.
            @odata.id
      } ]
stringread-onlyThe unique identifier for a resource.
      ResourceBlocks (v1.4+) [ {arrayAn array of references to the Resource Blocks that are used in this Computer System.
            @odata.id
      } ]
stringread-onlyLink to a ResourceBlock resource. See the Links section and the ResourceBlock schema for details.
      SupplyingComputerSystems (v1.5+) [ {arrayAn array of references to ComputerSystems that contribute, in whole or in part, to the implementation of this ComputerSystem.
            @odata.id
      } ]
}
stringread-onlyLink to another ComputerSystem resource.
LogServices {objectA reference to the collection of Log Services associated with this system.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of LogService. See the LogService schema for details.
Manufacturerstringread-only (null)The manufacturer or OEM of this system.
Memory (v1.1+) {objectA reference to the collection of Memory associated with this system.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of Memory. See the Memory schema for details.
MemoryDomains (v1.2+) {objectA reference to the collection of Memory Domains associated with this system.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of MemoryDomain. See the MemoryDomain schema for details.
MemorySummary {objectThis object describes the central memory of the system in general detail.
      MemoryMirroring (v1.1+)string
(enum)
read-only (null)The ability and type of memory mirroring supported by this system.
See MemoryMirroring in Property Details, below, for the possible values of this property.
      Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
      TotalSystemMemoryGiBnumber
(GiBy)
read-only (null)The total configured operating system-accessible memory (RAM), measured in GiB.
      TotalSystemPersistentMemoryGiB (v1.4+)
}
number
(GiBy)
read-only (null)The total configured, system-accessible persistent memory, measured in GiB.
Modelstringread-only (null)The product name for this system, without the manufacturer name.
NetworkInterfaces (v1.3+) {objectA reference to the collection of Network Interfaces associated with this system.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of NetworkInterface. See the NetworkInterface schema for details.
PartNumberstringread-only (null)The part number for this system.
PCIeDevices (v1.2+) [ {arrayA reference to a collection of PCIe Devices used by this computer system.
      @odata.id
} ]
stringread-onlyLink to a PCIeDevice resource. See the Links section and the PCIeDevice schema for details.
PCIeFunctions (v1.2+) [ {arrayA reference to a collection of PCIe Functions used by this computer system.
      @odata.id
} ]
stringread-onlyLink to a PCIeFunction resource. See the Links section and the PCIeFunction schema for details.
PowerRestorePolicy (v1.6+)string
(enum)
read-writeThe desired power state of the system when power is restored after a power loss.
See PowerRestorePolicy in Property Details, below, for the possible values of this property.
PowerStatestring
(enum)
read-only (null)This is the current power state of the system.
See PowerState in Property Details, below, for the possible values of this property.
Processors {objectA reference to the collection of Processors associated with this system.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of Processor. See the Processor schema for details.
ProcessorSummary {objectThis object describes the central processors of the system in general detail.
      Countintegerread-only (null)The number of physical processors in the system.
      LogicalProcessorCount (v1.5+)integerread-only (null)The number of logical processors in the system.
      Metrics (v1.7+) {objectA reference to the Metrics associated with all Processors in this system.
See the ProcessorMetrics schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a ProcessorMetrics resource. See the Links section and the ProcessorMetrics schema for details.
      Modelstringread-only (null)The processor model for the primary or majority of processors in this system.
      Status { }
}
objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
Redundancy (v1.5+) [ {arrayA reference to a collection of Redundancy entities that each name a set of computer systems that provide redundancy for this ComputerSystem.
      @odata.id
} ]
stringread-onlyThe unique identifier for a resource.
SecureBoot (v1.1+) {objectA reference to the UEFI SecureBoot resource associated with this system.
See the SecureBoot schema for details on this property.
      @odata.id
}
stringread-onlyLink to a SecureBoot resource. See the Links section and the SecureBoot schema for details.
SerialNumberstringread-only (null)The serial number for this system.
SimpleStorage {objectA reference to the collection of storage devices associated with this system.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of SimpleStorage. See the SimpleStorage schema for details.
SKUstringread-only (null)The manufacturer SKU for this system.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
Storage (v1.1+) {objectA reference to the collection of storage devices associated with this system.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of Storage. See the Storage schema for details.
SubModel (v1.5+)stringread-only (null)The sub-model for this system.
SystemTypestring
(enum)
read-onlyThe type of computer system represented by this resource.
See SystemType in Property Details, below, for the possible values of this property.
TrustedModules (v1.1+) [ {arrayThis object describes the array of Trusted Modules in the system.
      FirmwareVersionstringread-only (null)The firmware version of this Trusted Module.
      FirmwareVersion2 (v1.3+)stringread-only (null)The 2nd firmware version of this Trusted Module, if applicable.
      InterfaceTypestring
(enum)
read-only (null)This property indicates the interface type of the Trusted Module.
See InterfaceType in Property Details, below, for the possible values of this property.
      InterfaceTypeSelection (v1.3+)string
(enum)
read-only (null)The Interface Type selection supported by this Trusted Module.
See InterfaceTypeSelection in Property Details, below, for the possible values of this property.
      Oem { }objectSee the OEM object definition in the Common properties section.
      Status { }
} ]
objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
UUIDstringread-only (null)The universal unique identifier (UUID) for this system.
See Property Details, below, for more information about this property.

Actions

AddResourceBlock

This action is used to add a Resource Block to a system.

URIs:

The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.

{
      ComputerSystemETagstringread-writeThe current ETag of the system.
      ResourceBlock {objectThe Resource Block to add to the system.
See the ResourceBlock schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a ResourceBlock resource. See the Links section and the ResourceBlock schema for details.
      ResourceBlockETag
}
stringread-writeThe current ETag of the Resource Block to add to the system.

RemoveResourceBlock

This action is used to remove a Resource Block from a system.

URIs:

The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.

{
      ComputerSystemETagstringread-writeThe current ETag of the system.
      ResourceBlock {objectThe Resource Block to remove from the system.
See the ResourceBlock schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a ResourceBlock resource. See the Links section and the ResourceBlock schema for details.
      ResourceBlockETag
}
stringread-writeThe current ETag of the Resource Block to remove from the system.

Reset

This action is used to reset the system.

URIs:

The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.

{
      ResetType
}
string
(enum)
read-writeThe type of reset to be performed.
See ResetType in Property Details, below, for the possible values of this property.

SetDefaultBootOrder

This action is used to set the Boot Order to the default settings.

URIs:

(This action takes no parameters.)

Property Details

AliasBootOrder:

Ordered array of boot source aliases representing the persistent Boot Order associated with this computer system.

stringDescription
BiosSetupBoot to the BIOS Setup Utility.
CdBoot from the CD/DVD disc.
DiagsBoot the manufacturer's Diagnostics program.
FloppyBoot from the floppy disk drive.
HddBoot from a hard drive.
NoneBoot from the normal boot device.
PxeBoot from the Pre-Boot EXecution (PXE) environment.
RemoteDrive (v1.2+)Boot from a remote drive (e.g. iSCSI).
SDCardBoot from an SD Card.
UefiBootNext (v1.5+)Boot to the UEFI Device specified in the BootNext property.
UefiHttpBoot from a UEFI HTTP network location.
UefiShellBoot to the UEFI Shell.
UefiTargetBoot to the UEFI Device specified in the UefiTargetBootSourceOverride property.
UsbBoot from a USB device as specified by the system BIOS.
UtilitiesBoot the manufacturer's Utilities program(s).

BootOrderPropertySelection:

Choice of which boot order property to use when specifying the boot order.

stringDescription
AliasBootOrderThe system uses the AliasBootOrder property for specifying persistent boot order.
BootOrderThe system uses the BootOrder property for specifying persistent boot order.

BootSourceOverrideEnabled:

Describes the state of the Boot Source Override feature.

stringDescription
ContinuousThe system will boot to the target specified in the BootSourceOverrideTarget until this property is set to Disabled.
DisabledThe system will boot normally.
OnceOn its next boot cycle, the system will boot (one time) to the Boot Source Override Target. The value of BootSourceOverrideEnabled is then reset back to Disabled.

BootSourceOverrideMode:

The BIOS Boot Mode (either Legacy or UEFI) to be used when BootSourceOverrideTarget boot source is booted from.

stringDescription
LegacyThe system will boot in non-UEFI boot mode to the Boot Source Override Target.
UEFIThe system will boot in UEFI boot mode to the Boot Source Override Target.

BootSourceOverrideTarget:

The current boot source to be used at next boot instead of the normal boot device, if BootSourceOverrideEnabled is true.

stringDescription
BiosSetupBoot to the BIOS Setup Utility.
CdBoot from the CD/DVD disc.
DiagsBoot the manufacturer's Diagnostics program.
FloppyBoot from the floppy disk drive.
HddBoot from a hard drive.
NoneBoot from the normal boot device.
PxeBoot from the Pre-Boot EXecution (PXE) environment.
RemoteDrive (v1.2+)Boot from a remote drive (e.g. iSCSI).
SDCardBoot from an SD Card.
UefiBootNext (v1.5+)Boot to the UEFI Device specified in the BootNext property.
UefiHttpBoot from a UEFI HTTP network location.
UefiShellBoot to the UEFI Shell.
UefiTargetBoot to the UEFI Device specified in the UefiTargetBootSourceOverride property.
UsbBoot from a USB device as specified by the system BIOS.
UtilitiesBoot the manufacturer's Utilities program(s).

HostingRoles:

The hosing roles that this computer system supports. The enumerations of HostingRoles specify different features that the hosting ComputerSystem supports.

stringDescription
ApplicationServerThe system hosts functionality that supports general purpose applications.
StorageServerThe system hosts functionality that supports the system acting as a storage server.
SwitchThe system hosts functionality that supports the system acting as a switch.

IndicatorLED:

The state of the indicator LED, used to identify the system.

stringDescription
BlinkingThe Indicator LED is blinking.
LitThe Indicator LED is lit.
OffThe Indicator LED is off.
Unknown (deprecated v1.4)The state of the Indicator LED cannot be determined. Deprecated v1.4+. This value has been Deprecated in favor of returning null if the state is unknown.

InterfaceType:

This property indicates the interface type of the Trusted Module.

stringDescription
TCM1_0Trusted Cryptography Module (TCM) 1.0.
TPM1_2Trusted Platform Module (TPM) 1.2.
TPM2_0Trusted Platform Module (TPM) 2.0.

InterfaceTypeSelection:

The Interface Type selection supported by this Trusted Module.

stringDescription
BiosSettingThe TrustedModule supports switching InterfaceType via platform software, such as a BIOS configuration Attribute.
FirmwareUpdateThe TrustedModule supports switching InterfaceType via a firmware update.
NoneThe TrustedModule does not support switching the InterfaceType.
OemMethodThe TrustedModule supports switching InterfaceType via an OEM proprietary mechanism.

MemoryMirroring:

The ability and type of memory mirroring supported by this system.

stringDescription
DIMMThe system supports DIMM mirroring at the DIMM level. Individual DIMMs can be mirrored.
HybridThe system supports a hybrid mirroring at the system and DIMM levels. Individual DIMMs can be mirrored.
NoneThe system does not support DIMM mirroring.
SystemThe system supports DIMM mirroring at the System level. Individual DIMMs are not paired for mirroring in this mode.

PowerRestorePolicy:

The desired power state of the system when power is restored after a power loss.

stringDescription
AlwaysOffThe system will always remain powered off when power is applied.
AlwaysOnThe system will always power on when power is applied.
LastStateThe system will return to its last power state (on or off) when power is applied.

PowerState:

This is the current power state of the system.

stringDescription
OffThe system is powered off, although some components may continue to have AUX power such as management controller.
OnThe system is powered on.
PoweringOffA temporary state between On and Off. The power off action can take time while the OS is in the shutdown process.
PoweringOnA temporary state between Off and On. This temporary state can be very short.

ResetType:

The type of reset to be performed.

stringDescription
ForceOffTurn the unit off immediately (non-graceful shutdown).
ForceOnTurn the unit on immediately.
ForceRestartPerform an immediate (non-graceful) shutdown, followed by a restart.
GracefulRestartPerform a graceful shutdown followed by a restart of the system.
GracefulShutdownPerform a graceful shutdown and power off.
NmiGenerate a Diagnostic Interrupt (usually an NMI on x86 systems) to cease normal operations, perform diagnostic actions and typically halt the system.
OnTurn the unit on.
PowerCyclePerform a power cycle of the unit.
PushPowerButtonSimulate the pressing of the physical power button on this unit.

SystemType:

The type of computer system represented by this resource.

stringDescription
Composed (v1.4+)A computer system that has been created by binding resource blocks together.
OSAn operating system instance.
PhysicalA computer system.
PhysicallyPartitionedA hardware-based partition of a computer system.
VirtualA virtual machine instance running on this system.
VirtuallyPartitionedA virtual or software-based partition of a computer system.

TimeoutAction:

This property indicates the action to perform when the Watchdog Timer reaches its timeout value.

stringDescription
NoneNo action taken.
OEMPerform an OEM-defined action.
PowerCyclePower cycle the system.
PowerDownPower down the system.
ResetSystemReset the system.

UUID:

The universal unique identifier (UUID) for this system.

The UUID property contains a value that represents the universal unique identifier number (UUID) of a system.

The UUID property is a string data type. The format of the string is the 35-character string format specified in RFC4122: "xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx". Each x represents a hexadecimal digit (0-f).

Regarding the case of the hex values, RFC4122 specifies that the hex values should be lowercase characters. Most modern scripting languages typically also represent hex values in lowercase characters following the RFC. However, dmidecode, WMI and some Redfish implementations currently use uppercase characters for UUID on output.

WarningAction:

This property indicates the action to perform when the Watchdog Timer is close (typically 3-10 seconds) to reaching its timeout value.

stringDescription
DiagnosticInterruptRaise a (typically non-maskable) Diagnostic Interrupt.
MessagingInterruptRaise a legacy IPMI messaging interrupt.
NoneNo action taken.
OEMPerform an OEM-defined action.
SCIRaise an interrupt using the ACPI System Control Interrupt (SCI).
SMIRaise a Systems Management Interrupt (SMI).

Example Response

{
    "@odata.type": "#ComputerSystem.v1_5_1.ComputerSystem",
    "Id": "437XR1138R2",
    "Name": "WebFrontEnd483",
    "SystemType": "Physical",
    "AssetTag": "Chicago-45Z-2381",
    "Manufacturer": "Contoso",
    "Model": "3500RX",
    "SKU": "8675309",
    "SerialNumber": "437XR1138R2",
    "PartNumber": "224071-J23",
    "Description": "Web Front End node",
    "UUID": "38947555-7742-3448-3784-823347823834",
    "HostName": "web483",
    "Status": {
        "State": "Enabled",
        "Health": "OK",
        "HealthRollup": "OK"
    },
    "HostingRoles": [
        "ApplicationServer"
    ],
    "IndicatorLED": "Off",
    "PowerState": "On",
    "Boot": {
        "BootSourceOverrideEnabled": "Once",
        "BootSourceOverrideTarget": "Pxe",
        "BootSourceOverrideTarget@Redfish.AllowableValues": [
            "None",
            "Pxe",
            "Cd",
            "Usb",
            "Hdd",
            "BiosSetup",
            "Utilities",
            "Diags",
            "SDCard",
            "UefiTarget"
        ],
        "BootSourceOverrideMode": "UEFI",
        "UefiTargetBootSourceOverride": "/0x31/0x33/0x01/0x01"
    },
    "TrustedModules": [
        {
            "FirmwareVersion": "1.13b",
            "InterfaceType": "TPM1_2",
            "Status": {
                "State": "Enabled",
                "Health": "OK"
            }
        }
    ],
    "Oem": {
        "Contoso": {
            "@odata.type": "#Contoso.ComputerSystem",
            "ProductionLocation": {
                "FacilityName": "PacWest Production Facility",
                "Country": "USA"
            }
        },
        "Chipwise": {
            "@odata.type": "#Chipwise.ComputerSystem",
            "Style": "Executive"
        }
    },
    "BiosVersion": "P79 v1.33 (02/28/2015)",
    "ProcessorSummary": {
        "Count": 2,
        "Model": "Multi-Core Intel(R) Xeon(R) processor 7xxx Series",
        "Status": {
            "State": "Enabled",
            "Health": "OK",
            "HealthRollup": "OK"
        }
    },
    "MemorySummary": {
        "TotalSystemMemoryGiB": 96,
        "TotalSystemPersistentMemoryGiB": 0,
        "MemoryMirroring": "None",
        "Status": {
            "State": "Enabled",
            "Health": "OK",
            "HealthRollup": "OK"
        }
    },
    "Bios": {
        "@odata.id": "/redfish/v1/Systems/437XR1138R2/BIOS"
    },
    "Processors": {
        "@odata.id": "/redfish/v1/Systems/437XR1138R2/Processors"
    },
    "Memory": {
        "@odata.id": "/redfish/v1/Systems/437XR1138R2/Memory"
    },
    "EthernetInterfaces": {
        "@odata.id": "/redfish/v1/Systems/437XR1138R2/EthernetInterfaces"
    },
    "SimpleStorage": {
        "@odata.id": "/redfish/v1/Systems/437XR1138R2/SimpleStorage"
    },
    "LogServices": {
        "@odata.id": "/redfish/v1/Systems/437XR1138R2/LogServices"
    },
    "Links": {
        "Chassis": [
            {
                "@odata.id": "/redfish/v1/Chassis/1U"
            }
        ],
        "ManagedBy": [
            {
                "@odata.id": "/redfish/v1/Managers/BMC"
            }
        ]
    },
    "Actions": {
        "#ComputerSystem.Reset": {
            "target": "/redfish/v1/Systems/437XR1138R2/Actions/ComputerSystem.Reset",
            "ResetType@Redfish.AllowableValues": [
                "On",
                "ForceOff",
                "GracefulShutdown",
                "GracefulRestart",
                "ForceRestart",
                "Nmi",
                "ForceOn",
                "PushPowerButton"
            ]
        },
        "Oem": {
            "#Contoso.Reset": {
                "target": "/redfish/v1/Systems/437XR1138R2/Oem/Contoso/Actions/Contoso.Reset"
            }
        }
    },
    "@odata.context": "/redfish/v1/$metadata#ComputerSystem.ComputerSystem",
    "@odata.id": "/redfish/v1/Systems/437XR1138R2"
}

Drive 1.6.0

v1.6v1.5v1.4v1.3v1.2v1.1v1.0
2019.12018.22018.12017.32017.12016.22016.1

The Drive schema represents a single physical disk drive for a system, including links to associated Volumes.

URIs:

Assembly (v1.3+) {objectA reference to the Assembly resource associated with this drive.
See the Assembly schema for details on this property.
      @odata.id
}
stringread-onlyLink to a Assembly resource. See the Links section and the Assembly schema for details.
AssetTagstringread-write (null)The user assigned asset tag for this drive.
BlockSizeBytesinteger
(bytes)
read-only (null)The size of the smallest addressible unit (Block) of this drive in bytes.
CapableSpeedGbsnumber
(Gbit/s)
read-only (null)The speed which this drive can communicate to a storage controller in ideal conditions in Gigabits per second.
CapacityBytesinteger
(bytes)
read-only (null)The size in bytes of this Drive.
EncryptionAbilitystring
(enum)
read-only (null)The encryption abilities of this drive.
See EncryptionAbility in Property Details, below, for the possible values of this property.
EncryptionStatusstring
(enum)
read-only (null)The status of the encrytion of this drive.
See EncryptionStatus in Property Details, below, for the possible values of this property.
FailurePredictedbooleanread-only (null)Is this drive currently predicting a failure in the near future.
HotspareReplacementMode (v1.5+)string
(enum)
read-write (null)The replacement mode for the hotspare drive.
See HotspareReplacementMode in Property Details, below, for the possible values of this property.
HotspareTypestring
(enum)
read-only (null)The type of hotspare this drive is currently serving as.
See HotspareType in Property Details, below, for the possible values of this property.
Identifiers [ { } ]array (object)The Durable names for the drive. This type describes any additional identifiers for a resource.
See the Identifier object for details on this property.
IndicatorLEDstring
(enum)
read-write (null)The state of the indicator LED, used to identify the drive.
See IndicatorLED in Property Details, below, for the possible values of this property.
Links {objectContains references to other resources that are related to this resource.
      Chassis (v1.2+) {objectA reference to the Chassis which contains this Drive.
See the Chassis schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a Chassis resource. See the Links section and the Chassis schema for details.
      Endpoints (v1.1+) [ {arrayAn array of references to the endpoints that connect to this drive.
            @odata.id
      } ]
stringread-onlyLink to a Endpoint resource. See the Links section and the Endpoint schema for details.
      Oem { }objectSee the OEM object definition in the Common properties section.
      PCIeFunctions (v1.6+) [ {arrayAn array of references to the PCIe Functions which the drive produces.
            @odata.id
      } ]
stringread-onlyLink to a PCIeFunction resource. See the Links section and the PCIeFunction schema for details.
      Volumes [ {arrayAn array of references to the volumes contained in this drive. This will reference Volumes that are either wholly or only partly contained by this drive.
            @odata.id
      } ]
}
stringread-onlyThe unique identifier for a resource.
Location [ { } ]array (object)The Location of the drive. This type describes the location of a resource.
See the Location object for details on this property.
Manufacturerstringread-only (null)This is the manufacturer of this drive.
MediaTypestring
(enum)
read-only (null)The type of media contained in this drive.
See MediaType in Property Details, below, for the possible values of this property.
Modelstringread-only (null)This is the model number for the drive.
NegotiatedSpeedGbsnumber
(Gbit/s)
read-only (null)The speed which this drive is currently communicating to the storage controller in Gigabits per second.
Operations (v1.1+) [ {arrayThe operations currently running on the Drive.
      AssociatedTask (v1.3+) {objectA reference to the task associated with the operation if any.
See the Task schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a Task resource. See the Links section and the Task schema for details.
      OperationName (v1.3+)stringread-only (null)The name of the operation.
      PercentageComplete (v1.3+)
} ]
integer
(%)
read-only (null)The percentage of the operation that has been completed.
PartNumberstringread-only (null)The part number for this drive.
PhysicalLocation (v1.4+) { }objectThe Location of the drive.
See the Location object for details on this property.
PredictedMediaLifeLeftPercentnumber
(%)
read-only (null)The percentage of reads and writes that are predicted to still be available for the media.
Protocolstring
(enum)
read-only (null)The protocol this drive is using to communicate to the storage controller.
See Protocol in Property Details, below, for the possible values of this property.
Revisionstringread-only (null)The revision of this Drive. This is typically the firmware/hardware version of the drive.
RotationSpeedRPMnumber
(RPM)
read-only (null)The rotation speed of this Drive in Revolutions per Minute (RPM).
SerialNumberstringread-only (null)The serial number for this drive.
SKUstringread-only (null)This is the SKU for this drive.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
StatusIndicatorstring
(enum)
read-write (null)The state of the status indicator, used to communicate status information about this drive.
See StatusIndicator in Property Details, below, for the possible values of this property.

Actions

SecureErase

This action is used to securely erase the contents of the drive.

URIs:

(This action takes no parameters.)

Property Details

EncryptionAbility:

The encryption abilities of this drive.

stringDescription
NoneThe drive is not capable of self encryption.
OtherThe drive is capable of self encryption through some other means.
SelfEncryptingDriveThe drive is capable of self encryption per the Trusted Computing Group's Self Encrypting Drive Standard.

EncryptionStatus:

The status of the encrytion of this drive.

stringDescription
ForeignThe drive is currently encrypted, the data is not accessible to the user, and the system requires user intervention to expose the data.
LockedThe drive is currently encrypted and the data is not accessible to the user, however the system has the ability to unlock the drive automatically.
Unecrypted (deprecated v1.2)The drive is not currently encrypted. Deprecated v1.2+. This value has been Deprecated in favor of Unencrypted.
Unencrypted (v1.1+)The drive is not currently encrypted.
UnlockedThe drive is currently encrypted but the data is accessible to the user unencrypted.

HotspareReplacementMode:

The replacement mode for the hotspare drive.

stringDescription
NonRevertibleA hotspare drive that is commissioned due to a drive failure will remain as a data drive and will not revert to a hotspare if the failed drive is replaced.
RevertibleA hotspare drive that is commissioned due to a drive failure will revert to being a hotspare once the failed drive is replaced and rebuilt.

HotspareType:

The type of hotspare this drive is currently serving as.

stringDescription
ChassisThe drive is currently serving as a hotspare for all other drives in the chassis.
DedicatedThe drive is currently serving as a hotspare for a user defined set of drives.
GlobalThe drive is currently serving as a hotspare for all other drives in the storage system.
NoneThe drive is not currently a hotspare.

IndicatorLED:

The state of the indicator LED, used to identify the drive.

stringDescription
BlinkingThe Indicator LED is blinking.
LitThe Indicator LED is lit.
OffThe Indicator LED is off.

MediaType:

The type of media contained in this drive.

stringDescription
HDDThe drive media type is traditional magnetic platters.
SMRThe drive media type is shingled magnetic recording.
SSDThe drive media type is solid state or flash memory.

Protocol:

The protocol this drive is using to communicate to the storage controller.

stringDescription
AHCIAdvanced Host Controller Interface.
FCFibre Channel.
FCoEFibre Channel over Ethernet.
FCPFibre Channel Protocol for SCSI.
FICONFIbre CONnection (FICON).
FTPFile Transfer Protocol.
HTTPHypertext Transport Protocol.
HTTPSSecure Hypertext Transport Protocol.
I2CInter-Integrated Circuit Bus.
iSCSIInternet SCSI.
iWARPInternet Wide Area Remote Direct Memory Access Protocol.
NFSv3Network File System version 3.
NFSv4Network File System version 4.
NVMeNon-Volatile Memory Express.
NVMeOverFabricsNVMe over Fabrics.
OEMOEM specific.
PCIePCI Express.
RoCERDMA over Converged Ethernet Protocol.
RoCEv2RDMA over Converged Ethernet Protocol Version 2.
SASSerial Attached SCSI.
SATASerial AT Attachment.
SFTPSecure File Transfer Protocol.
SMBServer Message Block (aka CIFS Common Internet File System).
UHCIUniversal Host Controller Interface.
USBUniversal Serial Bus.

StatusIndicator:

The state of the status indicator, used to communicate status information about this drive.

stringDescription
FailThe drive has failed.
HotspareThe drive is marked to be automatically rebuilt and used as a replacement for a failed drive.
InACriticalArrayThe array that this drive is a part of is degraded.
InAFailedArrayThe array that this drive is a part of is failed.
OKThe drive is OK.
PredictiveFailureAnalysisThe drive is still working but predicted to fail soon.
RebuildThe drive is being rebuilt.

Example Response

{
    "@odata.type": "#Drive.v1_5_0.Drive",
    "Id": "3D58ECBC375FD9F2",
    "Name": "Drive Sample",
    "IndicatorLED": "Lit",
    "Model": "C123",
    "Revision": "100A",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "CapacityBytes": 899527000000,
    "FailurePredicted": false,
    "Protocol": "SAS",
    "MediaType": "HDD",
    "Manufacturer": "Contoso",
    "SerialNumber": "1234568",
    "PartNumber": "C123-1111",
    "Identifiers": [
        {
            "DurableNameFormat": "NAA",
            "DurableName": "32ADF365C6C1B7BD"
        }
    ],
    "HotspareType": "None",
    "EncryptionAbility": "SelfEncryptingDrive",
    "EncryptionStatus": "Unlocked",
    "RotationSpeedRPM": 15000,
    "BlockSizeBytes": 512,
    "CapableSpeedGbs": 12,
    "NegotiatedSpeedGbs": 12,
    "Links": {
        "Volumes": [
            {
                "@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1/Volumes/2"
            },
            {
                "@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1/Volumes/3"
            }
        ]
    },
    "Actions": {
        "#Drive.SecureErase": {
            "target": "/redfish/v1/Systems/437XR1138R2/Storage/1/Drives/3D58ECBC375FD9F2/Actions/Drive.SecureErase"
        }
    },
    "@odata.context": "/redfish/v1/$metadata#Drive.Drive",
    "@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1/Drives/3D58ECBC375FD9F2"
}

Endpoint 1.3.1

v1.3v1.2v1.1v1.0
2018.32018.22017.32016.2

This is the schema definition for the Endpoint resource. It represents the properties of an entity that sends or receives protocol defined messages over a transport.

URIs:

ConnectedEntities [ {arrayAll the entities connected to this endpoint.
      EntityLinkread-onlyA link to the associated entity.
      EntityPciId {objectThe PCI ID of the connected entity.
            ClassCode (v1.2+)stringread-only (null)The Class Code, Subclass code, and Programming Interface code of this PCIe function.
            DeviceIdstringread-only (null)The Device ID of this PCIe function.
            FunctionNumber (v1.2+)integerread-only (null)The PCI ID of the connected entity.
            SubsystemIdstringread-only (null)The Subsystem ID of this PCIe function.
            SubsystemVendorIdstringread-only (null)The Subsystem Vendor ID of this PCIe function.
            VendorId
      }
stringread-only (null)The Vendor ID of this PCIe function.
      EntityRolestring
(enum)
read-only (null)The role of the connected entity.
See EntityRole in Property Details, below, for the possible values of this property.
      EntityTypestring
(enum)
read-only (null)The type of the connected entity.
See EntityType in Property Details, below, for the possible values of this property.
      Identifiers [ { } ]array (object)Identifiers for the remote entity. This type describes any additional identifiers for a resource.
See the Identifier object for details on this property.
      Oem { }objectSee the OEM object definition in the Common properties section.
      PciClassCode (deprecated v1.2)stringread-only (null)The Class Code, Subclass code, and Programming Interface code of this PCIe function. Deprecated v1.2+. This property has been deprecated in favor of the ClassCode property inside the EntityPciId object.
      PciFunctionNumber (deprecated v1.2)
} ]
integerread-only (null)The PCI ID of the connected entity. Deprecated v1.2+. This property has been deprecated in favor of the FunctionNumber property inside the EntityPciId object.
EndpointProtocolstring
(enum)
read-only (null)The protocol supported by this endpoint.
See EndpointProtocol in Property Details, below, for the possible values of this property.
HostReservationMemoryBytesinteger
(bytes)
read-only (null)The amount of memory in Bytes that the Host should allocate to connect to this endpoint.
Identifiers [ { } ]array (object)Identifiers for this endpoint. This type describes any additional identifiers for a resource.
See the Identifier object for details on this property.
IPTransportDetails (v1.1+) [ {arrayThis array contains details for each IP transport supported by this endpoint. The array structure can be used to model multiple IP addresses for this endpoint.
      IPv4Address { }objectThe IPv4 addresses assigned to the Endpoint.
See the IPv4Address object for details on this property.
      IPv6Address { }objectThe IPv6 addresses assigned to the Endpoint.
See the IPv6Address object for details on this property.
      Portnumberread-onlyThe UDP or TCP port number used by the Endpoint.
      TransportProtocol
} ]
string
(enum)
read-onlyThe protocol used by the connection entity.
See TransportProtocol in Property Details, below, for the possible values of this property.
Links {objectThe links object contains the links to other resources that are related to this resource.
      MutuallyExclusiveEndpoints [ {arrayAn array of references to the endpoints that may not be used in zones if this endpoint is used in a zone.
            @odata.id
      } ]
stringread-onlyLink to another Endpoint resource.
      NetworkDeviceFunction (v1.1+) [ {arrayWhen NetworkDeviceFunction resources are present, this array contains references to the network device function that connect to this endpoint.
            @odata.id
      } ]
stringread-onlyLink to a NetworkDeviceFunction resource. See the Links section and the NetworkDeviceFunction schema for details.
      Oem { }objectSee the OEM object definition in the Common properties section.
      Ports [ {arrayAn array of references to the the physical ports associated with this endpoint.
            @odata.id
      } ]
}
stringread-onlyLink to a Port resource. See the Links section and the Port schema for details.
PciId {objectThe PCI ID of the endpoint.
      ClassCode (v1.2+)stringread-only (null)The Class Code, Subclass code, and Programming Interface code of this PCIe function.
      DeviceIdstringread-only (null)The Device ID of this PCIe function.
      FunctionNumber (v1.2+)integerread-only (null)The PCI ID of the connected entity.
      SubsystemIdstringread-only (null)The Subsystem ID of this PCIe function.
      SubsystemVendorIdstringread-only (null)The Subsystem Vendor ID of this PCIe function.
      VendorId
}
stringread-only (null)The Vendor ID of this PCIe function.
Redundancy [ {arrayRedundancy information for the lower level endpoints supporting this endpoint.
      @odata.id
} ]
stringread-onlyThe unique identifier for a resource.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.

Property Details

EndpointProtocol:

The protocol supported by this endpoint.

stringDescription
AHCIAdvanced Host Controller Interface.
FCFibre Channel.
FCoEFibre Channel over Ethernet.
FCPFibre Channel Protocol for SCSI.
FICONFIbre CONnection (FICON).
FTPFile Transfer Protocol.
HTTPHypertext Transport Protocol.
HTTPSSecure Hypertext Transport Protocol.
I2CInter-Integrated Circuit Bus.
iSCSIInternet SCSI.
iWARPInternet Wide Area Remote Direct Memory Access Protocol.
NFSv3Network File System version 3.
NFSv4Network File System version 4.
NVMeNon-Volatile Memory Express.
NVMeOverFabricsNVMe over Fabrics.
OEMOEM specific.
PCIePCI Express.
RoCERDMA over Converged Ethernet Protocol.
RoCEv2RDMA over Converged Ethernet Protocol Version 2.
SASSerial Attached SCSI.
SATASerial AT Attachment.
SFTPSecure File Transfer Protocol.
SMBServer Message Block (aka CIFS Common Internet File System).
UHCIUniversal Host Controller Interface.
USBUniversal Serial Bus.

EntityRole:

The role of the connected entity.

stringDescription
BothThe entity is able to both send and receive commands, messages, or other types of requests to other entities on the fabric.
InitiatorThe entity sends commands, messages, or other types of requests to other entities on the fabric, but does not have the ability to recieve commands from other entities.
TargetThe entity receives commands, messages, or other types of requests from other entities on the fabric, but does not have the ability to send commands to other entities.

EntityType:

The type of the connected entity.

stringDescription
AccelerationFunction (v1.3+)The entity is an acceleration function realized through a device, such as an FPGA. The EntityLink property (if present) should be a AccelerationFunction.AccelerationFunction entity.
BridgeThe entity is a PCI(e) bridge.
DisplayControllerThe entity is a display controller.
DriveThe entity is a disk drive. The EntityLink property (if present) should be a Drive.Drive entity.
NetworkControllerThe entity is a network controller. The EntityLink property (if present) should be an EthernetInterface.EthernetInterface entity.
ProcessorThe entity is a processor device.
RootComplexThe entity is a PCI(e) root complex. The EntityLink property (if present) should be a ComputerSystem.ComputerSystem entity.
StorageExpanderThe entity is a storage expander. The EntityLink property (if present) should be a Chassis.Chassis entity.
StorageInitiatorThe entity is a storage initator. The EntityLink property (if present) should be a Storage.StorageController entity.
Volume (v1.1+)The entity is a volume. The EntityLink property (if present) should be a Volume.Volume entity.

TransportProtocol:

The protocol used by the connection entity.

stringDescription
AHCIAdvanced Host Controller Interface.
FCFibre Channel.
FCoEFibre Channel over Ethernet.
FCPFibre Channel Protocol for SCSI.
FICONFIbre CONnection (FICON).
FTPFile Transfer Protocol.
HTTPHypertext Transport Protocol.
HTTPSSecure Hypertext Transport Protocol.
I2CInter-Integrated Circuit Bus.
iSCSIInternet SCSI.
iWARPInternet Wide Area Remote Direct Memory Access Protocol.
NFSv3Network File System version 3.
NFSv4Network File System version 4.
NVMeNon-Volatile Memory Express.
NVMeOverFabricsNVMe over Fabrics.
OEMOEM specific.
PCIePCI Express.
RoCERDMA over Converged Ethernet Protocol.
RoCEv2RDMA over Converged Ethernet Protocol Version 2.
SASSerial Attached SCSI.
SATASerial AT Attachment.
SFTPSecure File Transfer Protocol.
SMBServer Message Block (aka CIFS Common Internet File System).
UHCIUniversal Host Controller Interface.
USBUniversal Serial Bus.

Example Response

{
    "@odata.type": "#Endpoint.v1_2_0.Endpoint",
    "Id": "Drive1",
    "Name": "SAS Drive",
    "Description": "The SAS Drive in Enclosure 2 Bay 0",
    "EndpointProtocol": "SAS",
    "ConnectedEntities": [
        {
            "EntityType": "Drive",
            "EntityRole": "Target",
            "Identifiers": [
                {
                    "DurableNameFormat": "NAA",
                    "DurableName": "32ADF365C6C1B7C3"
                }
            ],
            "Oem": {}
        }
    ],
    "Links": {
        "MutuallyExclusiveEndpoints": [
            {
                "@odata.id": "/redfish/v1/Fabrics/SAS/Endpoints/Enclosure2"
            }
        ],
        "Ports": [
            {
                "@odata.id": "/redfish/v1/Fabrics/SAS/Switches/Switch1/Ports/8"
            },
            {
                "@odata.id": "/redfish/v1/Fabrics/SAS/Switches/Switch2/Ports/8"
            }
        ],
        "Oem": {}
    },
    "Oem": {},
    "@odata.context": "/redfish/v1/$metadata#Endpoint.Endpoint",
    "@odata.id": "/redfish/v1/Fabrics/SAS/Endpoints/Drive1"
}

EthernetInterface 1.5.0

v1.5v1.4v1.3v1.2v1.1v1.0
2019.12017.32017.12016.32016.21.0

The EthernetInterface schema represents a single, logical ethernet interface or network interface controller (NIC).

URIs:

AutoNegbooleanread-write (null)This indicates if the speed and duplex are automatically negotiated and configured on this interface.
DHCPv4 (v1.4+) {objectDHCPv4 configuration for this interface.
      DHCPEnabledbooleanread-write (null)Determines whether DHCPv4 is enabled on this interface.
      FallbackAddress (v1.5+)string
(enum)
read-write (null)DHCPv4 fallback address method for this interface.
See FallbackAddress in Property Details, below, for the possible values of this property.
      UseDNSServersbooleanread-write (null)Determines whether to use DHCPv4-supplied DNS servers.
      UseDomainNamebooleanread-write (null)Determines whether to use a DHCPv4-supplied domain name.
      UseGatewaybooleanread-write (null)Determines whether to use a DHCPv4-supplied gateway.
      UseNTPServersbooleanread-write (null)Determines whether to use DHCPv4-supplied NTP servers.
      UseStaticRoutes
}
booleanread-write (null)Determines whether to use DHCPv4-supplied static routes.
DHCPv6 (v1.4+) {objectDHCPv6 configuration for this interface.
      OperatingModestring
(enum)
read-write (null)Determines the DHCPv6 operating mode for this interface.
See OperatingMode in Property Details, below, for the possible values of this property.
      UseDNSServersbooleanread-write (null)When enabled, DNS server addresses supplied through DHCPv6 stateless mode will be used.
      UseDomainNamebooleanread-write (null)When enabled, the domain name supplied through DHCPv6 stateless mode will be used.
      UseNTPServersbooleanread-write (null)When enabled, NTP server addresses supplied through DHCPv6 stateless mode will be used.
      UseRapidCommit
}
booleanread-write (null)Determines whether to use DHCPv6 rapid commit mode for stateful mode address assignments. Do not enable in networks where more than one DHCPv6 server is configured to provide address assignments.
FQDNstringread-write (null)This is the complete, fully qualified domain name obtained by DNS for this interface.
FullDuplexbooleanread-write (null)This indicates if the interface is in Full Duplex mode or not.
HostNamestringread-write (null)The DNS Host Name, without any domain information.
InterfaceEnabledbooleanread-write (null)This indicates whether this interface is enabled.
IPv4Addresses [ { } ]array (object)The IPv4 addresses currently assigned to this interface. This type describes an IPv4 Address.
See the IPv4Address object for details on this property.
IPv4StaticAddresses [ { } ]array (object)The IPv4 static addresses assigned to this interface. This type describes an IPv4 Address.
See the IPv4Address object for details on this property.
IPv6Addresses [ { } ]array (object)Enumerates in an array all of the currently assigned IPv6 addresses on this interface. This type describes an IPv6 Address.
See the IPv6Address object for details on this property.
IPv6AddressPolicyTable [ {arrayAn array representing the RFC 6724 Address Selection Policy Table.
      Labelintegerread-write (null)The IPv6 Label (as defined in RFC 6724 section 2.1).
      Precedenceintegerread-write (null)The IPv6 Precedence (as defined in RFC 6724 section 2.1.
      Prefix
} ]
stringread-write (null)The IPv6 Address Prefix (as defined in RFC 6724 section 2.1).
IPv6DefaultGatewaystringread-only (null)This is the IPv6 default gateway address that is currently in use on this interface.
IPv6StaticAddresses [ { } ]array (object)Represents in an array all of the IPv6 static addresses to be assigned on this interface. This object represents a single IPv6 static address to be assigned on a network interface.
See the IPv6StaticAddress object for details on this property.
IPv6StaticDefaultGateways [ { } ]array (object)The IPv6 static default gateways for this interface. This object represents a single IPv6 static address to be assigned on a network interface.
See the IPv6GatewayStaticAddress object (v1.1.0) for details on this property.
Links (v1.1+) {objectContains references to other resources that are related to this resource.
      Chassis (v1.3+) {objectA reference to the Chassis which contains this Ethernet Interface.
See the Chassis schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a Chassis resource. See the Links section and the Chassis schema for details.
      Endpoints [ {arrayAn array of references to the endpoints that connect to this ethernet interface.
            @odata.id
      } ]
stringread-onlyLink to a Endpoint resource. See the Links section and the Endpoint schema for details.
      HostInterface (v1.2+) {objectThis is a reference to a Host Interface that is associated with this Ethernet Interface.
See the HostInterface schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a HostInterface resource. See the Links section and the HostInterface schema for details.
      Oem { }
}
objectSee the OEM object definition in the Common properties section.
LinkStatus (v1.1+)string
(enum)
read-only (null)The link status of this interface (port).
See LinkStatus in Property Details, below, for the possible values of this property.
MACAddressstringread-write (null)This is the currently configured MAC address of the (logical port) interface.
MaxIPv6StaticAddressesintegerread-only (null)This indicates the maximum number of Static IPv6 addresses that can be configured on this interface.
MTUSizeintegerread-write (null)This is the currently configured Maximum Transmission Unit (MTU) in bytes on this interface.
NameServers [ ] array
(string)
read-onlyThis represents DNS name servers that are currently in use on this interface.
PermanentMACAddressstringread-only (null)This is the permanent MAC address assigned to this interface (port).
SpeedMbpsinteger
(Mbit/s)
read-write (null)This is the current speed in Mbps of this interface.
StatelessAddressAutoConfig (v1.4+) {objectStateless Address Automatic Configuration (SLAAC) parameters for this interface.
      IPv4AutoConfigEnabledbooleanread-write (null)Indicates whether IPv4 SLAAC is enabled for this interface.
      IPv6AutoConfigEnabled
}
booleanread-write (null)Indicates whether IPv6 SLAAC is enabled for this interface.
StaticNameServers (v1.4+) [ ] array
(string, null)
read-writeA statically defined set of DNS server IP addresses (both IPv4 and IPv6).
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
UefiDevicePathstringread-only (null)The UEFI device path for this interface.
VLAN {objectIf this Network Interface supports more than one VLAN, this property is not present. VLANs collections appear in the Link section of this resource.
See the VLanNetworkInterface schema for details on this property.
      @odata.id
}
stringread-onlyLink to a VLAN resource. See the Links section and the VLanNetworkInterface schema for details.
VLANs {objectThis is a reference to a collection of VLANs and is only used if the interface supports more than one VLANs.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of VLanNetworkInterface. See the VLanNetworkInterface schema for details.

Property Details

FallbackAddress:

DHCPv4 fallback address method for this interface.

stringDescription
AutoConfigFall back to an autoconfigured address.
NoneContinue attempting DHCP without a fallback address.
StaticFall back to a static address specified by IPv4StaticAddresses.

LinkStatus:

The link status of this interface (port).

stringDescription
LinkDownThere is no link on this interface, but the interface is connected.
LinkUpThe link is available for communication on this interface.
NoLinkThere is no link or connection detected on this interface.

OperatingMode:

Determines the DHCPv6 operating mode for this interface.

stringDescription
DisabledDHCPv6 is disabled.
StatefulDHCPv6 stateful mode.
StatelessDHCPv6 stateless mode.

Example Response

{
    "@odata.type": "#EthernetInterface.v1_4_1.EthernetInterface",
    "Id": "1",
    "Name": "Ethernet Interface",
    "Description": "Manager NIC 1",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "LinkStatus": "LinkUp",
    "PermanentMACAddress": "12:44:6A:3B:04:11",
    "MACAddress": "12:44:6A:3B:04:11",
    "SpeedMbps": 1000,
    "AutoNeg": true,
    "FullDuplex": true,
    "MTUSize": 1500,
    "HostName": "web483",
    "FQDN": "web483.contoso.com",
    "NameServers": [
        "names.contoso.com"
    ],
    "IPv4Addresses": [
        {
            "Address": "192.168.0.10",
            "SubnetMask": "255.255.252.0",
            "AddressOrigin": "DHCP",
            "Gateway": "192.168.0.1"
        }
    ],
    "DHCPv4": {
        "DHCPEnabled": true,
        "UseDNSServers": true,
        "UseGateway": true,
        "UseNTPServers": false,
        "UseStaticRoutes": true,
        "UseDomainName": true
    },
    "DHCPv6": {
        "OperatingMode": "Stateful",
        "UseDNSServers": true,
        "UseDomainName": false,
        "UseNTPServers": false,
        "UseRapidCommit": false
    },
    "StatelessAddressAutoConfig": {
        "IPv4AutoConfigEnabled": false,
        "IPv6AutoConfigEnabled": true
    },
    "IPv4StaticAddresses": [
        {
            "Address": "192.168.88.130",
            "SubnetMask": "255.255.0.0",
            "Gateway": "192.168.0.1"
        }
    ],
    "IPv6AddressPolicyTable": [
        {
            "Prefix": "::1/128",
            "Precedence": 50,
            "Label": 0
        }
    ],
    "MaxIPv6StaticAddresses": 1,
    "IPv6StaticAddresses": [
        {
            "Address": "fc00:1234::a:b:c:d",
            "PrefixLength": 64
        }
    ],
    "IPv6StaticDefaultGateways": [
        {
            "Address": "fe80::fe15:b4ff:fe97:90cd",
            "PrefixLength": 64
        }
    ],
    "IPv6DefaultGateway": "fe80::214:c1ff:fe4c:5c4d",
    "IPv6Addresses": [
        {
            "Address": "fe80::1ec1:deff:fe6f:1e24",
            "PrefixLength": 64,
            "AddressOrigin": "SLAAC",
            "AddressState": "Preferred",
            "Oem": {}
        },
        {
            "Address": "fc00:1234::a:b:c:d",
            "PrefixLength": 64,
            "AddressOrigin": "Static",
            "AddressState": "Preferred",
            "Oem": {}
        },
        {
            "Address": "2001:1:3:5::100",
            "PrefixLength": 64,
            "AddressOrigin": "DHCPv6",
            "AddressState": "Preferred",
            "Oem": {}
        },
        {
            "Address": "2002:2:5::1ec1:deff:fe6f:1e24",
            "PrefixLength": 64,
            "AddressOrigin": "SLAAC",
            "AddressState": "Preferred",
            "Oem": {}
        }
    ],
    "StaticNameServers": [
        "192.168.150.1",
        "fc00:1234:200:2500"
    ],
    "VLAN": {
        "VLANEnable": true,
        "VLANId": 101
    },
    "@odata.context": "/redfish/v1/$metadata#EthernetInterface.EthernetInterface",
    "@odata.id": "/redfish/v1/Systems/437XR1138R2/EthernetInterfaces/12446A3B0411"
}

Event 1.4.0

v1.4v1.3v1.2v1.1v1.0
2019.12018.22017.12016.11.0

The Event schema describes the JSON payload received by an Event Destination (which has subscribed to event notification) when events occurs. This resource contains data about event(s), including descriptions, severity and MessageId reference to a Message Registry that can be accessed for further information.

Context (v1.1+)stringread-onlyA context can be supplied at subscription time. This property is the context value supplied by the subscriber.
Events [ {array requiredEach event in this array has a set of properties that describe the event. Since this is an array, more than one event can be sent simultaneously.
      Actions (v1.2+) { }objectThe available actions for this resource.
      Context (deprecated v1.2)stringread-onlyA context can be supplied at subscription time. This property is the context value supplied by the subscriber. Deprecated v1.2+. Events are triggered independently from subscriptions to those events. This property has been Deprecated in favor of Event.v1_0_2.Event.Context
      EventGroupId (v1.3+)integerread-onlyThis value is the identifier used to correlate events that came from the same cause.
      EventIdstringread-onlyThis is a unique instance identifier of an event.
      EventTimestampstringread-onlyThis is time the event occurred.
      EventType (deprecated v1.3)string
(enum)
read-only requiredThis indicates the type of event sent, according to the definitions in the EventService.
See EventType in Property Details, below, for the possible values of this property. Deprecated v1.3+. This property has been deprecated. Starting Redfish Spec 1.6 (Event 1.3), subscriptions are based on RegistryId and ResourceType and not EventType.
      MemberIdstringread-only requiredThis is the identifier for the member within the collection.
      Messagestringread-onlyThis is the human readable message, if provided.
      MessageArgs [ ] array
(string)
read-onlyThis array of message arguments are substituted for the arguments in the message when looked up in the message registry.
      MessageIdstringread-only requiredThis is the key for this message which can be used to look up the message in a message registry.
      Oem { }objectSee the OEM object definition in the Common properties section.
      OriginOfCondition {objectThis indicates the resource that originated the condition that caused the event to be generated.
            @odata.id
      }
stringread-onlyThe unique identifier for a resource.
      Severity
} ]
stringread-onlyThis is the severity of the event.

Property Details

EventType:

This indicates the type of event sent, according to the definitions in the EventService.

stringDescription
AlertA condition exists which requires attention.
MetricReportA metric report managed by the Telemetry Service is being sent.
OtherAs of Redfish Specification v1.6, EventType has been deprecated. The event is therefore based on a Registry or Resource, not an EventType.
ResourceAddedA resource has been added.
ResourceRemovedA resource has been removed.
ResourceUpdatedThe value of this resource has been updated.
StatusChangeThe status of this resource has changed.

EventDestination 1.5.0

v1.5v1.4v1.3v1.2v1.1v1.0
2019.12018.22018.12017.12016.21.0

An Event Destination desribes the target of an event subscription, including the types of events subscribed and context to provide to the target in the Event payload.

URIs:

Contextstringread-write required (null)A client-supplied string that is stored with the event destination subscription.
Destinationstringread-only required on createThe URI of the destination Event Service.
EventFormatType (v1.4+)string
(enum)
read-only (null)Indicates the content types of the message that will be sent to the EventDestination.
See EventFormatType in Property Details, below, for the possible values of this property.
EventTypes [ ] array (string
(enum))
read-onlyThis property contains the types of events that will be sent to the destination.
See EventTypes in Property Details, below, for the possible values of this property.
HttpHeaders [ {arrayThis is for setting HTTP headers, such as authorization information. This object will be null or an empty array on a GET. An empty array is the preferred return value on GET.
      (pattern) { } [ ] array, boolean, integer, number, object, string (null)Property names follow regular expression pattern "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$"
      (pattern)
} ]
stringread-writeProperty names follow regular expression pattern "^[^:\\s]+$"
MessageIds (v1.1+) [ ] array
(string, null)
read-onlyA list of MessageIds that the service will only send. If this property is absent or the array is empty, then Events with any MessageId will be sent to the subscriber.
OriginResources (v1.1+) [ {arrayA list of resources for which the service will only send related events. If this property is absent or the array is empty, then Events originating from any resource will be sent to the subscriber.
      @odata.id
} ]
stringread-onlyThe unique identifier for a resource.
Protocolstring
(enum)
read-only required on createThe protocol type of the event connection.
See Protocol in Property Details, below, for the possible values of this property.
RegistryPrefixes (v1.4+) [ ] array
(string, null)
read-onlyA list of the Prefixes for the Message Registries that contain the MessageIds that will be sent to this event destination.
ResourceTypes (v1.4+) [ ] array
(string, null)
read-onlyA list of Resource Type values (Schema names) that correspond to the OriginOfCondition. The version and full namespace should not be specified.
SubordinateResources (v1.4+)booleanread-only (null)By setting this to true and specifying OriginResources, this indicates the subscription will be for events from the OriginsResources specified and also all subordinate resources. Note that resources associated via the Links section are not considered subordinate.
SubscriptionType (v1.3+)string
(enum)
read-only required (null)Indicates the subscription type for events.
See SubscriptionType in Property Details, below, for the possible values of this property.

Property Details

EventFormatType:

Indicates the content types of the message that will be sent to the EventDestination.

stringDescription
EventThe subscription destination will receive JSON Bodies of the Resource Type Event.
MetricReportThe subscription destination will receive JSON Bodies of the Resource Type MetricReport.

EventTypes:

This property contains the types of events that will be sent to the destination.

stringDescription
AlertA condition exists which requires attention.
MetricReportA metric report managed by the Telemetry Service is being sent.
OtherAs of Redfish Specification v1.6, EventType has been deprecated. The event is therefore based on a Registry or Resource, not an EventType.
ResourceAddedA resource has been added.
ResourceRemovedA resource has been removed.
ResourceUpdatedThe value of this resource has been updated.
StatusChangeThe status of this resource has changed.

Protocol:

The protocol type of the event connection.

stringDescription
RedfishThe destination follows the Redfish specification for event notifications.

SubscriptionType:

Indicates the subscription type for events.

stringDescription
RedfishEventThe subscription follows the Redfish specification for event notifications, which is done by a service sending an HTTP POST to the subscriber's destination URI.
SSEThe subscription follows the HTML5 Server-Sent Event definition for event notifications.

Example Response

{
    "@odata.type": "#EventDestination.v1_4_0.EventDestination",
    "Id": "1",
    "Name": "EventSubscription 1",
    "Destination": "http://www.dnsname.com/Destination1",
    "SubscriptionType": "RedfishEvent",
    "EventTypes": [
        "Alert"
    ],
    "Context": "WebUser3",
    "Protocol": "Redfish",
    "@odata.context": "/redfish/v1/$metadata#EventDestination.EventDestination",
    "@odata.id": "/redfish/v1/EventService/Subscriptions/1"
}

EventService 1.3.0

v1.3v1.2v1.1v1.0
2019.12018.22018.11.0

The Event Service resource contains properties for managing event subcriptions and generates the events sent to subscribers. The resource has links to the actual collection of subscriptions (called Event Destinations).

URIs:

DeliveryRetryAttemptsintegerread-writeThis is the number of attempts an event posting is retried before the subscription is terminated. This retry is at the service level, meaning the HTTP POST to the Event Destination was returned by the HTTP operation as unsuccessful (4xx or 5xx return code) or an HTTP timeout occurred this many times before the Event Destination subscription is terminated.
DeliveryRetryIntervalSecondsinteger
(seconds)
read-writeThis represents the number of seconds between retry attempts for sending any given Event.
EventFormatTypes [ ] array (string
(enum))
read-only (null)Indicates the content types of the message that this service can send to the event destination.
See EventFormatTypes in Property Details, below, for the possible values of this property.
EventTypesForSubscription [ ] array (string
(enum))
read-onlyThis is the types of Events that can be subscribed to.
See EventTypesForSubscription in Property Details, below, for the possible values of this property.
RegistryPrefixes (v1.2+) [ ] array
(string, null)
read-onlyA list of the Prefixes of the Message Registries that can be used for the RegistryPrefix property on a subscription. If this property is absent or contains an empty array, the service does not support RegistryPrefix-based subscriptions.
ResourceTypes (v1.2+) [ ] array
(string, null)
read-onlyA list of @odata.type values (Schema names) that can be specified in a ResourceType on a subscription. If this property is absent or contains an empty array, the service does not support ResourceType-based subscriptions.
ServerSentEventUri (v1.1+)stringread-onlyLink to a URI for receiving Sever Sent Event representations of the events generated by this service.
ServiceEnabledbooleanread-write (null)This indicates whether this service is enabled.
SSEFilterPropertiesSupported (v1.2+) {objectContains a set of properties that indicate which properties are supported in the $filter query parameter for the ServerSentEventUri.
      EventFormatTypebooleanread-onlyThis indicates if the EventFormatType property is supported.
      EventType (deprecated v1.3)booleanread-onlyThis indicates if the EventType property is supported. Deprecated v1.3+. This property has been deprecated. Starting Redfish Spec 1.6 (Event 1.3), subscriptions are based on RegistryId and ResourceType and not EventType.
      MessageIdbooleanread-onlyThis indicates if the MessageId property is supported.
      MetricReportDefinitionbooleanread-onlyThis indicates if the MetricReportDefinition property is supported.
      OriginResourcebooleanread-onlyThis indicates if the OriginResource property is supported.
      RegistryPrefixbooleanread-onlyThis indicates if the RegistryPrefix property is supported.
      ResourceType
}
booleanread-onlyThis indicates if the ResourceType property is supported.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
SubordinateResourcesSupported (v1.2+)booleanread-only (null)This indicates if the service supports the SubordinateResource property on Event Subscriptions.
Subscriptions {objectThis is a reference to a collection of Event Destination resources.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of EventDestination. See the EventDestination schema for details.

Actions

SubmitTestEvent

This action is used to generate a test event.

URIs:

The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.

{
      EventGroupIdintegerread-writeThis is the group ID of the event to be added.
      EventIdstringread-write requiredThis is the ID of event to be added.
      EventTimestampstringread-write requiredThis is the time stamp of event to be added.
      EventTypestring
(enum)
read-writeThis is the type of event to be added.
See EventType in Property Details, below, for the possible values of this property.
      Messagestringread-write requiredThis is the human readable message of event to be added.
      MessageArgs [ ] array
(string)
read-write requiredThis is the array of message arguments of the event to be added.
      MessageIdstringread-write requiredThis is the message ID of event to be added.
      OriginOfConditionstringread-write requiredThis is the string of the URL within the OriginOfCondition property of the event to be added. It is not a reference object.
      Severity
}
stringread-write requiredThis is the Severity of event to be added.

Property Details

EventFormatTypes:

Indicates the content types of the message that this service can send to the event destination.

stringDescription
EventThe subscription destination will receive JSON Bodies of the Resource Type Event.
MetricReportThe subscription destination will receive JSON Bodies of the Resource Type MetricReport.

EventType:

This is the type of event to be added.

stringDescription
AlertA condition exists which requires attention.
MetricReportA metric report managed by the Telemetry Service is being sent.
OtherAs of Redfish Specification v1.6, EventType has been deprecated. The event is therefore based on a Registry or Resource, not an EventType.
ResourceAddedA resource has been added.
ResourceRemovedA resource has been removed.
ResourceUpdatedThe value of this resource has been updated.
StatusChangeThe status of this resource has changed.

EventTypesForSubscription:

This is the types of Events that can be subscribed to.

stringDescription
AlertA condition exists which requires attention.
MetricReportA metric report managed by the Telemetry Service is being sent.
OtherAs of Redfish Specification v1.6, EventType has been deprecated. The event is therefore based on a Registry or Resource, not an EventType.
ResourceAddedA resource has been added.
ResourceRemovedA resource has been removed.
ResourceUpdatedThe value of this resource has been updated.
StatusChangeThe status of this resource has changed.

Example Response

{
    "@odata.type": "#EventService.v1_2_0.EventService",
    "Id": "EventService",
    "Name": "Event Service",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "ServiceEnabled": true,
    "DeliveryRetryAttempts": 3,
    "DeliveryRetryIntervalSeconds": 60,
    "ServerSentEventUri": "/redfish/v1/EventService/SSE",
    "EventTypesForSubscription": [
        "StatusChange",
        "ResourceUpdated",
        "ResourceAdded",
        "ResourceRemoved",
        "Alert"
    ],
    "Subscriptions": {
        "@odata.id": "/redfish/v1/EventService/Subscriptions"
    },
    "Actions": {
        "#EventService.SubmitTestEvent": {
            "target": "/redfish/v1/EventService/Actions/EventService.SubmitTestEvent",
            "EventType@Redfish.AllowableValues": [
                "StatusChange",
                "ResourceUpdated",
                "ResourceAdded",
                "ResourceRemoved",
                "Alert"
            ]
        },
        "Oem": {}
    },
    "Oem": {},
    "@odata.context": "/redfish/v1/$metadata#EventService.EventService",
    "@odata.id": "/redfish/v1/EventService"
}

ExternalAccountProvider 1.1.1

v1.1v1.0
2018.32018.1

A remote service that can provide accounts for this manager to utilize for authentication.

URIs:

AccountProviderTypestring
(enum)
read-only required on create (null)This property contains the type of external account provider this resource references.
See AccountProviderType in Property Details, below, for the possible values of this property.
Authentication {objectThis property contains the authentication information for the external account provider.
      AuthenticationTypestring
(enum)
read-write (null)This property contains the type of authentication used to connect to the external account provider.
See AuthenticationType in Property Details, below, for the possible values of this property.
      KerberosKeytabstringread-write (null)This property is used with a PATCH or PUT to write a base64 encoded version of the kerberos keytab for the account. This property is null on a GET.
      Oem { }objectSee the OEM object definition in the Common properties section.
      Passwordstringread-write (null)This property is used with a PATCH or PUT to write the password for the account service. This property is null on a GET.
      Tokenstringread-write (null)This property is used with a PATCH or PUT to write the token for the account. This property is null on a GET.
      Username
}
stringread-writeThis property contains the user name for the account service.
Certificates (v1.1+) {objectThis is a reference to a collection of certificates used for the external account provider.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of Certificate. See the Certificate schema for details.
LDAPService {objectThis property contains additional mapping information needed to parse a generic LDAP service.
      Oem { }objectSee the OEM object definition in the Common properties section.
      SearchSettings {objectThis property contains the settings needed to search an external LDAP service.
            BaseDistinguishedNames [ ] array
(string, null)
read-writeThe base distinguished names to use when searching the LDAP service.
            GroupNameAttributestringread-write (null)The attribute name that contains the name of the Group on the group LDAP entry.
            GroupsAttributestringread-write (null)The attribute name that contains the Groups for a user on the user LDAP entry.
            UsernameAttribute
      }
}
stringread-write (null)The attribute name that contains the Username on the user LDAP entry.
Links {objectContains references to other resources that are related to this resource.
      Oem { }
}
objectSee the OEM object definition in the Common properties section.
RemoteRoleMapping [ {arrayThis property contains a collection of the mapping rules to convert the external account providers account information to the local Redfish Role.
      LocalRolestringread-write (null)The name of the local role in which to map the remote user or group.
      Oem { }objectSee the OEM object definition in the Common properties section.
      RemoteGroupstringread-write (null)This property is the name of the remote group (or in the case of a Redfish Service, remote role) that will be mapped to the local role referenced by this entity.
      RemoteUser
} ]
stringread-write (null)This property is the name of the remote user that will be mapped to the local role referenced by this entity.
ServiceAddresses [ ] array
(string, null)
read-writeThis property contains the addresses of the user account providers this resource references. The format of this field depends on the Type.
ServiceEnabledbooleanread-write (null)This indicates whether this service is enabled.

Property Details

AccountProviderType:

This property contains the type of external account provider this resource references.

stringDescription
ActiveDirectoryServiceAn external Active Directory Service.
LDAPServiceA generic external LDAP Service.
OEMAn OEM specific external authentication or directory service.
RedfishServiceAn external Redfish Service.

AuthenticationType:

This property contains the type of authentication used to connect to the external account provider.

stringDescription
KerberosKeytabA kerberos keytab.
OEMAn OEM specific authentication mechanism.
TokenAn opaque authentication token.
UsernameAndPasswordUsername and password combination.

Example Response

{
    "@odata.type": "#ExternalAccountProvider.v1_0_1.ExternalAccountProvider",
    "Id": "ExternalRedfishService",
    "Name": "Remote Redfish Service",
    "Description": "Remote Redfish Service providing additional Accounts to this Redfish Service",
    "AccountProviderType": "RedfishService",
    "ServiceAddresses": [
        "http://redfish.dmtf.org/redfish/v1/AccountService"
    ],
    "Authentication": {
        "AuthenticationType": "Token",
        "Token": null
    },
    "RemoteRoleMapping": [
        {
            "RemoteGroup": "Admin",
            "LocalRole": "Administrator"
        },
        {
            "RemoteGroup": "Operator",
            "LocalRole": "Operator"
        },
        {
            "RemoteGroup": "ReadOnly",
            "LocalRole": "ReadOnly"
        }
    ],
    "@odata.context": "/redfish/v1/$metadata#ExternalAccountProvider.ExternalAccountProvider",
    "@odata.id": "/redfish/v1/AccountService/ExternalAccountProviders/ExternalRedfishService"
}

Fabric 1.0.5

v1.0
2016.2

The Fabric schema represents a simple fabric consisting of one or more switches, zero or more endpoints, and zero or more zones.

URIs:

Endpoints {objectA collection of references to the endpoints contained in this fabric.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of Endpoint. See the Endpoint schema for details.
FabricTypestring
(enum)
read-only (null)The protocol being sent over this fabric.
See FabricType in Property Details, below, for the possible values of this property.
Links {objectContains references to other resources that are related to this resource.
      Oem { }
}
objectSee the OEM object definition in the Common properties section.
MaxZonesintegerread-only (null)The value of this property shall contain the maximum number of zones the switch can currently configure.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
Switches {objectA collection of references to the switches contained in this fabric.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of Switch. See the Switch schema for details.
Zones {objectA collection of references to the zones contained in this fabric.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of Zone. See the Zone schema for details.

Property Details

FabricType:

The protocol being sent over this fabric.

stringDescription
AHCIAdvanced Host Controller Interface.
FCFibre Channel.
FCoEFibre Channel over Ethernet.
FCPFibre Channel Protocol for SCSI.
FICONFIbre CONnection (FICON).
FTPFile Transfer Protocol.
HTTPHypertext Transport Protocol.
HTTPSSecure Hypertext Transport Protocol.
I2CInter-Integrated Circuit Bus.
iSCSIInternet SCSI.
iWARPInternet Wide Area Remote Direct Memory Access Protocol.
NFSv3Network File System version 3.
NFSv4Network File System version 4.
NVMeNon-Volatile Memory Express.
NVMeOverFabricsNVMe over Fabrics.
OEMOEM specific.
PCIePCI Express.
RoCERDMA over Converged Ethernet Protocol.
RoCEv2RDMA over Converged Ethernet Protocol Version 2.
SASSerial Attached SCSI.
SATASerial AT Attachment.
SFTPSecure File Transfer Protocol.
SMBServer Message Block (aka CIFS Common Internet File System).
UHCIUniversal Host Controller Interface.
USBUniversal Serial Bus.

Example Response

{
    "@odata.type": "#Fabric.v1_0_4.Fabric",
    "Id": "SAS",
    "Name": "SAS Fabric",
    "FabricType": "SAS",
    "Description": "A SAS Fabric with redundant switches connected to two initiators",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "Zones": {
        "@odata.id": "/redfish/v1/Fabrics/SAS/Zones"
    },
    "Endpoints": {
        "@odata.id": "/redfish/v1/Fabrics/SAS/Endpoints"
    },
    "Switches": {
        "@odata.id": "/redfish/v1/Fabrics/SAS/Switches"
    },
    "Links": {
        "Oem": {}
    },
    "Actions": {
        "Oem": {}
    },
    "Oem": {},
    "@odata.context": "/redfish/v1/$metadata#Fabric.Fabric",
    "@odata.id": "/redfish/v1/Fabrics/SAS"
}

HostInterface 1.2.1

v1.2v1.1v1.0
2018.22017.12016.3

This schema defines a single Host Interface resource.

URIs:

AuthenticationModes [ ] array (string
(enum))
read-writeIndicates the authentication modes available on this interface.
See AuthenticationModes in Property Details, below, for the possible values of this property.
AuthNoneRoleId (v1.2+)stringread-writeThe Role used when no authentication on this interface is used.
ExternallyAccessiblebooleanread-only (null)Indicates whether this interface is accessible by external entities.
FirmwareAuthEnabledbooleanread-write (null)Indicates whether this firmware authentication is enabled for this interface.
FirmwareAuthRoleIdstringread-writeThe Role used for firmware authentication on this interface.
HostEthernetInterfaces {objectThe Redfish link to the collection of network interface controllers or cards (NICs) that a Computer System uses to communicate with this Host Interface.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of EthernetInterface. See the EthernetInterface schema for details.
HostInterfaceTypestring
(enum)
read-only (null)Indicates the Host Interface type for this interface.
See HostInterfaceType in Property Details, below, for the possible values of this property.
InterfaceEnabledbooleanread-write (null)Indicates whether this interface is enabled.
KernelAuthEnabledbooleanread-write (null)Indicates whether this kernel authentication is enabled for this interface.
KernelAuthRoleIdstringread-writeThe Role used for kernel authentication on this interface.
Links {objectContains references to other resources that are related to this resource.
      AuthNoneRole (v1.2+) {objectA reference to the Role that contains the privileges on this Host Interface when no authentication is performed.
See the Role schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a Role resource. See the Links section and the Role schema for details.
      ComputerSystems [ {arrayAn array of references to the Computer Systems connected to this Host Interface.
            @odata.id
      } ]
stringread-onlyLink to a ComputerSystem resource. See the Links section and the ComputerSystem schema for details.
      FirmwareAuthRole {objectA reference to the Role that has firmware authentication privileges on this Host Interface.
See the Role schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a Role resource. See the Links section and the Role schema for details.
      KernelAuthRole {objectA reference to the Role object defining Privileges for this Host Interface when using kernel authentication.
See the Role schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a Role resource. See the Links section and the Role schema for details.
      Oem { }
}
objectSee the OEM object definition in the Common properties section.
ManagerEthernetInterface {objectThe Redfish link to a single network interface controllers or cards (NIC) that this Manager uses for network communication with this Host Interface.
See the EthernetInterface schema for details on this property.
      @odata.id
}
stringread-onlyLink to a EthernetInterface resource. See the Links section and the EthernetInterface schema for details.
NetworkProtocol {objectThe Redfish link to the network services and their settings that the Manager controls. It is here that clients will find network configuration options as well as network services.
See the ManagerNetworkProtocol schema for details on this property.
      @odata.id
}
stringread-onlyLink to a ManagerNetworkProtocol resource. See the Links section and the ManagerNetworkProtocol schema for details.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.

Property Details

AuthenticationModes:

Indicates the authentication modes available on this interface.

stringDescription
AuthNoneRequests without any sort of authentication are allowed.
BasicAuthRequests using HTTP Basic Authentication are allowed.
OemAuthRequests using OEM authentication mechanisms are allowed.
RedfishSessionAuthRequests using Redfish Session Authentication are allowed.

HostInterfaceType:

Indicates the Host Interface type for this interface.

stringDescription
NetworkHostInterfaceThis interface is a Network Host Interface.

Example Response

{
    "@odata.context": "/redfish/v1/$metadata#HostInterface.HostInterface",
    "@odata.id": "/redfish/v1/Managers/BMC/HostInterfaces/1",
    "@odata.type": "#HostInterface.v1_0_0.HostInterface",
    "Id": "1",
    "Name": "Host Interface",
    "Description": "Management Host Interface",
    "HostInterfaceType": "NetworkHostInterface",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "InterfaceEnabled": true,
    "ExternallyAccessible": false,
    "AuthenticationModes": [
        "AuthNone",
        "BasicAuth",
        "RedfishSessionAuth",
        "OemAuth"
    ],
    "KernelAuthRoleId": "Administrator",
    "KernelAuthEnabled": true,
    "FirmwareAuthRoleId": "Administrator",
    "FirmwareAuthEnabled": true,
    "HostEthernetInterfaces": {
        "@odata.id": "/redfish/v1/Managers/BMC/HostInterfaces/1/HostEthernetInterfaces"
    },
    "ManagerEthernetInterface": {
        "@odata.id": "/redfish/v1/Managers/BMC/EthernetInterfaces/ToHost"
    },
    "NetworkProtocol": {
        "@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol"
    },
    "Links": {
        "ComputerSystems": [
            {
                "@odata.id": "/redfish/v1/Systems/ORD144"
            }
        ],
        "KernelAuthRole": {
            "@odata.id": "/redfish/v1/AccountService/Roles/Administrator"
        },
        "FirmwareAuthRole": {
            "@odata.id": "/redfish/v1/AccountService/Roles/Administrator"
        }
    },
    "Oem": {}
}

Job 1.0.2

v1.0
2018.2

This resource contains information about a specific Job scheduled or being executed by a Redfish service's Job Service. Jobs are created by clients for describing a series of operations to take place at periodic intervals.

URIs:

CreatedBystringread-onlyThe person or program that created this job entry.
EndTimestringread-only (null)The date-time stamp that the job was completed.
HidePayloadbooleanread-onlyIndicates that the contents of the Payload should be hidden from view after the Job has been created. When set to True, the Payload object will not be returned on GET.
JobStatestring
(enum)
read-writeThe state of the job.
See JobState in Property Details, below, for the possible values of this property.
JobStatusstring
(enum)
read-onlyThe status of the job.
See JobStatus in Property Details, below, for the possible values of this property.
MaxExecutionTimestringread-write (null)The maximum amount of time the job is allowed to execute.
Messages [ { } ]array (object)This is an array of messages associated with the job. This type describes a Message returned by the Redfish service.
See the Message object for details on this property.
Payload {objectThe HTTP and JSON payload details for this job.
      HttpHeaders [ ] array
(string)
read-onlyThis represents the HTTP headers used in the operation of this job.
      HttpOperationstringread-onlyThe HTTP operation to perform to execute this job.
      JsonBodystringread-onlyThis property contains the JSON payload to use in the execution of this Job.
      TargetUri
}
stringread-onlyThe URI of the target for this job.
PercentCompleteinteger
(%)
read-only (null)The completion percentage of this job.
Schedule { }objectThe Schedule Settings for this Job.
See the Schedule object for details on this property.
StartTimestringread-onlyThe date-time stamp that the job was started or is scheduled to start.
StepOrder [ ] array
(string)
read-onlyThis represents the serialized execution order of the Job Steps.
Steps {objectA link to a collection of Steps for this Job.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of Job. See the Job schema for details.

Property Details

JobState:

The state of the job.

stringDescription
CancelledJob was cancelled..
CompletedJob has completed.
ContinueJob is to resume operation.
ExceptionJob has stopped due to an exception condition.
InterruptedJob has been interrupted.
NewA new job.
PendingJob is pending and has not started.
RunningJob is running normally.
ServiceJob is running as a service.
StartingJob is starting.
StoppingJob is in the process of stopping.
SuspendedJob has been suspended.
UserInterventionJob is waiting for user intervention.

JobStatus:

The status of the job.

stringDescription
CriticalA critical condition exists that requires immediate attention.
OKNormal.
WarningA condition exists that requires attention.

Example Response

{
    "@odata.type": "#Job.v1_0_0.Job",
    "Id": "RebootRack",
    "Name": "Scheduled Nightly Reboot of the rack",
    "JobStatus": "OK",
    "JobState": "Running",
    "StartTime": "2018-04-01T00:01+6:00",
    "PercentComplete": 24,
    "Schedule": {
        "Lifetime": "P4Y",
        "InitialStartTime": "2018-01-01T01:00:00+06:00",
        "RecurrenceInterval": "P1D",
        "EnabledDaysOfWeek": [
            "Monday",
            "Tuesday",
            "Wednesday",
            "Thursday",
            "Friday"
        ]
    },
    "Steps": {
        "@odata.id": "/redfish/v1/JobService/Jobs/RebootRack/Steps"
    },
    "StepOrder": [
        "Red",
        "Orange",
        "Yellow",
        "Green",
        "Blue",
        "Indigo",
        "Violet"
    ],
    "@odata.context": "/redfish/v1/$metadata#Job.Job",
    "@odata.id": "/redfish/v1/JobService/Jobs/RebootRack"
}

JobService 1.0.1

v1.0
2018.2

The Job Service of a Redfish service allows scheduling and execution of operations. It represents the properties for the Job Service itself and has links to the actual collection of Job resources.

URIs:

DateTimestringread-only (null)The current DateTime (with offset) setting that the job service is using.
Jobs {objectReferences to the Jobs collection.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of Job. See the Job schema for details.
Log {objectThis is a reference to a Log Service used by the Job Service.
See the LogService schema for details on this property.
      @odata.id
}
stringread-onlyLink to a LogService resource. See the Links section and the LogService schema for details.
ServiceCapabilities {objectThis object describes the supported capabilities of this Job Service implementation.
      MaxJobsintegerread-only (null)Maximum number of Jobs supported.
      MaxStepsintegerread-only (null)Maximum number of Job Steps supported.
      Scheduling
}
booleanread-only (null)Indicates whether scheduling of Jobs is supported.
ServiceEnabledbooleanread-write (null)This indicates whether this service is enabled.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.

Example Response

{
    "@odata.type": "#JobService.v1_0_0.JobService",
    "Id": "JobService",
    "Name": "Job Service",
    "DateTime": "2018-06-13T04:14+06:00",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "ServiceEnabled": true,
    "ServiceCapabilities": {
        "MaxJobs": 100,
        "MaxSteps": 50,
        "Scheduling": true
    },
    "Jobs": {
        "@odata.id": "/redfish/v1/JobService/Jobs"
    },
    "Log": {
        "@odata.id": "/redfish/v1/JobService/Log"
    },
    "Actions": {
        "Oem": {
            "#Contoso.EasyButton": {
                "target": "/redfish/v1/JobService/Contoso.EasyButton",
                "@Redfish.ActionInfo": "/redfish/v1/JobService/EasyButtonActionInfo"
            }
        }
    },
    "Oem": {},
    "@odata.context": "/redfish/v1/$metadata/JobService.JobService",
    "@odata.id": "/redfish/v1/JobService"
}

JsonSchemaFile 1.1.3

v1.1v1.0
2017.11.0

This is the schema definition for the Schema File locator resource.

URIs:

Languages [ ] array
(string)
read-only requiredLanguage codes for the schemas available.
Location [ {array requiredLocation information for this schema file.
      ArchiveFilestringread-onlyIf the schema is hosted on the service in an archive file, this is the name of the file within the archive.
      ArchiveUristringread-onlyIf the schema is hosted on the service in an archive file, this is the link to the archive file.
      Languagestringread-onlyThe language code for the file the schema is in.
      PublicationUristringread-onlyLink to publicly available (canonical) URI for schema.
      Uri
} ]
stringread-onlyLink to locally available URI for schema.
Schemastringread-only requiredThe @odata.type name this schema describes.

Example Response

{
    "@odata.type": "#JsonSchemaFile.v1_1_1.JsonSchemaFile",
    "Id": "Chassis.v1_7_0",
    "Name": "Chassis Schema File",
    "Description": "Chassis Schema File Location",
    "Languages": [
        "en"
    ],
    "Schema": "#Chassis.v1_7_0.Chassis",
    "Oem": {},
    "Location": [
        {
            "Language": "en",
            "ArchiveUri": "/Schemas.gz",
            "PublicationUri": "http://redfish.dmtf.org/schemas/v1/Chassis.v1_7_0.json",
            "ArchiveFile": "Chassis.v1_7_0.json"
        },
        {
            "Language": "zh",
            "ArchiveUri": "/Schemas.zh.gz",
            "PublicationUri": "http://schemas.contoso.com/Chassis.v1_7_0.zh.json",
            "ArchiveFile": "Chassis.v1_7_0.zh.json"
        },
        {
            "Language": "xy",
            "Uri": "/redfish/v1/JsonSchemas/Chassis.v1_7_0.xy.json",
            "PublicationUri": "http://schemas.contoso.com/Chassis.v1_7_0.xy.json"
        }
    ],
    "@odata.context": "/redfish/v1/$metadata#JsonSchemaFile.JsonSchemaFile",
    "@odata.id": "/redfish/v1/JsonSchemas/Chassis.v1_7_0"
}

LogEntry 1.4.2

v1.4v1.3v1.2v1.1v1.0
2018.22017.32017.12016.21.0

This resource defines the record format for a log. It is designed to be used for SEL logs (from IPMI) as well as Event Logs and OEM-specific log formats. The EntryType field indicates the type of log and the resource includes several additional properties dependent on the EntryType.

URIs:

Createdstringread-onlyThe time the log entry was created.
EntryCodestring
(enum)
read-only (null)If the EntryType is SEL, this will have the entry code for the log entry.
See EntryCode in Property Details, below, for the possible values of this property.
EntryTypestring
(enum)
read-only requiredThis is the type of log entry.
See EntryType in Property Details, below, for the possible values of this property.
EventGroupId (v1.4+)integerread-only (null)This value is the identifier used to correlate events that came from the same cause.
EventId (v1.1+)stringread-onlyThis is a unique instance identifier of an event.
EventTimestamp (v1.1+)stringread-onlyThis is time the event occurred.
EventType (v1.1+, deprecated v1.4)string
(enum)
read-onlyThis indicates the type of an event recorded in this log.
See EventType in Property Details, below, for the possible values of this property. Deprecated v1.4+. This property has been deprecated. Starting Redfish Spec 1.6 (Event 1.3), subscriptions are based on RegistryId and ResourceType and not EventType.
Links {objectContains references to other resources that are related to this resource.
      Oem { }objectSee the OEM object definition in the Common properties section.
      OriginOfCondition {objectThis is the URI of the resource that caused the log entry.
            @odata.id
      }
}
stringread-onlyThe unique identifier for a resource.
Messagestringread-only (null)This property decodes from EntryType. If the EntryType is Event, then it is a message string. Otherwise, it is SEL or OEM specific. In most cases, this will be the actual Log Entry.
MessageArgs [ ] array
(string)
read-onlyThe values of this property shall be any arguments for the message.
MessageIdstringread-onlyThis property decodes from EntryType. If the EntryType is Event, then it is a message id. If the EntryType is SEL, then it contains the Event Data. Otherwise, it is OEM specific. This value is only used for registries - for more information, see the specification.
OemLogEntryCode (v1.3+)stringread-only (null)If the LogEntryCode type is OEM, this will contain the OEM-specific entry code.
OemRecordFormatstringread-only (null)If the EntryType is Oem, this will contain more information about the record format from the Oem.
OemSensorType (v1.3+)stringread-only (null)If the Sensor Type is OEM, this will contain the OEM-specific sensor type.
SensorNumberintegerread-only (null)This property decodes from EntryType. If the EntryType is SEL, it is the sensor number. If the EntryType is Event, then the count of events. Otherwise, it is OEM specific.
SensorTypestring
(enum)
read-only (null)If the EntryType is SEL, this will have the sensor type that the log entry pertains to.
See SensorType in Property Details, below, for the possible values of this property.
Severitystring
(enum)
read-only (null)This is the severity of the log entry.
See Severity in Property Details, below, for the possible values of this property.

Property Details

EntryCode:

If the EntryType is SEL, this will have the entry code for the log entry.

stringDescription
AssertThe condition has been asserted.
D0 Power StateThe ACPI defined D0 Power State.
D1 Power StateThe ACPI defined D1 Power State.
D2 Power StateThe ACPI defined D2 Power State.
D3 Power StateThe ACPI defined D3 Power State.
DeassertThe condition has been deasserted.
Device DisabledA device has been disabled.
Device EnabledA device has been enabled.
Device Inserted / Device PresentA device has been inserted or is now present.
Device Removed / Device AbsentA device has been removed or is now absent.
Fully RedundantIndicates that full redundancy has been regained.
InformationalAn Informational event.
Install ErrorAn Install Error has been detected.
Limit ExceededA limit has been exceeded.
Limit Not ExceededA limit has not been exceeded.
Lower Critical - going highThe reading crossed the Lower Critical threshold while going high.
Lower Critical - going lowThe reading crossed the Lower Critical threshold while going low.
Lower Non-critical - going highThe reading crossed the Lower Non-critical threshold while going high.
Lower Non-critical - going lowThe reading crossed the Lower Non-critical threshold while going low.
Lower Non-recoverable - going highThe reading crossed the Lower Non-recoverable threshold while going high.
Lower Non-recoverable - going lowThe reading crossed the Lower Non-recoverable threshold while going low.
MonitorA Monitor event.
Non-redundant:Insufficient ResourcesUnit is non-redundant and has insufficient resource to maintain normal operation.
Non-redundant:Sufficient Resources from Insufficient ResourcesUnit has regianed minimum resources needed for normal operation.
Non-redundant:Sufficient Resources from RedundantRedundancy has been lost but unit is functioning with minimum resources needed for normal operation.
OEM (v1.3+)An OEM defined event.
Performance LagsPerformance does not meet expectations.
Performance MetPerformance meets expectations.
Predictive Failure assertedA Predictive Failure has been detected.
Predictive Failure deassertedA Predictive Failure is no longer present.
Redundancy DegradedRedundancy still exists, but at less than full level.
Redundancy Degraded from Fully RedundantUnit has lost some redundant resource(s) but is still in a redundant state.
Redundancy Degraded from Non-redundantUnit has regained some resource(s) and is redundant but not fully redundant.
Redundancy LostEntered any non-redundant state, including Non-redundant: Insufficient Resources.
State AssertedThe state has been asserted.
State DeassertedThe state has been deasserted.
Transition to ActiveThe state transitioned to active.
Transition to BusyThe state transitioned to busy.
Transition to Critical from less severeA state has changed to Critical from less severe.
Transition to Critical from Non-recoverableA state has changed to Critical from Non-recoverable.
Transition to DegradedA state has transitioned to Degraded.
Transition to IdleThe state transitioned to idle.
Transition to In TestA state has transitioned to In Test.
Transition to Non-Critical from more severeA state has changed to Non-Critical from more severe.
Transition to Non-Critical from OKA state has changed to Non-Critical from OK.
Transition to Non-recoverableA state has changed to Non-recoverable.
Transition to Non-recoverable from less severeA state has changed to Non-recoverable from less severe.
Transition to Off DutyA state has transitioned to Off Duty.
Transition to Off LineA state has transitioned to Off Line.
Transition to OKA state has changed to OK.
Transition to On LineA state has transitioned to On Line.
Transition to Power OffA state has transitioned to Power Off.
Transition to Power SaveA state has transitioned to Power Save.
Transition to RunningA state has transitioned to Running.
Upper Critical - going highThe reading crossed the Upper Critical threshold while going high.
Upper Critical - going lowThe reading crossed the Upper Critical threshold while going low.
Upper Non-critical - going highThe reading crossed the Upper Non-critical threshold while going high.
Upper Non-critical - going lowThe reading crossed the Upper Non-critical threshold while going low.
Upper Non-recoverable - going highThe reading crossed the Upper Non-recoverable threshold while going high.
Upper Non-recoverable - going lowThe reading crossed the Upper Non-recoverable threshold while going low.

EntryType:

This is the type of log entry.

stringDescription
EventContains a Redfish-defined message (event).
OemContains an entry in an OEM-defined format.
SELContains a legacy IPMI System Event Log (SEL) entry.

EventType:

This indicates the type of an event recorded in this log.

stringDescription
AlertA condition exists which requires attention.
MetricReportA metric report managed by the Telemetry Service is being sent.
OtherAs of Redfish Specification v1.6, EventType has been deprecated. The event is therefore based on a Registry or Resource, not an EventType.
ResourceAddedA resource has been added.
ResourceRemovedA resource has been removed.
ResourceUpdatedThe value of this resource has been updated.
StatusChangeThe status of this resource has changed.

SensorType:

If the EntryType is SEL, this will have the sensor type that the log entry pertains to.

stringDescription
Add-in CardA sensor for an add-in card.
BaseOSBoot/InstallationStatusA sensor for a base OS boot or installation status event.
BatteryA sensor for a battery.
Boot ErrorA sensor for a boot error event.
Button/SwitchA sensor for a button or switch.
Cable/InterconnectA sensor for a cable or interconnect type of device.
ChassisA sensor for a chassis.
ChipSetA sensor for a chipset.
CoolingDeviceA sensor for a cooling device.
Critical InterruptA sensor for a critical interrupt event.
CurrentA current sensor.
Drive Slot/BayA sensor for a drive slot or bay.
Entity PresenceA sensor for an entity presence event.
Event Logging DisabledA sensor for the event log.
FanA fan sensor.
FRUStateA sensor for a FRU state event.
LANA sensor for a LAN device.
Management Subsystem HealthA sensor for a management subsystem health event.
MemoryA sensor for a memory device.
Microcontroller/CoprocessorA sensor for a microcontroller or coprocessor.
Module/BoardA sensor for a module or board.
Monitor ASIC/ICA sensor for a monitor ASIC or IC.
OEM (v1.3+)An OEM defined sensor.
OS Stop/ShutdownA sensor for an OS stop or shutdown event
Other FRUA sensor for an other type of FRU.
Other Units-based SensorA sensor for a miscellaneous analog sensor.
Physical Chassis SecurityA physical security sensor.
Platform AlertA sensor for a platform alert event.
Platform Security Violation AttemptA platform security sensor.
POST Memory ResizeA sensor for a POST memory resize event.
Power Supply / ConverterA sensor for a power supply or DC-to-DC converter.
PowerUnitA sensor for a power unit.
ProcessorA sensor for a processor.
Session AuditA sensor for a session audit event.
Slot/ConnectorA sensor for a slot or connector.
System ACPI PowerStateA sensor for an ACPI power state event.
System EventA sensor for a system event.
System Firmware ProgressA sensor for a system firmware progress event.
SystemBoot/RestartA sensor for a system boot or restart event.
TemperatureA temperature sensor.
TerminatorA sensor for a terminator.
Version ChangeA sensor for a version change event.
VoltageA voltage sensor.
WatchdogA sensor for a watchdog event.

Severity:

This is the severity of the log entry.

stringDescription
CriticalA critical condition requiring immediate attention.
OKInformational or operating normally.
WarningA condition requiring attention.

Example Response

{
    "@odata.type": "#LogEntry.v1_4_0.LogEntry",
    "Id": "1",
    "Name": "Log Entry 1",
    "EntryType": "Event",
    "Severity": "Critical",
    "Created": "2012-03-07T14:44:00Z",
    "SensorNumber": 1,
    "Message": "Temperature threshold exceeded",
    "MessageId": "Contoso.1.0.TempAssert",
    "MessageArgs": [
        "42"
    ],
    "Links": {
        "OriginOfCondition": {
            "@odata.id": "/redfish/v1/Chassis/1U/Thermal"
        },
        "Oem": {}
    },
    "Oem": {},
    "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry",
    "@odata.id": "/redfish/v1/Systems/437XR1138R2/LogServices/Log1/Entries/1"
}

LogService 1.1.2

v1.1v1.0
2017.31.0

This resource represents the log service for the resource or service to which it is associated.

URIs:

DateTimestringread-write (null)The current DateTime (with offset) for the log service, used to set or read time.
DateTimeLocalOffsetstringread-write (null)The time offset from UTC that the DateTime property is set to in format: +06:00 .
Entries {objectReferences to the log entry collection.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of LogEntry. See the LogEntry schema for details.
LogEntryType (v1.1+)string
(enum)
read-only (null)The format of the Entries of this log.
See LogEntryType in Property Details, below, for the possible values of this property.
MaxNumberOfRecordsintegerread-onlyThe maximum number of log entries this service can have.
OverWritePolicystring
(enum)
read-onlyThe overwrite policy for this service that takes place when the log is full.
See OverWritePolicy in Property Details, below, for the possible values of this property.
ServiceEnabledbooleanread-write (null)This indicates whether this service is enabled.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.

Actions

ClearLog

This action is used to clear the log for this Log Service.

URIs:

(This action takes no parameters.)

Property Details

LogEntryType:

The format of the Entries of this log.

stringDescription
EventThe log contains Redfish-defined messages (events).
MultipleThe log contains multiple Log Entry types or a single entry type cannot be guaranteed by the Log Service.
OEMThe log contains entries in an OEM-defined format.
SELThe log contains legacy IPMI System Event Log (SEL) entries.

OverWritePolicy:

The overwrite policy for this service that takes place when the log is full.

stringDescription
NeverOverWritesWhen full, new entries to the Log will be discarded.
UnknownThe overwrite policy is not known or is undefined.
WrapsWhenFullWhen full, new entries to the Log will overwrite previous entries.

Example Response

{
    "@odata.type": "#LogService.v1_1_1.LogService",
    "Id": "Log1",
    "Name": "System Log Service",
    "Description": "This log contains entries related to the operation of the host Computer System.",
    "MaxNumberOfRecords": 1000,
    "OverWritePolicy": "WrapsWhenFull",
    "DateTime": "2015-03-13T04:14:33+06:00",
    "DateTimeLocalOffset": "+06:00",
    "ServiceEnabled": true,
    "LogEntryType": "Event",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "Oem": {},
    "Actions": {
        "#LogService.ClearLog": {
            "target": "/redfish/v1/Managers/1/LogServices/Log1/Actions/LogService.ClearLog"
        },
        "Oem": {}
    },
    "Entries": {
        "@odata.id": "/redfish/v1/Managers/1/LogServices/Log1/Entries"
    },
    "@odata.context": "/redfish/v1/$metadata#LogService.LogService",
    "@odata.id": "/redfish/v1/Managers/1/LogServices/Log1"
}

Manager 1.5.2

v1.5v1.4v1.3v1.2v1.1v1.0
2018.22018.12016.32016.22016.11.0

This is the schema definition for a Manager. Examples of managers are BMCs, Enclosure Managers, Management Controllers and other subsystems assigned managability functions.

URIs:

AutoDSTEnabled (v1.4+)booleanread-writeIndicates whether the manager is configured for automatic DST adjustment.
CommandShell {objectInformation about the Command Shell service provided by this manager.
      ConnectTypesSupported [ ] array (string
(enum))
read-onlyThis object is used to enumerate the Command Shell connection types allowed by the implementation.
See ConnectTypesSupported in Property Details, below, for the possible values of this property.
      MaxConcurrentSessionsintegerread-onlyIndicates the maximum number of service sessions, regardless of protocol, this manager is able to support.
      ServiceEnabled
}
booleanread-writeIndicates if the service is enabled for this manager.
DateTimestringread-write (null)The current DateTime (with offset) for the manager, used to set or read time.
DateTimeLocalOffsetstringread-write (null)The time offset from UTC that the DateTime property is set to in format: +06:00 .
EthernetInterfaces {objectThis is a reference to a collection of NICs that this manager uses for network communication. It is here that clients will find NIC configuration options and settings.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of EthernetInterface. See the EthernetInterface schema for details.
FirmwareVersionstringread-only (null)The firmware version of this Manager.
GraphicalConsole {objectThe value of this property shall contain the information about the Graphical Console (KVM-IP) service of this manager.
      ConnectTypesSupported [ ] array (string
(enum))
read-onlyThis object is used to enumerate the Graphical Console connection types allowed by the implementation.
See ConnectTypesSupported in Property Details, below, for the possible values of this property.
      MaxConcurrentSessionsintegerread-onlyIndicates the maximum number of service sessions, regardless of protocol, this manager is able to support.
      ServiceEnabled
}
booleanread-writeIndicates if the service is enabled for this manager.
HostInterfaces (v1.3+) {objectThis is a reference to a collection of Host Interfaces that this manager uses for local host communication. It is here that clients will find Host Interface configuration options and settings.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of HostInterface. See the HostInterface schema for details.
Links {objectContains references to other resources that are related to this resource.
      ManagerForChassis [ {arrayThis property is an array of references to the chassis that this manager has control over.
            @odata.id
      } ]
stringread-onlyLink to a Chassis resource. See the Links section and the Chassis schema for details.
      ManagerForServers [ {arrayThis property is an array of references to the systems that this manager has control over.
            @odata.id
      } ]
stringread-onlyLink to a ComputerSystem resource. See the Links section and the ComputerSystem schema for details.
      ManagerForSwitches (v1.4+) [ {arrayThis property is an array of references to the switches that this manager has control over.
            @odata.id
      } ]
stringread-onlyLink to a Switch resource. See the Links section and the Switch schema for details.
      ManagerInChassis (v1.1+) {objectThis property is a reference to the chassis that this manager is located in.
See the Chassis schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a Chassis resource. See the Links section and the Chassis schema for details.
      Oem { }
}
objectSee the OEM object definition in the Common properties section.
LogServices {objectThis is a reference to a collection of Logs used by the manager.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of LogService. See the LogService schema for details.
ManagerTypestring
(enum)
read-onlyThis property represents the type of manager that this resource represents.
See ManagerType in Property Details, below, for the possible values of this property.
Modelstringread-only (null)The model information of this Manager as defined by the manufacturer.
NetworkProtocol {objectThis is a reference to the network services and their settings that the manager controls. It is here that clients will find network configuration options as well as network services.
See the ManagerNetworkProtocol schema for details on this property.
      @odata.id
}
stringread-onlyLink to a ManagerNetworkProtocol resource. See the Links section and the ManagerNetworkProtocol schema for details.
PowerStatestring
(enum)
read-only (null)This is the current power state of the Manager.
See PowerState in Property Details, below, for the possible values of this property.
Redundancy [ {arrayRedundancy information for the managers of this system.
      @odata.id
} ]
stringread-onlyThe unique identifier for a resource.
RemoteAccountService (v1.5+) {objectThis property contains a reference to the AccountService resource for the remote Manager represented by this resource.
See the AccountService schema for details on this property.
      @odata.id
}
stringread-onlyLink to a AccountService resource. See the Links section and the AccountService schema for details.
RemoteRedfishServiceUri (v1.5+)stringread-only (null)This property contains the URI of the Redfish Service Root for the remote Manager represented by this resource.
SerialConsole {objectInformation about the Serial Console service provided by this manager.
      ConnectTypesSupported [ ] array (string
(enum))
read-onlyThis object is used to enumerate the Serial Console connection types allowed by the implementation.
See ConnectTypesSupported in Property Details, below, for the possible values of this property.
      MaxConcurrentSessionsintegerread-onlyIndicates the maximum number of service sessions, regardless of protocol, this manager is able to support.
      ServiceEnabled
}
booleanread-writeIndicates if the service is enabled for this manager.
SerialInterfaces {objectThis is a reference to a collection of serial interfaces that this manager uses for serial and console communication. It is here that clients will find serial configuration options and settings.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of SerialInterface. See the SerialInterface schema for details.
ServiceEntryPointUUIDstringread-only (null)The UUID of the Redfish Service provided by this manager.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
UUIDstringread-only (null)The Universal Unique Identifier (UUID) for this Manager.
VirtualMedia {objectThis is a reference to the Virtual Media services for this particular manager.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of VirtualMedia. See the VirtualMedia schema for details.

Actions

ForceFailover

The ForceFailover action forces a failover of this manager to the manager used in the parameter.

URIs:

The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.

{
      NewManager {objectThis parameter specifies the Manager in which to fail over. In this case, a valid reference is supported.
            @odata.id
      }
}
stringread-onlyLink to another Manager resource.

ModifyRedundancySet

The ModifyRedundancySet operation is used to add or remove members to a redundant group of manager.

URIs:

The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.

{
      Add [ {arrayThis array defines the Managers to add to the redundancy set. In this case, a valid reference is supported.
            @odata.id
      } ]
stringread-onlyLink to another Manager resource.
      Remove [ {arrayThis array defines the Managers to remove from the redundancy set. In this case, a valid reference is supported.
            @odata.id
      } ]
}
stringread-onlyLink to another Manager resource.

Reset

The reset action resets/reboots the manager.

URIs:

The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.

{
      ResetType
}
string
(enum)
read-writeThis is the type of reset to be performed.
See ResetType in Property Details, below, for the possible values of this property.

Property Details

ConnectTypesSupported:

This object is used to enumerate the Serial Console connection types allowed by the implementation.

stringDescription
IPMIThe controller supports a Serial Console connection using the IPMI Serial-over-LAN (SOL) protocol.
OemThe controller supports a Serial Console connection using an OEM-specific protocol.
SSHThe controller supports a Serial Console connection using the SSH protocol.
TelnetThe controller supports a Serial Console connection using the Telnet protocol.

ManagerType:

This property represents the type of manager that this resource represents.

stringDescription
AuxiliaryControllerA controller which provides management functions for a particular subsystem or group of devices.
BMCA controller which provides management functions for a single computer system.
EnclosureManagerA controller which provides management functions for a chassis or group of devices or systems.
ManagementControllerA controller used primarily to monitor or manage the operation of a device or system.
RackManagerA controller which provides management functions for a whole or part of a rack.
Service (v1.4+)A software-based service which provides management functions.

PowerState:

This is the current power state of the Manager.

stringDescription
OffThe state is powered Off.
OnThe state is powered On.
PoweringOffA temporary state between On and Off.
PoweringOnA temporary state between Off and On.

ResetType:

This is the type of reset to be performed.

stringDescription
ForceOffTurn the unit off immediately (non-graceful shutdown).
ForceOnTurn the unit on immediately.
ForceRestartPerform an immediate (non-graceful) shutdown, followed by a restart.
GracefulRestartPerform a graceful shutdown followed by a restart of the system.
GracefulShutdownPerform a graceful shutdown and power off.
NmiGenerate a Diagnostic Interrupt (usually an NMI on x86 systems) to cease normal operations, perform diagnostic actions and typically halt the system.
OnTurn the unit on.
PowerCyclePerform a power cycle of the unit.
PushPowerButtonSimulate the pressing of the physical power button on this unit.

Example Response

{
    "@odata.type": "#Manager.v1_5_0.Manager",
    "Id": "BMC",
    "Name": "Manager",
    "ManagerType": "BMC",
    "Description": "Contoso BMC",
    "ServiceEntryPointUUID": "92384634-2938-2342-8820-489239905423",
    "UUID": "58893887-8974-2487-2389-841168418919",
    "Model": "Joo Janta 200",
    "FirmwareVersion": "4.4.6521",
    "DateTime": "2015-03-13T04:14:33+06:00",
    "DateTimeLocalOffset": "+06:00",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "PowerState": "On",
    "GraphicalConsole": {
        "ServiceEnabled": true,
        "MaxConcurrentSessions": 2,
        "ConnectTypesSupported": [
            "KVMIP"
        ]
    },
    "SerialConsole": {
        "ServiceEnabled": true,
        "MaxConcurrentSessions": 1,
        "ConnectTypesSupported": [
            "Telnet",
            "SSH",
            "IPMI"
        ]
    },
    "CommandShell": {
        "ServiceEnabled": true,
        "MaxConcurrentSessions": 4,
        "ConnectTypesSupported": [
            "Telnet",
            "SSH"
        ]
    },
    "HostInterfaces": {
        "@odata.id": "/redfish/v1/Managers/9/HostInterfaces"
    },
    "NetworkProtocol": {
        "@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol"
    },
    "EthernetInterfaces": {
        "@odata.id": "/redfish/v1/Managers/BMC/NICs"
    },
    "SerialInterfaces": {
        "@odata.id": "/redfish/v1/Managers/BMC/SerialInterfaces"
    },
    "LogServices": {
        "@odata.id": "/redfish/v1/Managers/BMC/LogServices"
    },
    "VirtualMedia": {
        "@odata.id": "/redfish/v1/Managers/BMC/VirtualMedia"
    },
    "Links": {
        "ManagerForServers": [
            {
                "@odata.id": "/redfish/v1/Systems/437XR1138R2"
            }
        ],
        "ManagerForChassis": [
            {
                "@odata.id": "/redfish/v1/Chassis/1U"
            }
        ],
        "ManagerInChassis": {
            "@odata.id": "/redfish/v1/Chassis/1U"
        },
        "Oem": {}
    },
    "Actions": {
        "#Manager.Reset": {
            "target": "/redfish/v1/Managers/BMC/Actions/Manager.Reset",
            "ResetType@Redfish.AllowableValues": [
                "ForceRestart",
                "GracefulRestart"
            ]
        },
        "Oem": {}
    },
    "Oem": {},
    "@odata.context": "/redfish/v1/$metadata#Manager.Manager",
    "@odata.id": "/redfish/v1/Managers/BMC"
}

ManagerAccount 1.3.0

v1.3v1.2v1.1v1.0
2019.12018.32017.11.0

The user accounts, owned by a Manager, are defined in this resource. Changes to a Manager Account may affect the current Redfish service connection if this manager is responsible for the Redfish service.

URIs:

Certificates (v1.2+) {objectThis is a reference to a collection of certificates used for this account.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of Certificate. See the Certificate schema for details.
Enabledbooleanread-writeThis property is used by a User Administrator to disable an account w/o having to delet the user information. When set to true, the user can login. When set to false, the account is administratively disabled and the user cannot login.
Links {objectContains references to other resources that are related to this resource.
      Oem { }objectSee the OEM object definition in the Common properties section.
      Role {objectA reference to the Role object defining Privileges for this account--returned when the resource is read. The ID of the role is the same as property RoleId.
See the Role schema for details on this property.
            @odata.id
      }
}
stringread-onlyLink to a Role resource. See the Links section and the Role schema for details.
Lockedbooleanread-writeThis property indicates that the account has been auto-locked by the account service because the lockout threshold has been exceeded. When set to true, the account is locked. A user admin can write the property to false to manually unlock, or the account service will unlock it once the lockout duration period has passed.
Passwordstringread-write required on create (null)This property is used with a PATCH or PUT to write the password for the account. This property is null on a GET.
PasswordChangeRequired (v1.3+)booleanread-write (null)Indicates that the password for this account must be changed. The service requires the password to be changed before access is allowed.
RoleIdstringread-write required on createThis property contains the Role for this account.
UserNamestringread-write required on createThis property contains the user name for the account.

Example Response

{
    "@odata.type": "#ManagerAccount.v1_1_3.ManagerAccount",
    "Id": "1",
    "Name": "User Account",
    "Description": "User Account",
    "Enabled": true,
    "Password": null,
    "UserName": "Administrator",
    "RoleId": "Administrator",
    "Locked": false,
    "Links": {
        "Role": {
            "@odata.id": "/redfish/v1/AccountService/Roles/Administrator"
        }
    },
    "@odata.context": "/redfish/v1/$metadata#ManagerAccount.ManagerAccount",
    "@odata.id": "/redfish/v1/AccountService/Accounts/1"
}

ManagerNetworkProtocol 1.4.1

v1.4v1.3v1.2v1.1v1.0
2018.32018.22017.12016.31.0

This resource is used to obtain or modify the network services managed by a given manager.

URIs:

DHCP {objectSettings for this Manager's DHCPv4 protocol support.
      Portintegerread-write (null)Indicates the protocol port.
      ProtocolEnabled
}
booleanread-write (null)Indicates if the protocol is enabled or disabled.
DHCPv6 {objectSettings for this Manager's DHCPv6 protocol support.
      Portintegerread-write (null)Indicates the protocol port.
      ProtocolEnabled
}
booleanread-write (null)Indicates if the protocol is enabled or disabled.
FQDNstringread-only (null)This is the fully qualified domain name for the manager obtained by DNS including the host name and top-level domain name.
HostNamestringread-only (null)The DNS Host Name of this manager, without any domain information.
HTTP {objectSettings for this Manager's HTTP protocol support.
      Portintegerread-write (null)Indicates the protocol port.
      ProtocolEnabled
}
booleanread-write (null)Indicates if the protocol is enabled or disabled.
HTTPS {objectSettings for this Manager's HTTPS protocol support.
      Certificates (v1.4+) {objectThis is a reference to a collection of certificates used for HTTPS by this manager.
Contains a link to a resource.
            @odata.id
      }
stringread-onlyLink to Collection of Certificate. See the Certificate schema for details.
      Port (v1.4+)integerread-write (null)Indicates the protocol port.
      ProtocolEnabled (v1.4+)
}
booleanread-write (null)Indicates if the protocol is enabled or disabled.
IPMI {objectSettings for this Manager's IPMI-over-LAN protocol support.
      Portintegerread-write (null)Indicates the protocol port.
      ProtocolEnabled
}
booleanread-write (null)Indicates if the protocol is enabled or disabled.
KVMIP {objectSettings for this Manager's KVM-IP protocol support.
      Portintegerread-write (null)Indicates the protocol port.
      ProtocolEnabled
}
booleanread-write (null)Indicates if the protocol is enabled or disabled.
NTP (v1.2+) {objectSettings for this Manager's NTP protocol support.
      NTPServers [ ] array
(string, null)
read-writeIndicates to which NTP servers this manager is subscribed.
      Portintegerread-write (null)Indicates the protocol port.
      ProtocolEnabled
}
booleanread-write (null)Indicates if the protocol is enabled or disabled.
RDP {objectSettings for this Manager's Remote Desktop Protocol support.
      Portintegerread-write (null)Indicates the protocol port.
      ProtocolEnabled
}
booleanread-write (null)Indicates if the protocol is enabled or disabled.
RFB {objectSettings for this Manager's Remote Frame Buffer protocol support, which can be used to support VNC.
      Portintegerread-write (null)Indicates the protocol port.
      ProtocolEnabled
}
booleanread-write (null)Indicates if the protocol is enabled or disabled.
SNMP {objectSettings for this Manager's SNMP support.
      Portintegerread-write (null)Indicates the protocol port.
      ProtocolEnabled
}
booleanread-write (null)Indicates if the protocol is enabled or disabled.
SSDP {objectSettings for this Manager's SSDP support.
      NotifyIPv6Scopestring
(enum)
read-write (null)Indicates the scope for the IPv6 Notify messages for SSDP.
See NotifyIPv6Scope in Property Details, below, for the possible values of this property.
      NotifyMulticastIntervalSecondsinteger
(seconds)
read-write (null)Indicates how often the Multicast is done from this service for SSDP.
      NotifyTTLintegerread-write (null)Indicates the time to live hop count for SSDPs Notify messages.
      Portintegerread-write (null)Indicates the protocol port.
      ProtocolEnabled
}
booleanread-write (null)Indicates if the protocol is enabled or disabled.
SSH {objectSettings for this Manager's SSH (Secure Shell) protocol support.
      Portintegerread-write (null)Indicates the protocol port.
      ProtocolEnabled
}
booleanread-write (null)Indicates if the protocol is enabled or disabled.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
Telnet {objectSettings for this Manager's Telnet protocol support.
      Portintegerread-write (null)Indicates the protocol port.
      ProtocolEnabled
}
booleanread-write (null)Indicates if the protocol is enabled or disabled.
VirtualMedia {objectSettings for this Manager's Virtual Media support.
      Portintegerread-write (null)Indicates the protocol port.
      ProtocolEnabled
}
booleanread-write (null)Indicates if the protocol is enabled or disabled.

Property Details

NotifyIPv6Scope:

Indicates the scope for the IPv6 Notify messages for SSDP.

stringDescription
LinkSSDP Notify messages are sent to addresses in the IPv6 Local Link scope.
OrganizationSSDP Notify messages are sent to addresses in the IPv6 Local Organization scope.
SiteSSDP Notify messages are sent to addresses in the IPv6 Local Site scope.

Example Response

{
    "@odata.type": "#ManagerNetworkProtocol.v1_3_0.ManagerNetworkProtocol",
    "Id": "NetworkProtocol",
    "Name": "Manager Network Protocol",
    "Description": "Manager Network Service",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "HostName": "web483-bmc",
    "FQDN": "web483-bmc.dmtf.org",
    "HTTP": {
        "ProtocolEnabled": true,
        "Port": 80
    },
    "HTTPS": {
        "ProtocolEnabled": true,
        "Port": 443
    },
    "IPMI": {
        "ProtocolEnabled": true,
        "Port": 623
    },
    "SSH": {
        "ProtocolEnabled": true,
        "Port": 22
    },
    "SNMP": {
        "ProtocolEnabled": true,
        "Port": 161
    },
    "VirtualMedia": {
        "ProtocolEnabled": true,
        "Port": 17988
    },
    "SSDP": {
        "ProtocolEnabled": true,
        "Port": 1900,
        "NotifyMulticastIntervalSeconds": 600,
        "NotifyTTL": 5,
        "NotifyIPv6Scope": "Site"
    },
    "Telnet": {
        "ProtocolEnabled": true,
        "Port": 23
    },
    "KVMIP": {
        "ProtocolEnabled": true,
        "Port": 5288
    },
    "@odata.context": "/redfish/v1/$metadata#ManagerNetworkProtocol.ManagerNetworkProtocol",
    "@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol"
}

Memory 1.7.1

v1.7v1.6v1.5v1.4v1.3v1.2v1.1v1.0
2018.32018.22018.12017.32017.22017.12016.32016.1

This is the schema definition for definition of a Memory and its configuration.

URIs:

AllocationAlignmentMiB (v1.2+)integer
(mebibytes)
read-only (null)The boundary which memory regions are allocated on, measured in mebibytes (MiB).
AllocationIncrementMiB (v1.2+)integer
(mebibytes)
read-only (null)The size of the smallest unit of allocation for a memory region in mebibytes (MiB).
AllowedSpeedsMHz [ ] array
(MHz)
(integer)
read-onlySpeed bins supported by this Memory.
Assembly (v1.4+) {objectA reference to the Assembly resource associated with this memory.
See the Assembly schema for details on this property.
      @odata.id
}
stringread-onlyLink to a Assembly resource. See the Links section and the Assembly schema for details.
BaseModuleTypestring
(enum)
read-only (null)The base module type of Memory.
See BaseModuleType in Property Details, below, for the possible values of this property.
BusWidthBitsintegerread-only (null)Bus Width in bits.
CacheSizeMiB (v1.4+)integer
(mebibytes)
read-only (null)Total size of the cache portion memory in MiB.
CapacityMiBinteger
(mebibytes)
read-only (null)Memory Capacity in mebibytes (MiB).
ConfigurationLocked (v1.7+)booleanread-only (null)Indicates that the configuration of this memory has been locked.
DataWidthBitsintegerread-only (null)Data Width in bits.
DeviceID (deprecated v1.3)stringread-only (null)Device ID. Deprecated v1.3+. This property has been Deprecated in favor of Memory.v1_3_0.ModuleProductID
DeviceLocatorstringread-only (null)Location of the Memory in the platform.
ErrorCorrectionstring
(enum)
read-only (null)Error correction scheme supported for this memory.
See ErrorCorrection in Property Details, below, for the possible values of this property.
FirmwareApiVersionstringread-only (null)Version of API supported by the firmware.
FirmwareRevisionstringread-only (null)Revision of firmware on the Memory controller.
FunctionClasses (deprecated v1.4) [ ] array
(string)
read-onlyFunction Classes by the Memory. Deprecated v1.4+. This property has been Deprecated in favor of Memory.v1_0_0.Memory.OperatingMemoryModes or Memory.v1_0_0.Memory.RegionSet.MemoryClassification.
IsRankSpareEnabledbooleanread-only (null)Rank spare enabled status.
IsSpareDeviceEnabledbooleanread-only (null)Spare device enabled status.
Links (v1.2+) {objectContains references to other resources that are related to this resource.
      Chassis {objectA reference to the Chassis which contains this Memory.
See the Chassis schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a Chassis resource. See the Links section and the Chassis schema for details.
      Oem { }
}
objectSee the OEM object definition in the Common properties section.
Location (v1.4+) { }objectThe Location of the memory.
See the Location object for details on this property.
LogicalSizeMiB (v1.4+)integer
(mebibytes)
read-only (null)Total size of the logical memory in MiB.
Manufacturerstringread-only (null)The Memory manufacturer.
MaxTDPMilliWatts [ ] array
(milliWatts)
(integer)
read-onlyMaximum TDPs in milli Watts.
MemoryDeviceTypestring
(enum)
read-only (null)Type details of the Memory.
See MemoryDeviceType in Property Details, below, for the possible values of this property.
MemoryLocation {objectMemory connection information to sockets and memory controllers.
      Channelintegerread-only (null)Channel number in which Memory is connected.
      MemoryControllerintegerread-only (null)Memory controller number in which Memory is connected.
      Slotintegerread-only (null)Slot number in which Memory is connected.
      Socket
}
integerread-only (null)Socket number in which Memory is connected.
MemoryMedia [ ] array (string
(enum))
read-onlyMedia of this Memory.
See MemoryMedia in Property Details, below, for the possible values of this property.
MemorySubsystemControllerManufacturerID (v1.3+)stringread-only (null)The manufacturer ID of the memory subsystem controller of this memory module.
MemorySubsystemControllerProductID (v1.3+)stringread-only (null)The product ID of the memory subsystem controller of this memory module.
MemoryTypestring
(enum)
read-only (null)The type of Memory.
See MemoryType in Property Details, below, for the possible values of this property.
Metrics {objectA reference to the Metrics associated with this Memory.
See the MemoryMetrics schema for details on this property.
      @odata.id
}
stringread-onlyLink to a MemoryMetrics resource. See the Links section and the MemoryMetrics schema for details.
ModuleManufacturerID (v1.3+)stringread-only (null)The manufacturer ID of this memory module.
ModuleProductID (v1.3+)stringread-only (null)The product ID of this memory module.
NonVolatileSizeMiB (v1.4+)integer
(mebibytes)
read-only (null)Total size of the non-volatile portion memory in MiB.
OperatingMemoryModes [ ] array (string
(enum))
read-onlyMemory modes supported by the Memory.
See OperatingMemoryModes in Property Details, below, for the possible values of this property.
OperatingSpeedMhzinteger
(MHz)
read-only (null)Operating speed of Memory in MHz or MT/s as appropriate.
PartNumberstringread-only (null)The product part number of this device.
PersistentRegionNumberLimit (v1.2+)integerread-only (null)Total number of persistent regions this Memory can support.
PersistentRegionSizeLimitMiBinteger
(mebibytes)
read-only (null)Total size of persistent regions in mebibytes (MiB).
PersistentRegionSizeMaxMiB (v1.2+)integer
(mebibytes)
read-only (null)Maximum size of a single persistent region in mebibytes (MiB).
PowerManagementPolicy {objectPower management policy information.
      AveragePowerBudgetMilliWattsinteger
(milliWatts)
read-only (null)Average power budget in milli watts.
      MaxTDPMilliWattsinteger
(milliWatts)
read-only (null)Maximum TDP in milli watts.
      PeakPowerBudgetMilliWattsinteger
(milliWatts)
read-only (null)Peak power budget in milli watts.
      PolicyEnabled
}
booleanread-only (null)Power management policy enabled status.
RankCountintegerread-only (null)Number of ranks available in the Memory.
Regions [ {arrayMemory regions information within the Memory.
      MemoryClassificationstring
(enum)
read-only (null)Classification of memory occupied by the given memory region.
See MemoryClassification in Property Details, below, for the possible values of this property.
      OffsetMiBinteger
(mebibytes)
read-only (null)Offset with in the Memory that corresponds to the starting of this memory region in mebibytes (MiB).
      PassphraseEnabled (v1.5+)booleanread-only (null)Indicates if the passphrase is enabled for this region.
      PassphraseState (deprecated v1.5)booleanread-only (null)State of the passphrase for this region. Deprecated v1.5+. This property has been Deprecated in favor of Memory.v1_5_0.Memory.RegionSet.PassphraseEnabled.
      RegionIdstringread-only (null)Unique region ID representing a specific region within the Memory.
      SizeMiB
} ]
integer
(mebibytes)
read-only (null)Size of this memory region in mebibytes (MiB).
SecurityCapabilities {objectThis object contains security capabilities of the Memory.
      ConfigurationLockCapable (v1.7+)booleanread-only (null)Support for locking the configuration.
      DataLockCapable (v1.7+)booleanread-only (null)Support for data locking.
      MaxPassphraseCountintegerread-only (null)Maximum number of passphrases supported for this Memory.
      PassphraseCapablebooleanread-only (null)Memory passphrase set capability.
      PassphraseLockLimit (v1.7+)integerread-only (null)Maximum number of incorrect passphrase attempts allowed before memory is locked.
      SecurityStates [ ]
}
array (string
(enum))
read-onlySecurity states supported by the Memory.
See SecurityStates in Property Details, below, for the possible values of this property.
SecurityStatestring
(enum)
read-write (null)The current security state of this Memory.
See SecurityState in Property Details, below, for the possible values of this property.
SerialNumberstringread-only (null)The product serial number of this device.
SpareDeviceCountintegerread-only (null)Number of unused spare devices available in the Memory.
Status (v1.1+) { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
SubsystemDeviceID (deprecated v1.3)stringread-only (null)Subsystem Device ID. Deprecated v1.3+. This property has been Deprecated in favor of Memory.v1_3_0.MemorySubsystemControllerProductID
SubsystemVendorID (deprecated v1.3)stringread-only (null)SubSystem Vendor ID. Deprecated v1.3+. This property has been Deprecated in favor of Memory.v1_3_0.MemorySubsystemControllerManufacturerID
VendorID (deprecated v1.3)stringread-only (null)Vendor ID. Deprecated v1.3+. This property has been Deprecated in favor of Memory.v1_3_0.ModuleManufacturerID
VolatileRegionNumberLimit (v1.2+)integerread-only (null)Total number of volatile regions this Memory can support.
VolatileRegionSizeLimitMiBinteger
(mebibytes)
read-only (null)Total size of volatile regions in mebibytes (MiB).
VolatileRegionSizeMaxMiB (v1.2+)integer
(mebibytes)
read-only (null)Maximum size of a single volatile region in mebibytes (MiB).
VolatileSizeMiB (v1.4+)integer
(mebibytes)
read-only (null)Total size of the volitile portion memory in MiB.

Actions

DisablePassphrase

Disable passphrase for given regions.

URIs:

The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.

{
      Passphrasestringread-write requiredPassphrase for doing the operation.
      RegionId
}
stringread-write requiredMemory region ID for which this action to be applied.

OverwriteUnit

This defines the action for securely erasing given regions using the NIST SP800-88 Purge: Overwrite.

URIs:

The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.

{
      Passphrasestringread-write requiredPassphrase for doing the operation.
      RegionId
}
stringread-write requiredMemory region ID for which this action to be applied.

SecureEraseUnit

This defines the action for securely erasing given regions using the NIST SP800-88 Purge: Cryptograhic Erase.

URIs:

The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.

{
      Passphrasestringread-write requiredPassphrase for doing the operation.
      RegionId
}
stringread-write requiredMemory region ID for which this action to be applied.

SetPassphrase

Set passphrase for the given regions.

URIs:

The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.

{
      Passphrasestringread-write requiredPassphrase for doing the operation.
      RegionId
}
stringread-write requiredMemory region ID for which this action to be applied.

UnlockUnit

This defines the action for unlocking given regions.

URIs:

The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.

{
      Passphrasestringread-write requiredPassphrase for doing the operation.
      RegionId
}
stringread-write requiredMemory region ID for which this action to be applied.

Property Details

BaseModuleType:

The base module type of Memory.

stringDescription
Die (v1.7+)A die within a package.
LRDIMMLoad Reduced.
Mini_RDIMMMini_RDIMM.
Mini_UDIMMMini_UDIMM.
RDIMMRegistered DIMM.
SO_DIMMSO_DIMM.
SO_DIMM_16bSO_DIMM_16b.
SO_DIMM_32bSO_DIMM_32b.
SO_RDIMM_72bSO_RDIMM_72b.
SO_UDIMM_72bSO_UDIMM_72b.
UDIMMUDIMM.

ErrorCorrection:

Error correction scheme supported for this memory.

stringDescription
AddressParityAddress Parity errors can be corrected.
MultiBitECCMulti-bit Data errors can be corrected by ECC.
NoECCNo ECC available.
SingleBitECCSingle bit Data error can be corrected by ECC.

MemoryClassification:

Classification of memory occupied by the given memory region.

stringDescription
BlockBlock accesible memory.
ByteAccessiblePersistentByte accessible persistent memory.
VolatileVolatile memory.

MemoryDeviceType:

Type details of the Memory.

stringDescription
DDRDDR.
DDR2DDR2.
DDR2_SDRAMDDR2 SDRAM.
DDR2_SDRAM_FB_DIMMDDR2 SDRAM FB_DIMM.
DDR2_SDRAM_FB_DIMM_PROBEDDR2 SDRAM FB_DIMM PROBE.
DDR3DDR3.
DDR3_SDRAMDDR3 SDRAM.
DDR4DDR4.
DDR4_SDRAMDDR4 SDRAM.
DDR4E_SDRAMDDR4E SDRAM.
DDR_SDRAMDDR SDRAM.
DDR_SGRAMDDR SGRAM.
EDOEDO.
FastPageModeFast Page Mode.
HBM (v1.7+)High Bandwidth Memory.
HBM2 (v1.7+)High Bandwidth Memory 2.
Logical (v1.4+)Logical Non-volatile device.
LPDDR3_SDRAMLPDDR3 SDRAM.
LPDDR4_SDRAMLPDDR4 SDRAM.
PipelinedNibblePipelined Nibble.
ROMROM.
SDRAMSDRAM.

MemoryMedia:

Media of this Memory.

stringDescription
DRAMDRAM media.
Intel3DXPoint (v1.7+)Intel 3D XPoint media.
NANDNAND media.
ProprietaryProprietary media.

MemoryType:

The type of Memory.

stringDescription
DRAMThe memory module is composed of volatile memory.
IntelOptane (v1.6+)The memory module is Intel Optane DC Persistent Memory and composed of a combination of non-volatile and volatile memory.
NVDIMM_FThe memory module is composed of non-volatile memory.
NVDIMM_NThe memory module is composed of volatile memory backed by non-volatile memory.
NVDIMM_PThe memory module is composed of a combination of non-volatile and volatile memory.

OperatingMemoryModes:

Memory modes supported by the Memory.

stringDescription
BlockBlock accessible system memory.
PMEMPersistent memory, byte accesible through system address space.
VolatileVolatile memory.

SecurityState:

The current security state of this Memory.

stringDescription
DisabledSecure mode is disabled.
EnabledSecure mode is enabled and access to the data is allowed.
Frozen (deprecated v1.7)Secure state is frozen and can not be modified until reset. Deprecated v1.7+. This value has been deprecated in favor of using the ConfigurationLocked to indicate that the configuration has been frozen.
LockedSecure mode is enabled and access to the data is locked.
PassphraselimitNumber of attempts to unlock the Memory exceeded limit.
Unlocked (deprecated v1.7)Secure mode is enabled and access to the data is unlocked. Deprecated v1.7+. This value has been deprecated in favor of 'Enabled' to indicate normal security operation.

SecurityStates:

Security states supported by the Memory.

stringDescription
DisabledSecure mode is disabled.
EnabledSecure mode is enabled and access to the data is allowed.
Frozen (deprecated v1.7)Secure state is frozen and can not be modified until reset. Deprecated v1.7+. This value has been deprecated in favor of using the ConfigurationLocked to indicate that the configuration has been frozen.
LockedSecure mode is enabled and access to the data is locked.
PassphraselimitNumber of attempts to unlock the Memory exceeded limit.
Unlocked (deprecated v1.7)Secure mode is enabled and access to the data is unlocked. Deprecated v1.7+. This value has been deprecated in favor of 'Enabled' to indicate normal security operation.

Example Response

{
    "@odata.type": "#Memory.v1_6_0.Memory",
    "Id": "DIMM1",
    "Name": "DIMM Slot 1",
    "RankCount": 2,
    "MaxTDPMilliWatts": [
        12000
    ],
    "CapacityMiB": 32768,
    "DataWidthBits": 64,
    "BusWidthBits": 72,
    "ErrorCorrection": "MultiBitECC",
    "MemoryLocation": {
        "Socket": 1,
        "MemoryController": 1,
        "Channel": 1,
        "Slot": 1
    },
    "MemoryType": "DRAM",
    "MemoryDeviceType": "DDR4",
    "BaseModuleType": "RDIMM",
    "MemoryMedia": [
        "DRAM"
    ],
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "@odata.context": "/redfish/v1/$metadata#Memory.Memory",
    "@odata.id": "/redfish/v1/Systems/437XR1138R2/Memory/DIMM1"
}

MemoryChunks 1.2.3

v1.2v1.1v1.0
2017.32017.12016.2

This is the schema definition of a Memory Chunk and its configuration.

URIs:

AddressRangeTypestring
(enum)
read-only (null)Memory type of this memory chunk.
See AddressRangeType in Property Details, below, for the possible values of this property.
InterleaveSets [ {arrayThis is the interleave sets for the memory chunk.
      Memory {objectDescribes a memory device of the interleave set.
            @odata.id
      }
stringread-onlyThe unique identifier for a resource.
      MemoryLevelintegerread-only (null)Level of the interleave set for multi-level tiered memory.
      OffsetMiBinteger
(mebibytes)
read-only (null)Offset within the DIMM that corresponds to the start of this memory region, measured in mebibytes (MiB).
      RegionIdstringread-only (null)DIMM region identifier.
      SizeMiB
} ]
integer
(mebibytes)
read-only (null)Size of this memory region measured in mebibytes (MiB).
IsMirrorEnabledbooleanread-only (null)Mirror Enabled status.
IsSparebooleanread-only (null)Spare enabled status.
MemoryChunkSizeMiBinteger
(mebibytes)
read-only (null)Size of the memory chunk measured in mebibytes (MiB).
Status (v1.2+) { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.

Property Details

AddressRangeType:

Memory type of this memory chunk.

stringDescription
BlockBlock accesible memory.
PMEMByte accessible persistent memory.
VolatileVolatile memory.

Example Response

{
    "@odata.type": "#MemoryChunks.v1_0_0.MemoryChunks",
    "Name": "Memory Chunk - Whole System",
    "Id": "1",
    "MemoryChunkSizeMiB": 32768,
    "AddressRangeType": "Volatile",
    "IsMirrorEnabled": false,
    "IsSpare": false,
    "InterleaveSets": [
        {
            "Memory": {
                "@odata.id": "/redfish/v1/Systems/2/Memory/1"
            }
        },
        {
            "Memory": {
                "@odata.id": "/redfish/v1/Systems/2/Memory/2"
            }
        },
        {
            "Memory": {
                "@odata.id": "/redfish/v1/Systems/2/Memory/3"
            }
        },
        {
            "Memory": {
                "@odata.id": "/redfish/v1/Systems/2/Memory/4"
            }
        }
    ],
    "@Redfish.Settings": {
        "@odata.type": "#Settings.v1_0_0.Settings",
        "SettingsObject": {
            "@odata.id": "/redfish/v1/Systems/2/MemoryDomains/1/MemoryChunks/1/SD"
        },
        "Time": "2012-03-07T14:44.30-05:00",
        "ETag": "someetag",
        "Messages": [
            {
                "MessageId": "Base.1.0.Success"
            }
        ]
    },
    "Oem": {},
    "@odata.context": "/redfish/v1/$metadata#MemoryChunks.MemoryChunks",
    "@odata.id": "/redfish/v1/Systems/2/MemoryDomains/1/MemoryChunks/1"
}

MemoryDomain 1.2.2

v1.2v1.1v1.0
2017.12016.32016.2

This is the schema definition of a Memory Domain and its configuration. Memory Domains are used to indicate to the client which Memory (DIMMs) can be grouped together in Memory Chunks to form interleave sets or otherwise grouped together.

URIs:

AllowsBlockProvisioningbooleanread-only (null)Indicates if this Memory Domain supports the provisioning of blocks of memory.
AllowsMemoryChunkCreationbooleanread-only (null)Indicates if this Memory Domain supports the creation of Memory Chunks.
AllowsMirroring (v1.1+)booleanread-only (null)Indicates if this Memory Domain supports the creation of Memory Chunks with mirroring enabled.
AllowsSparing (v1.1+)booleanread-only (null)Indicates if this Memory Domain supports the creation of Memory Chunks with sparing enabled.
InterleavableMemorySets [ {arrayThis is the interleave sets for the memory chunk.
      MemorySet [ {arrayThis is the collection of memory for a particular interleave set.
            @odata.id
      } ]
} ]
stringread-onlyLink to a Memory resource. See the Links section and the Memory schema for details.
MemoryChunks {objectA reference to the collection of Memory Chunks associated with this Memory Domain.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of MemoryChunks. See the MemoryChunks schema for details.

Example Response

{
    "@odata.type": "#MemoryDomain.v1_2_1.MemoryDomain",
    "Name": "Memory Domain - Whole System Mirroring Only",
    "Id": "1",
    "MemoryChunks": {
        "@odata.id": "/redfish/v1/Systems/4/MemoryDomains/1/MemoryChunks"
    },
    "AllowsMemoryChunkCreation": false,
    "AllowsBlockProvisioning": false,
    "InterleavableMemorySets": [
        {
            "MemorySet": [
                {
                    "@odata.id": "/redfish/v1/Systems/2/Memory/1"
                },
                {
                    "@odata.id": "/redfish/v1/Systems/2/Memory/2"
                },
                {
                    "@odata.id": "/redfish/v1/Systems/2/Memory/3"
                },
                {
                    "@odata.id": "/redfish/v1/Systems/2/Memory/4"
                }
            ]
        }
    ],
    "Oem": {},
    "@odata.context": "/redfish/v1/$metadata#MemoryDomain.MemoryDomain",
    "@odata.id": "/redfish/v1/Systems/2/MemoryDomains/1"
}

MemoryMetrics 1.1.5

v1.1v1.0
2016.22016.1

MemoryMetrics contains usage and health statistics for a single Memory module or device instance.

URIs:

BlockSizeBytesinteger
(bytes)
read-only (null)Block size in bytes.
CurrentPeriod {objectThis object contains the Memory metrics since last reset or ClearCurrentPeriod action.
      BlocksReadintegerread-only (null)Number of blocks read since reset.
      BlocksWritten
}
integerread-only (null)Number of blocks written since reset.
HealthData {objectThis object describes the health information of the memory.
      AlarmTrips {objectAlarm trip information about the memory.
            AddressParityErrorbooleanread-only (null)Address parity error detected status.
            CorrectableECCErrorbooleanread-only (null)Correctable data error threshold crossing alarm trip detected status.
            SpareBlockbooleanread-only (null)Spare block capacity crossing alarm trip detected status.
            Temperaturebooleanread-only (null)Temperature threshold crossing alarm trip detected status.
            UncorrectableECCError
      }
booleanread-only (null)Uncorrectable data error threshold crossing alarm trip detected status.
      DataLossDetectedbooleanread-only (null)Data loss detection status.
      LastShutdownSuccessbooleanread-only (null)Status of last shutdown.
      PerformanceDegradedbooleanread-only (null)Performance degraded mode status.
      PredictedMediaLifeLeftPercent (v1.1+)number
(%)
read-only (null)The percentage of reads and writes that are predicted to still be available for the media.
      RemainingSpareBlockPercentage
}
number
(%)
read-only (null)Remaining spare blocks in percentage.
LifeTime {objectThis object contains the Memory metrics for the lifetime of the Memory.
      BlocksReadintegerread-only (null)Number of blocks read for the lifetime of the Memory.
      BlocksWritten
}
integerread-only (null)Number of blocks written for the lifetime of the Memory.

Actions

ClearCurrentPeriod

This sets the CurrentPeriod object values to zero.

URIs:

(This action takes no parameters.)

Example Response

{
    "@odata.type": "#MemoryMetrics.v1_1_4.MemoryMetrics",
    "Name": "Memory Metrics",
    "Id": "Metrics",
    "BlockSizeBytes": 4096,
    "CurrentPeriod": {
        "BlocksRead": 0,
        "BlocksWritten": 0
    },
    "LifeTime": {
        "BlocksRead": 0,
        "BlocksWritten": 0
    },
    "HealthData": {
        "RemainingSpareBlockPercentage": 50,
        "LastShutdownSuccess": true,
        "DataLossDetected": false,
        "PerformanceDegraded": false,
        "AlarmTrips": {
            "Temperature": true,
            "SpareBlock": false,
            "UncorrectableECCError": false,
            "CorrectableECCError": false
        }
    },
    "Actions": {
        "#MemoryMetrics.ClearCurrentPeriod": {
            "target": "/redfish/v1/Systems/1/Memory/1/Actions/MemoryMetrics.ClearCurrentPeriod"
        },
        "Oem": {}
    },
    "Oem": {},
    "@odata.context": "/redfish/v1/$metadata#MemoryMetrics.MemoryMetrics",
    "@odata.id": "/redfish/v1/Systems/1/Memory/1/MemoryMetrics"
}

MessageRegistry 1.3.0

v1.3v1.2v1.1v1.0
2019.12018.22017.11.0

This is the schema definition for all Message Registries. It represents the properties for the registries themselves. The MessageId is formed per the Redfish specification. It consists of the RegistryPrefix concatenated with the version concatenated with the unique identifier for the message registry entry.

Languagestringread-only requiredThis is the RFC 5646 compliant language code for the registry.
Messages {object requiredThe pattern property indicates that a free-form string is the unique identifier for the message within the registry.
      (pattern) {objectProperty names follow regular expression pattern "[A-Za-z0-9]+"
            ArgDescriptions (v1.3+) [ ] array
(string, null)
read-onlyThe MessageArg descriptions, in order, used for this Message.
            ArgLongDescriptions (v1.3+) [ ] array
(string, null)
read-onlyThe MessageArg normative descriptions, in order, used for this Message.
            ClearingLogic (v1.2+) {objectThe clearing logic associated with this message. The properties within indicate that what messages are cleared by this message as well as under what conditions.
                  ClearsAllbooleanread-only (null)This property indicates that all prior conditions and messages are cleared provided the ClearsIf condition is met.
                  ClearsIfstring
(enum)
read-only (null)This property contains the available OEM specific actions for this resource.
See ClearsIf in Property Details, below, for the possible values of this property.
                  ClearsMessage [ ]
            }
array
(string, null)
read-onlyThis property contains the array of Message Ids that are cleared by this message, provided the other conditions are met.
            Descriptionstringread-only requiredThis is a short description of how and when this message is to be used.
            LongDescription (v1.3+)stringread-only (null)The normative language describing the usage of this Message.
            Messagestringread-only requiredThe actual message.
            NumberOfArgsintegerread-only requiredThe number of arguments to be expected to be passed in as MessageArgs for this message.
            Oem { }objectSee the OEM object definition in the Common properties section.
            ParamTypes [ ] array (string
(enum))
read-onlyThe MessageArg types, in order, for the message.
See ParamTypes in Property Details, below, for the possible values of this property.
            Resolutionstringread-only requiredUsed to provide suggestions on how to resolve the situation that caused the error.
            Severity
      }
stringread-only requiredThis is the severity of the message.
      (pattern) { } [ ]
}
array, boolean, integer, number, object, string (null)Property names follow regular expression pattern "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$"
OwningEntitystringread-only requiredThis is the organization or company that publishes this registry.
RegistryPrefixstringread-only requiredThis is the single word prefix used to form a messageID structure.
RegistryVersionstringread-only requiredThis is the message registry version which is used in the middle portion of a messageID.

Property Details

ClearsIf:

This property contains the available OEM specific actions for this resource.

stringDescription
SameOriginOfConditionIndicates the message is cleared by the other message(s) listed in the ClearingLogic object, provided the OriginOfCondition for both Events are the same.

ParamTypes:

The MessageArg types, in order, for the message.

stringDescription
numberThe argument is a number.
stringThe argument is a string.

Example Response

{
    "@odata.type": "#MessageRegistry.v1_0_0.MessageRegistry",
    "Id": "Basic.1.2.0",
    "Name": "Simple Message Registry",
    "Language": "en",
    "Description": "Collection of Basic messages for numerous use cases",
    "RegistryPrefix": "Basic",
    "RegistryVersion": "1.2.0",
    "OwningEntity": "Contoso",
    "Messages": {
        "Success": {
            "Description": "Indicates that all conditions of a successful operation have been met.",
            "Message": "Successfully Completed Request",
            "Severity": "OK",
            "NumberOfArgs": 0,
            "Resolution": "None"
        },
        "GeneralError": {
            "Description": "Indicates that a general error has occurred.",
            "Message": "A general error has occurred. See ExtendedInfo for more information.",
            "Severity": "Critical",
            "NumberOfArgs": 0,
            "Resolution": "See ExtendedInfo for more information."
        },
        "ResourceAtUriUnauthorized": {
            "Description": "Indicates that the attempt to access the resource/file/image at the URI was unauthorized.",
            "Message": "While accessing the resource at %1, the service received an authorization error %2.",
            "Severity": "Critical",
            "NumberOfArgs": 2,
            "ParamTypes": [
                "string",
                "string"
            ],
            "Resolution": "Ensure that the appropriate access is provided for the service in order for it to access the URI."
        }
    }
}

MessageRegistryFile 1.1.2

v1.1v1.0
2017.12016.1

This is the schema definition for the Schema File locator resource.

URIs:

Languages [ ] array
(string)
read-only requiredLanguage codes for the schemas available.
Location [ {array requiredLocation information for this registry file.
      ArchiveFilestringread-onlyIf the schema is hosted on the service in an archive file, this is the name of the file within the archive.
      ArchiveUristringread-onlyIf the schema is hosted on the service in an archive file, this is the link to the archive file.
      Languagestringread-onlyThe language code for the file the schema is in.
      PublicationUristringread-onlyLink to publicly available (canonical) URI for schema.
      Uri
} ]
stringread-onlyLink to locally available URI for schema.
Registrystringread-only requiredThe Registry Name, Major, and Minor version. This Registry can reference any type of Registry, such as a Message Registry, Privilege Registry, or Attribute Registry.

Example Response

{
    "@odata.id": "/redfish/v1/Registries/Base.v1_0_0",
    "@odata.type": "#MessageRegistryFile.v1_0_0.MessageRegistryFile",
    "Id": "Base.v1_0_0",
    "Name": "Base Message Registry File",
    "Description": "Base Message Registry File locations",
    "Languages": [
        "en"
    ],
    "Registry": "Base.1.0",
    "Location": [
        {
            "Language": "en",
            "ArchiveUri": "/FileRepo/Registries.gz",
            "PublicationUri": "http://redfish.dmtf.org/registries/Base.v1_0_0.json",
            "ArchiveFile": "Base.v1_0_0.json"
        },
        {
            "Language": "zh",
            "ArchiveUri": "/FileRepo/Registries.zh.gz",
            "PublicationUri": "http://redfish.dmtf.org/registries/Base.v1_0_0.zh.json",
            "ArchiveFile": "Base.v1_0_0.zh.json"
        }
    ],
    "Oem": {}
}

MetricDefinition 1.0.2

v1.0
2018.2

The metadata information about a metric.

URIs:

Accuracynumberread-only (null)Estimated percent error of measured vs. actual values.
Calculablestring
(enum)
read-write (null)Indicates whether the metric can be used in a calculation.
See Calculable in Property Details, below, for the possible values of this property.
CalculationAlgorithmstring
(enum)
read-only (null)The calculation which is performed on a source metric to obtain the metric being defined.
See CalculationAlgorithm in Property Details, below, for the possible values of this property.
CalculationParameters [ {arraySpecifies the metric properties which are part of the synthesis calculation. This property is present when the MetricType property has the value 'Synthesized'.
      ResultMetricstringread-only (null)The metric property used to store the results of the calculation.
      SourceMetric
} ]
stringread-only (null)The metric property used as the input into the calculation.
CalculationTimeIntervalstringread-write (null)The time interval over which the metric calculation is performed.
Calibrationnumberread-only (null)Specifies the calibration offset added to the metric reading.
DiscreteValues [ ] array
(string, null)
read-writeThis array property specifies possible values of a discrete metric.
Implementationstring
(enum)
read-only (null)The implementation of the metric.
See Implementation in Property Details, below, for the possible values of this property.
IsLinearbooleanread-write (null)Indicates whether the metric values are linear (vs non-linear).
MaxReadingRangenumberread-only (null)Maximum value for metric reading.
MetricDataTypestring
(enum)
read-write (null)The data type of the metric.
See MetricDataType in Property Details, below, for the possible values of this property.
MetricProperties [ ] array
(string, null)
read-writeA list of URIs with wildcards and property identifiers for which this metric definition is defined. If a URI has wildcards, the wildcards are substituted as specified in the Wildcards array property.
MetricTypestring
(enum)
read-write (null)The type of metric.
See MetricType in Property Details, below, for the possible values of this property.
MinReadingRangenumberread-only (null)Minimum value for metric reading.
PhysicalContextstring
(enum)
read-only (null)Specifies the physical context of the metric.
See PhysicalContext in Property Details, below, for the possible values of this property.
Precisionintegerread-only (null)Number of significant digits in the metric reading.
SensingIntervalstringread-write (null)The time interval between when a metric is updated.
TimestampAccuracystringread-only (null)Accuracy of the timestamp.
Unitsstringread-write (null)The units of measure for this metric.
Wildcards [ {arrayA list of wildcards and their substitution values to be applied to the entries in the MetricProperties array property.
      Namestringread-only (null)The string used as a wildcard.
      Values [ ]
} ]
array
(string, null)
read-onlyAn array of values to substitute for the wildcard.

Property Details

Calculable:

Indicates whether the metric can be used in a calculation.

stringDescription
NonCalculatableNo calculations should be performed on the metric reading.
NonSummableThe sum of the metric reading across multiple instances is not meaningful.
SummableThe sum of the metric reading across multiple instances is meaningful.

CalculationAlgorithm:

The calculation which is performed on a source metric to obtain the metric being defined.

stringDescription
AverageThe metric is calculated as the average of a metric reading over a sliding time interval.
MaximumThe metric is calculated as the maximum value of a metric reading over during a time interval.
MinimumThe metric is calculated as the minimum value of a metric reading over a sliding time interval.

Implementation:

The implementation of the metric.

stringDescription
CalculatedThe metric is implemented by applying a calculation on another metric property. The calculation is specified in the CalculationAlgorithm property.
DigitalMeterThe metric is implemented as digital meter.
PhysicalSensorThe metric is implemented as a physical sensor.
SynthesizedThe metric is implemented by applying a calculation on one or more metric properties. (The calculation is not specified. For expressing generalized formula, see MathSON).

MetricDataType:

The data type of the metric.

stringDescription
BooleanThe data type follows the JSON Boolean definition.
DateTimeThe data type follows the JSON String definition with the Date-Time format applied.
DecimalThe data type follows the JSON Decimal definition.
EnumerationThe data type follows the JSON String definition with a set of enumerations defined.
IntegerThe data type follows the JSON Integer definition.
StringThe data type follows the JSON String definition.

MetricType:

The type of metric.

stringDescription
CountdownThe metric is a countdown metric. The metric reading is a non-negative integer which decreases monotonically. When a counter reaches its minimum, the value resets to preset value and resumes counting down.
CounterThe metric is a counter metric. The metric reading is a non-negative integer which increases monotonically. When a counter reaches its maximum, the value resets to 0 and resumes counting.
DiscreteThe metric is a discrete metric. The metric value is discrete. The possible values are listed in the DiscreteValues property.
GaugeThe metric is a gauge metric. The metric value is a real number. When the metric value reaches the gauges extrema, it stays at that value, until the reading falls within the extrema.
NumericThe metric is a numeric metric. The metric value is any real number.

PhysicalContext:

Specifies the physical context of the metric.

stringDescription
AcceleratorAn Accelerator.
ACInputAn AC Input.
ACMaintenanceBypassInputAn AC Maintenance Bypass Input.
ACOutputAn AC Output.
ACStaticBypassInputAn AC Static Bypass Input.
ACUtilityInputAn AC Utility Input.
ASICAn ASIC device, such as networking chip or a chipset component.
BackThe back of the chassis.
BackplaneA backplane within the chassis.
ChassisThe entire chassis.
ComputeBayWithin a compute bay.
CoolingSubsystemThe entire cooling (air and liquid) subsystem.
CPUA Processor (CPU).
CPUSubsystemThe entire Processor (CPU) subsystem.
DCBusA DC Bus.
ExhaustThe air exhaust point(s) or region of the chassis.
ExpansionBayWithin an expansion bay.
FanA fan.
FPGAA Field Programmable Gate Array (FPGA).
FrontThe front of the chassis.
GPUA Graphics Processor (GPU).
GPUSubsystemThe entire Graphics Processor (GPU) subsystem.
IntakeThe air intake point(s) or region of the chassis.
LiquidInletThe liquid inlet point of the chassis.
LiquidOutletThe liquid outlet point of the chassis.
LowerThe lower portion of the chassis.
MemoryA memory device.
MemorySubsystemThe entire Memory subsystem.
MotorA motor.
NetworkBayWithin a networking bay.
NetworkingDeviceA networking device.
PowerSubsystemThe entire power subsystem.
PowerSupplyA power supply.
PowerSupplyBayWithin a power supply bay.
RectifierA rectifier device.
RoomThe room.
StorageBayWithin a storage bay.
StorageDeviceA storage device.
SystemBoardThe system board (PCB).
TransformerA Transformer.
UpperThe upper portion of the chassis.
VoltageRegulatorA voltage regulator device.

Example Response

{
    "@odata.type": "#MetricDefinition.v1_0_0.MetricDefinition",
    "Id": "PowerConsumedWatts",
    "Name": "Power Consumed Watts Metric Definition",
    "MetricType": "Numeric",
    "Implementation": "PhysicalSensor",
    "PhysicalContext": "PowerSupply",
    "MetricDataType": "Decimal",
    "Units": "W",
    "Precision": 4,
    "Accuracy": 1,
    "Calibration": 2,
    "MinReadingRange": 0,
    "MaxReadingRange": 50,
    "SensingInterval": "PT1S",
    "TimestampAccuracy": "PT1S",
    "Wildcards": [
        {
            "Name": "ChassisID",
            "Values": [
                "1"
            ]
        }
    ],
    "MetricProperties": [
        "/redfish/v1/Chassis/{ChassisID}/Power#/PowerControl/0/PowerConsumedWatts"
    ],
    "@odata.context": "/redfish/v1/$metadata#MetricDefinition.MetricDefinition",
    "@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/PowerConsumedWatts"
}

MetricReport 1.1.1

v1.1v1.0
2018.32018.2

The metric definitions used to create a metric report.

URIs:

MetricReportDefinition {objectThe metric definitions used to create a metric report.
See the MetricReportDefinition schema for details on this property.
      @odata.id
}
stringread-onlyLink to a MetricReportDefinition resource. See the Links section and the MetricReportDefinition schema for details.
MetricValues [ {arrayAn array of metric values for the metered items of this Metric.
      MetricDefinition {objectA link to the Metric Definition.
See the MetricDefinition schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a MetricDefinition resource. See the Links section and the MetricDefinition schema for details.
      MetricIdstringread-only (null)The metric definitions identifier for this metric.
      MetricPropertystringread-only (null)The URI for the property from which this metric is derived.
      MetricValuestringread-only (null)The value identifies this resource.
      Timestamp
} ]
stringread-only (null)The time when the value of the metric is obtained. A management application may establish a time series of metric data by retrieving the instances of metric value and sorting them according to their Timestamp.
ReportSequencestringread-only requiredThe current sequence identifier for this metric report.
Timestamp (v1.1+)stringread-only (null)The time associated with the metric report in its entirety. The time of the metric report may be relevant when the time of individual metrics are minimally different.

Example Response

{
    "@odata.type": "#MetricReport.v1_0_0.MetricReport",
    "Id": "AvgPlatformPowerUsage",
    "Name": "Average Platform Power Usage metric report",
    "ReportSequence": "127",
    "MetricReportDefinition": {
        "@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions/AvgPlatformPowerUsage"
    },
    "MetricValues": [
        {
            "MetricId": "AverageConsumedWatts",
            "MetricValue": "100",
            "Timestamp": "2016-11-08T12:25:00-05:00",
            "MetricProperty": "/redfish/v1/Chassis/Tray_1/Power#/0/PowerConsumedWatts"
        },
        {
            "MetricId": "AverageConsumedWatts",
            "MetricValue": "94",
            "Timestamp": "2016-11-08T13:25:00-05:00",
            "MetricProperty": "/redfish/v1/Chassis/Tray_1/Power#/0/PowerConsumedWatts"
        },
        {
            "MetricId": "AverageConsumedWatts",
            "MetricValue": "100",
            "Timestamp": "2016-11-08T14:25:00-05:00",
            "MetricProperty": "/redfish/v1/Chassis/Tray_1/Power#/0/PowerConsumedWatts"
        }
    ],
    "@odata.context": "/redfish/v1/$metadata#MetricReport.MetricReport",
    "@odata.id": "/redfish/v1/TelemetryService/MetricReports/AvgPlatformPowerUsage"
}

MetricReportDefinition 1.2.0

v1.2v1.1v1.0
2019.12018.32018.2

A set of metrics that are collected into a metric report.

URIs:

AppendLimitintegerread-onlyIndicates the maximum number of entries that can be appended to a metric report. When the metric report reaches its limit, its behavior is dictated by the ReportUpdates property.
Links (v1.2+) {objectContains references to other resources that are related to this resource.
      Oem { }objectSee the OEM object definition in the Common properties section.
      Triggers [ {arrayThe triggers that will cause this metric report definition to generate a new metric report upon a trigger occurrence when the TriggerActions property contains the value RedfishMetricReport.
            @odata.id
      } ]
}
stringread-onlyLink to a Triggers resource. See the Links section and the Triggers schema for details.
MetricProperties [ ] array
(string, null)
read-writeA list of URIs with wildcards and property identifiers to include in the metric report. If a URI has wildcards, the wildcards are substituted as specified in the Wildcards array property.
MetricReport {objectSpecifies the location where the resultant metric report is placed.
See the MetricReport schema for details on this property.
      @odata.id
}
stringread-onlyLink to a MetricReport resource. See the Links section and the MetricReport schema for details.
MetricReportDefinitionEnabled (v1.2+)booleanread-write (null)This indicates whether this MetricReportDefinition is enabled.
MetricReportDefinitionTypestring
(enum)
read-write (null)Specifies when the metric report is generated.
See MetricReportDefinitionType in Property Details, below, for the possible values of this property.
MetricReportHeartbeatInterval (v1.2+)stringread-write (null)This property specifices an interval to send complete MetricReport regardless of whether values have changed. It is used in addition to the ReccurranceInterval where SuppressRepeatedMetricValue is Enabled and the Redfish client desired to be refreshed with metric data occasionally regardless of whether the data is changed or not.
Metrics [ {arraySpecifies a list of metrics to include in the metric report. The metrics may include metric properties or calculations applied to a metric property.
      CollectionDurationstringread-write (null)Specifies the duration over which the function is computed.
      CollectionFunctionstring
(enum)
read-write (null)Specified the function to perform on each of the metric properties listed in the MetricProperties property.
See CollectionFunction in Property Details, below, for the possible values of this property.
      CollectionTimeScopestring
(enum)
read-write (null)Specifies the scope of time scope over which the function is applied.
See CollectionTimeScope in Property Details, below, for the possible values of this property.
      MetricIdstringread-only (null)Specifies the label for the metric definition which is derived by applying the CollectionFunction to the metric property.
      MetricProperties [ ]
} ]
array
(string, null)
read-writeA collection of URI for the properties on which this metric is collected.
ReportActions [ ] array (string
(enum))
read-onlySpecifies the actions to perform when a metric report is generated. Actions to perform when a metric report is generated.
See ReportActions in Property Details, below, for the possible values of this property.
ReportUpdatesstring
(enum)
read-onlyWhen logging metric reports, specifies how subsequent metric reports are handled in relationship to an existing metric report created from the metric report definition. Namely, whether to overwrite, append, or create new report resource.
See ReportUpdates in Property Details, below, for the possible values of this property.
Schedule { }objectSpecifies the schedule for generating the metric report.
See the Schedule object for details on this property.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
SuppressRepeatedMetricValue (v1.2+)booleanread-write (null)A value of true indicates that any Metric in the MetricReport currently be generated will be suppressed and not included in the MetricReport when the value of the Metric equals the value of the same Metric in the previously generated MetricReport. A value of false means that the suppression mechanism is not applied to the MetricReport being generated. A MetricReport may be generated with no MetricProperty array values if all Metrics had the same values as in the previously generated MetricReport.
Wildcards [ {arrayA list of wildcards and their substitution values to be applied to the entries in the MetricProperties array property.
      Keys (deprecated v1.2) [ ] array
(string, null)
read-onlyAn array of values to substitute for the wildcard. Deprecated v1.2+. This property has been Deprecated in favor of using the property 'Values'.
      Namestringread-only (null)The string used as a wildcard.
      Values (v1.1+) [ ]
} ]
array
(string, null)
read-onlyAn array of values to substitute for the wildcard.

Property Details

CollectionFunction:

Specified the function to perform on each of the metric properties listed in the MetricProperties property.

stringDescription
AverageThe metric is calculated as the average of a metric reading over a sliding time interval.
MaximumThe metric is calculated as the maximum value of a metric reading over during a time interval.
MinimumThe metric is calculated as the minimum value of a metric reading over a sliding time interval.
SummationThe metric is calculated as the sum of the values over a sliding time interval.

CollectionTimeScope:

Specifies the scope of time scope over which the function is applied.

stringDescription
IntervalThe corresponding metric values apply to a time interval. On the corresponding metric value instances, the value of Timestamp shall specify the end of the time interval and Duration shall specify its duration.
PointThe corresponding metric values apply to a point in time. On the corresponding metric value instances, the value of Timestamp shall specify the point in time.
StartupIntervalThe corresponding metric values apply to a time interval that began at the startup of the measured resource (i.e. the Resources associated by Links.MetricDefinitionForResources). On the corresponding metric value instances, the value of Timestamp shall specify the end of the time interval. The value of Duration shall specifies the duration between startup of the resource and TimeStamp.

MetricReportDefinitionType:

Specifies when the metric report is generated.

stringDescription
OnChangeThe metric report is generated when any of the metric values change.
OnRequestThe metric report is generated when a HTTP GET is performed on the specified metric report.
PeriodicThe metric report is generated at a periodic time interval, specified in the Schedule property.

ReportActions:

Specifies the actions to perform when a metric report is generated. Actions to perform when a metric report is generated.

stringDescription
LogToMetricReportsCollectionWhen a metric report is scheduled to be generated, record the occurrence to the Metric Report Collection.
RedfishEventWhen a metric report is scheduled to be generated, send a Redfish Event message of type MetricReport.

ReportUpdates:

When logging metric reports, specifies how subsequent metric reports are handled in relationship to an existing metric report created from the metric report definition. Namely, whether to overwrite, append, or create new report resource.

stringDescription
AppendStopsWhenFullWhen a metric report is updated, append to the specified metric report resource. This also indicates that the metric report stops adding entries when the metric report has reached its maximum capacity.
AppendWrapsWhenFullWhen a metric report is updated, append to the specified metric report resource. This also indicates that the metric report overwrites its entries with new entries when the metric report has reached its maximum capacity.
NewReportWhen a metric report is updated, create a new metric report resource, whose resource name is the metric report resource name concatenated with the timestamp.
OverwriteWhen a metric report is updated, overwrite the specified metric report resource.

Example Response

{
    "@odata.type": "#MetricReportDefinition.v1_1_0.MetricReportDefinition",
    "Id": "PlatformPowerUsage",
    "Name": "Transmit and Log Platform Power Usage",
    "MetricReportDefinitionType": "Periodic",
    "Schedule": {
        "RecurrenceInterval": "T01:00:00"
    },
    "ReportActions": [
        "RedfishEvent",
        "LogToMetricReportsCollection"
    ],
    "ReportUpdates": "AppendWrapsWhenFull",
    "AppendLimit": 256,
    "MetricReport": {
        "@odata.id": "/redfish/v1/TelemetryService/MetricReports/PlatformPowerUsage"
    },
    "Status": {
        "State": "Enabled"
    },
    "Wildcards": [
        {
            "Name": "PWild",
            "Values": [
                "0"
            ]
        },
        {
            "Name": "TWild",
            "Values": [
                "Tray_1",
                "Tray_2"
            ]
        }
    ],
    "MetricProperties": [
        "/redfish/v1/Chassis/{TWild}/Power#/PowerControl/{PWild}/PowerConsumedWatts"
    ],
    "@odata.context": "/redfish/v1/$metadata#MetricReportDefinition.MetricReportDefinition",
    "@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions/PlatformPowerUsage"
}

NetworkAdapter 1.2.1

v1.2v1.1v1.0
2018.22017.32016.3

A NetworkAdapter represents the physical network adapter capable of connecting to a computer network. Examples include but are not limited to Ethernet, Fibre Channel, and converged network adapters.

URIs:

Assembly (v1.1+) {objectA reference to the Assembly resource associated with this adapter.
See the Assembly schema for details on this property.
      @odata.id
}
stringread-onlyLink to a Assembly resource. See the Links section and the Assembly schema for details.
Controllers [ {arrayThe set of network controllers ASICs that make up this NetworkAdapter.
      ControllerCapabilities {objectThe capabilities of this controller.
            DataCenterBridging {objectData Center Bridging (DCB) for this controller.
                  Capable
            }
booleanread-only (null)Whether this controller is capable of Data Center Bridging (DCB).
            NetworkDeviceFunctionCountintegerread-only (null)The maximum number of physical functions available on this controller.
            NetworkPortCountintegerread-only (null)The number of physical ports on this controller.
            NPAR (v1.2+) {objectNIC Partitioning (NPAR) capabilities for this controller.
                  NparCapablebooleanread-only (null)Indicates whether or not NIC function partitioning is supported by a controller.
                  NparEnabled
            }
booleanread-write (null)When true, NIC function partitioning is active on this controller.
            NPIV {objectN_Port ID Virtualization (NPIV) capabilties for this controller.
                  MaxDeviceLoginsintegerread-only (null)The maximum number of N_Port ID Virtualization (NPIV) logins allowed simultaneously from all ports on this controller.
                  MaxPortLogins
            }
integerread-only (null)The maximum number of N_Port ID Virtualization (NPIV) logins allowed per physical port on this controller.
            VirtualizationOffload {objectVirtualization offload for this controller.
                  SRIOV {objectSingle-Root Input/Output Virtualization (SR-IOV) capabilities.
                        SRIOVVEPACapable
                  }
booleanread-only (null)Whether this controller supports Single Root Input/Output Virtualization (SR-IOV) in Virtual Ethernet Port Aggregator (VEPA) mode.
                  VirtualFunction {objectThe virtual function of the controller.
                        DeviceMaxCountintegerread-only (null)The maximum number of Virtual Functions (VFs) supported by this controller.
                        MinAssignmentGroupSizeintegerread-only (null)The minimum number of Virtual Functions (VFs) that can be allocated or moved between physical functions for this controller.
                        NetworkPortMaxCount
                  }
            }
      }
integerread-only (null)The maximum number of Virtual Functions (VFs) supported per network port for this controller.
      FirmwarePackageVersionstringread-only (null)The version of the user-facing firmware package.
      Links {objectLinks.
            NetworkDeviceFunctions [ {arrayAn array of references to the NetworkDeviceFunctions associated with this Network Controller.
                  @odata.id
            } ]
stringread-onlyLink to a NetworkDeviceFunction resource. See the Links section and the NetworkDeviceFunction schema for details.
            NetworkPorts [ {arrayAn array of references to the NetworkPorts associated with this Network Controller.
                  @odata.id
            } ]
stringread-onlyLink to a NetworkPort resource. See the Links section and the NetworkPort schema for details.
            Oem { }objectSee the OEM object definition in the Common properties section.
            PCIeDevices [ {arrayAn array of references to the PCIeDevices associated with this Network Controller.
                  @odata.id
            } ]
      }
stringread-onlyLink to a PCIeDevice resource. See the Links section and the PCIeDevice schema for details.
      Location (v1.1+) { }objectThe Location of the network adapter controller.
See the Location object for details on this property.
      PCIeInterface (v1.2+) {objectThe PCIe interface details for this controller.
See the PCIeDevice schema for details on this property.
            @odata.id
      }
} ]
stringread-onlyLink to a PCIeInterface resource. See the Links section and the PCIeDevice schema for details.
Manufacturerstringread-only (null)The manufacturer or OEM of this network adapter.
Modelstringread-only (null)The model string for this network adapter.
NetworkDeviceFunctions {objectA reference to the collection of NetworkDeviceFunctions associated with this NetworkAdapter.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of NetworkDeviceFunction. See the NetworkDeviceFunction schema for details.
NetworkPorts {objectA reference to the collection of NetworkPorts associated with this NetworkAdapter.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of NetworkPort. See the NetworkPort schema for details.
PartNumberstringread-only (null)Part number for this network adapter.
SerialNumberstringread-only (null)The serial number for this network adapter.
SKUstringread-only (null)The manufacturer SKU for this network adapter.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.

Actions

ResetSettingsToDefault

This action is to clear the settings back to factory defaults.

URIs:

(This action takes no parameters.)

Example Response

{
    "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1",
    "@odata.type": "#NetworkAdapter.v1_2_0.NetworkAdapter",
    "Id": "9fa725a1",
    "Name": "Network Adapter View",
    "Manufacturer": "Contoso",
    "Model": "599TPS-T",
    "SKU": "Contoso TPS-Net 2-Port Base-T",
    "SerialNumber": "003BFLRT00023234",
    "PartNumber": "975421-B20",
    "NetworkPorts": {
        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1/NetworkPorts"
    },
    "NetworkDeviceFunctions": {
        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1/NetworkDeviceFunctions"
    },
    "Controllers": [
        {
            "FirmwarePackageVersion": "7.4.10",
            "Links": {
                "PCIeDevices": [
                    {
                        "@odata.id": "/redfish/v1/Systems/1/PCIeDevices/NIC"
                    }
                ],
                "NetworkPorts": [
                    {
                        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1/NetworkPorts/1"
                    }
                ],
                "NetworkDeviceFunctions": [
                    {
                        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1/NetworkDeviceFunctions/111111111100"
                    }
                ]
            },
            "ControllerCapabilities": {
                "NetworkPortCount": 2,
                "NetworkDeviceFunctionCount": 8,
                "DataCenterBridging": {
                    "Capable": true
                },
                "VirtualizationOffload": {
                    "VirtualFunction": {
                        "DeviceMaxCount": 256,
                        "NetworkPortMaxCount": 128,
                        "MinAssignmentGroupSize": 4
                    },
                    "SRIOV": {
                        "SRIOVVEPACapable": true
                    }
                },
                "NPIV": {
                    "MaxDeviceLogins": 4,
                    "MaxPortLogins": 2
                },
                "NPAR": {
                    "NparCapable": true,
                    "NparEnabled": false
                }
            },
            "PCIeInterface": {
                "PCIeType": "Gen2",
                "MaxPCIeType": "Gen3",
                "LanesInUse": 1,
                "MaxLanes": 4
            },
            "Location": {
                "PartLocation": {
                    "ServiceLabel": "Slot 1",
                    "LocationType": "Slot",
                    "LocationOrdinalValue": 0,
                    "Reference": "Rear",
                    "Orientation": "LeftToRight"
                }
            }
        }
    ],
    "Actions": {
        "#NetworkAdapter.ResetSettingsToDefault": {
            "target": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1/Actions/NetworkAdapter.ResetSettingsToDefault"
        },
        "Oem": {}
    }
}

NetworkDeviceFunction 1.3.2

v1.3v1.2v1.1v1.0
2018.22017.32017.12016.3

A Network Device Function represents a logical interface exposed by the network adapter.

URIs:

AssignablePhysicalPorts [ {arrayThe array of physical port references that this network device function may be assigned to.
      @odata.id
} ]
stringread-onlyLink to a NetworkPort resource. See the Links section and the NetworkPort schema for details.
BootModestring
(enum)
read-write (null)The boot mode configured for this network device function.
See BootMode in Property Details, below, for the possible values of this property.
DeviceEnabledbooleanread-write (null)Whether the network device function is enabled.
Ethernet {objectEthernet.
      MACAddressstringread-write (null)This is the currently configured MAC address of the (logical port) network device function.
      MTUSizeintegerread-write (null)The Maximum Transmission Unit (MTU) configured for this network device function.
      PermanentMACAddressstringread-only (null)This is the permanent MAC address assigned to this network device function (physical function).
      VLAN (v1.3+) {objectIf this Network Interface supports more than one VLAN, this property is not present. VLANs collections appear in the Link section of this resource.
See the VLanNetworkInterface schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a VLAN resource. See the Links section and the VLanNetworkInterface schema for details.
      VLANs (v1.3+) {objectThis is a reference to a collection of VLANs and is only used if the interface supports more than one VLANs.
Contains a link to a resource.
            @odata.id
      }
}
stringread-onlyLink to Collection of VLanNetworkInterface. See the VLanNetworkInterface schema for details.
FibreChannel {objectFibre Channel.
      AllowFIPVLANDiscoverybooleanread-write (null)Whether the FCoE Initialization Protocol (FIP) is used for populating the FCoE VLAN Id.
      BootTargets [ {arrayAn array of Fibre Channel boot targets configured for this network device function.
            BootPriorityintegerread-write (null)The relative priority for this entry in the boot targets array.
            LUNIDstringread-write (null)The Logical Unit Number (LUN) ID to boot from on the device referred to by the corresponding WWPN.
            WWPN
      } ]
stringread-write (null)The World-Wide Port Name to boot from.
      FCoEActiveVLANIdintegerread-only (null)The active FCoE VLAN ID.
      FCoELocalVLANIdintegerread-write (null)The locally configured FCoE VLAN ID.
      FibreChannelId (v1.3+)stringread-only (null)The Fibre Channel Id assigned by the switch for this interface.
      PermanentWWNNstringread-only (null)This is the permanent WWNN address assigned to this network device function (physical function).
      PermanentWWPNstringread-only (null)This is the permanent WWPN address assigned to this network device function (physical function).
      WWNNstringread-write (null)This is the currently configured WWNN address of the network device function (physical function).
      WWNSourcestring
(enum)
read-write (null)The configuration source of the WWNs for this connection (WWPN and WWNN).
See WWNSource in Property Details, below, for the possible values of this property.
      WWPN
}
stringread-write (null)This is the currently configured WWPN address of the network device function (physical function).
iSCSIBoot {objectiSCSI Boot.
      AuthenticationMethodstring
(enum)
read-write (null)The iSCSI boot authentication method for this network device function.
See AuthenticationMethod in Property Details, below, for the possible values of this property.
      CHAPSecretstringread-write (null)The shared secret for CHAP authentication.
      CHAPUsernamestringread-write (null)The username for CHAP authentication.
      InitiatorDefaultGatewaystringread-write (null)The IPv6 or IPv4 iSCSI boot default gateway.
      InitiatorIPAddressstringread-write (null)The IPv6 or IPv4 address of the iSCSI initiator.
      InitiatorNamestringread-write (null)The iSCSI initiator name.
      InitiatorNetmaskstringread-write (null)The IPv6 or IPv4 netmask of the iSCSI boot initiator.
      IPAddressTypestring
(enum)
read-write (null)The type of IP address (IPv6 or IPv4) being populated in the iSCSIBoot IP address fields.
See IPAddressType in Property Details, below, for the possible values of this property.
      IPMaskDNSViaDHCPbooleanread-write (null)Whether the iSCSI boot initiator uses DHCP to obtain the iniator name, IP address, and netmask.
      MutualCHAPSecretstringread-write (null)The CHAP Secret for 2-way CHAP authentication.
      MutualCHAPUsernamestringread-write (null)The CHAP Username for 2-way CHAP authentication.
      PrimaryDNSstringread-write (null)The IPv6 or IPv4 address of the primary DNS server for the iSCSI boot initiator.
      PrimaryLUNintegerread-write (null)The logical unit number (LUN) for the primary iSCSI boot target.
      PrimaryTargetIPAddressstringread-write (null)The IP address (IPv6 or IPv4) for the primary iSCSI boot target.
      PrimaryTargetNamestringread-write (null)The name of the iSCSI primary boot target.
      PrimaryTargetTCPPortintegerread-write (null)The TCP port for the primary iSCSI boot target.
      PrimaryVLANEnablebooleanread-write (null)This indicates if the primary VLAN is enabled.
      PrimaryVLANIdintegerread-write (null)The 802.1q VLAN ID to use for iSCSI boot from the primary target.
      RouterAdvertisementEnabledbooleanread-write (null)Whether IPv6 router advertisement is enabled for the iSCSI boot target.
      SecondaryDNSstringread-write (null)The IPv6 or IPv4 address of the secondary DNS server for the iSCSI boot initiator.
      SecondaryLUNintegerread-write (null)The logical unit number (LUN) for the secondary iSCSI boot target.
      SecondaryTargetIPAddressstringread-write (null)The IP address (IPv6 or IPv4) for the secondary iSCSI boot target.
      SecondaryTargetNamestringread-write (null)The name of the iSCSI secondary boot target.
      SecondaryTargetTCPPortintegerread-write (null)The TCP port for the secondary iSCSI boot target.
      SecondaryVLANEnablebooleanread-write (null)This indicates if the secondary VLAN is enabled.
      SecondaryVLANIdintegerread-write (null)The 802.1q VLAN ID to use for iSCSI boot from the secondary target.
      TargetInfoViaDHCP
}
booleanread-write (null)Whether the iSCSI boot target name, LUN, IP address, and netmask should be obtained from DHCP.
Links {objectLinks.
      Endpoints (v1.2+) [ {arrayAn array of references to endpoints associated with this network device function.
            @odata.id
      } ]
stringread-onlyLink to a Endpoint resource. See the Links section and the Endpoint schema for details.
      PCIeFunction {objectA reference to the PCIeFunction associated with this Network Device Function.
See the PCIeFunction schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a PCIeFunction resource. See the Links section and the PCIeFunction schema for details.
      PhysicalPortAssignment (v1.3+) {objectThe physical port that this network device function is currently assigned to.
See the NetworkPort schema for details on this property.
            @odata.id
      }
}
stringread-onlyLink to a NetworkPort resource. See the Links section and the NetworkPort schema for details.
MaxVirtualFunctionsintegerread-only (null)The number of virtual functions (VFs) that are available for this Network Device Function.
NetDevFuncCapabilities (v1.2+) [ ] array (string
(enum))
read-only (null)Capabilities of this network device function.
See NetDevFuncCapabilities in Property Details, below, for the possible values of this property.
NetDevFuncType (v1.2+)string
(enum)
read-write (null)The configured capability of this network device function.
See NetDevFuncType in Property Details, below, for the possible values of this property.
PhysicalPortAssignment (deprecated v1.3) {objectThe physical port that this network device function is currently assigned to.
See the NetworkPort schema for details on this property. Deprecated v1.3+. This property has been deprecated and moved to the Links section to avoid loops on expand.
      @odata.id
}
stringread-onlyLink to a NetworkPort resource. See the Links section and the NetworkPort schema for details.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
VirtualFunctionsEnabledbooleanread-only (null)Whether Single Root I/O Virtualization (SR-IOV) Virual Functions (VFs) are enabled for this Network Device Function.

Property Details

AuthenticationMethod:

The iSCSI boot authentication method for this network device function.

stringDescription
CHAPiSCSI Challenge Handshake Authentication Protocol (CHAP) authentication is used.
MutualCHAPiSCSI Mutual Challenge Handshake Authentication Protocol (CHAP) authentication is used.
NoneNo iSCSI authentication is used.

BootMode:

The boot mode configured for this network device function.

stringDescription
DisabledDo not indicate to UEFI/BIOS that this device is bootable.
FibreChannelBoot this device using the embedded Fibre Channel support and configuration. Only applicable if the NetworkDeviceFunctionType is set to FibreChannel.
FibreChannelOverEthernetBoot this device using the embedded Fibre Channel over Ethernet (FCoE) boot support and configuration. Only applicable if the NetworkDeviceFunctionType is set to FibreChannelOverEthernet.
iSCSIBoot this device using the embedded iSCSI boot support and configuration. Only applicable if the NetworkDeviceFunctionType is set to iSCSI.
PXEBoot this device using the embedded PXE support. Only applicable if the NetworkDeviceFunctionType is set to Ethernet.

IPAddressType:

The type of IP address (IPv6 or IPv4) being populated in the iSCSIBoot IP address fields.

stringDescription
IPv4IPv4 addressing is used for all IP-fields in this object.
IPv6IPv6 addressing is used for all IP-fields in this object.

NetDevFuncCapabilities:

Capabilities of this network device function.

stringDescription
DisabledNeither enumerated nor visible to the operating system.
EthernetAppears to the operating system as an Ethernet device.
FibreChannelAppears to the operating system as a Fibre Channel device.
FibreChannelOverEthernetAppears to the operating system as an FCoE device.
iSCSIAppears to the operating system as an iSCSI device.

NetDevFuncType:

The configured capability of this network device function.

stringDescription
DisabledNeither enumerated nor visible to the operating system.
EthernetAppears to the operating system as an Ethernet device.
FibreChannelAppears to the operating system as a Fibre Channel device.
FibreChannelOverEthernetAppears to the operating system as an FCoE device.
iSCSIAppears to the operating system as an iSCSI device.

WWNSource:

The configuration source of the WWNs for this connection (WWPN and WWNN).

stringDescription
ConfiguredLocallyThe set of FC/FCoE boot targets was applied locally through API or UI.
ProvidedByFabricThe set of FC/FCoE boot targets was applied by the Fibre Channel fabric.

Example Response

{
    "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1/NetworkDeviceFunctions/111111111100",
    "@odata.type": "#NetworkDeviceFunction.v1_3_0.NetworkDeviceFunction",
    "Id": "111111111100",
    "Name": "Network Device Function View",
    "NetDevFuncType": "Ethernet",
    "DeviceEnabled": true,
    "NetDevFuncCapabilities": [
        "Ethernet",
        "FibreChannel"
    ],
    "Ethernet": {
        "PermanentMACAddress": "00:0C:29:9A:98:ED",
        "MACAddress": "00:0C:29:9A:98:ED",
        "MTUSize": 1500,
        "VLAN": {
            "VLANEnable": true,
            "VLANId": 101
        }
    },
    "iSCSIBoot": {
        "IPAddressType": "IPv4",
        "InitiatorIPAddress": "16.0.11.6",
        "InitiatorName": "iqn.2005-03.com.acme:database-server",
        "InitiatorDefaultGateway": "169.0.16.1",
        "InitiatorNetmask": "255.255.252.0",
        "TargetInfoViaDHCP": false,
        "PrimaryTargetName": "iqn.2005-03.com.acme:image-server",
        "PrimaryTargetIPAddress": "169.0.15.1",
        "PrimaryTargetTCPPort": 3260,
        "PrimaryLUN": 5,
        "PrimaryVLANEnable": true,
        "PrimaryVLANId": 1001,
        "PrimaryDNS": "16.0.10.21",
        "SecondaryTargetName": "iqn.2005-03.com.acme:image-server",
        "SecondaryTargetIPAddress": "16.0.11.5",
        "SecondaryTargetTCPPort": 3260,
        "SecondaryLUN": 5,
        "SecondaryVLANEnable": true,
        "SecondaryVLANId": 1002,
        "SecondaryDNS": "169.0.10.22",
        "IPMaskDNSViaDHCP": false,
        "RouterAdvertisementEnabled": false,
        "AuthenticationMethod": "CHAP",
        "CHAPUsername": "yosemite",
        "CHAPSecret": "usrpasswd",
        "MutualCHAPUsername": "yosemite",
        "MutualCHAPSecret": "usrpasswd"
    },
    "FibreChannel": {
        "PermanentWWPN": "10:00:B0:5A:DD:BB:74:E0",
        "PermanentWWNN": "10:00:B0:5A:DD:BB:A1:B3",
        "WWPN": "10:00:B0:5A:DD:BB:74:E0",
        "WWNN": "10:00:B0:5A:DD:C4:D3:BB",
        "WWNSource": "ConfiguredLocally",
        "FCoELocalVLANId": 1001,
        "AllowFIPVLANDiscovery": true,
        "FCoEActiveVLANId": 2001,
        "BootTargets": [
            {
                "WWPN": "10:00:B0:5A:DD:BB:74:FA",
                "LUNID": "3",
                "BootPriority": 0
            }
        ]
    },
    "AssignablePhysicalPorts": [
        {
            "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1/NetworkPorts/1"
        }
    ],
    "BootMode": "Disabled",
    "VirtualFunctionsEnabled": true,
    "MaxVirtualFunctions": 16,
    "Links": {
        "PCIeFunction": {
            "@odata.id": "/redfish/v1/Systems/1/PCIeDevices/NIC/PCIeFunctions/1"
        },
        "PhysicalPortAssignment": {
            "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1/NetworkPorts/1"
        }
    }
}

NetworkInterface 1.1.2

v1.1v1.0
2017.12016.3

A NetworkInterface contains references linking NetworkAdapter, NetworkPort, and NetworkDeviceFunction resources and represents the functionality available to the containing system.

URIs:

Links {objectLinks.
      NetworkAdapter {objectA reference to the NetworkAdapter which contains this NetworkInterface.
See the NetworkAdapter schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a NetworkAdapter resource. See the Links section and the NetworkAdapter schema for details.
      Oem { }
}
objectSee the OEM object definition in the Common properties section.
NetworkDeviceFunctions {objectA reference to the collection of NetworkDeviceFunctions associated with this NetworkInterface.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of NetworkDeviceFunction. See the NetworkDeviceFunction schema for details.
NetworkPorts {objectA reference to the collection of NetworkPorts associated with this NetworkInterface.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of NetworkPort. See the NetworkPort schema for details.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.

Example Response

{
    "@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces/9fd725a1",
    "@odata.type": "#NetworkInterface.v1_0_0.NetworkInterface",
    "Id": "9fa725a1",
    "Name": "Network Device View",
    "NetworkPorts": {
        "@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces/9fd725a1/NetworkPorts"
    },
    "NetworkDeviceFunctions": {
        "@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces/9fd725a1/NetworkDeviceFunctions"
    },
    "Links": {
        "NetworkAdapter": {
            "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1"
        }
    }
}

NetworkPort 1.2.2

v1.2v1.1v1.0
2018.22017.12016.3

A Network Port represents a discrete physical port capable of connecting to a network.

URIs:

ActiveLinkTechnologystring
(enum)
read-write (null)Network Port Active Link Technology.
See ActiveLinkTechnology in Property Details, below, for the possible values of this property.
AssociatedNetworkAddresses [ ] array
(string, null)
read-onlyThe array of configured network addresses (MAC or WWN) that are associated with this Network Port, including the programmed address of the lowest numbered Network Device Function, the configured but not active address if applicable, the address for hardware port teaming, or other network addresses.
CurrentLinkSpeedMbps (v1.2+)integer
(Mbit/s)
read-write (null)Network Port Current Link Speed.
EEEEnabledbooleanread-write (null)Whether IEEE 802.3az Energy Efficient Ethernet (EEE) is enabled for this network port.
FCFabricName (v1.2+)stringread-only (null)The FC Fabric Name provided by the switch.
FCPortConnectionType (v1.2+)string
(enum)
read-only (null)This is the connection type of this port.
See FCPortConnectionType in Property Details, below, for the possible values of this property.
FlowControlConfigurationstring
(enum)
read-write (null)The locally configured 802.3x flow control setting for this network port.
See FlowControlConfiguration in Property Details, below, for the possible values of this property.
FlowControlStatusstring
(enum)
read-only (null)The 802.3x flow control behavior negotiated with the link partner for this network port (Ethernet-only).
See FlowControlStatus in Property Details, below, for the possible values of this property.
LinkStatusstring
(enum)
read-only (null)The status of the link between this port and its link partner.
See LinkStatus in Property Details, below, for the possible values of this property.
MaxFrameSize (v1.2+)integer
(bytes)
read-only (null)The maximum frame size supported by the port.
NetDevFuncMaxBWAlloc [ {arrayThe array of maximum bandwidth allocation percentages for the Network Device Functions associated with this port.
      MaxBWAllocPercentinteger
(%)
read-write (null)The maximum bandwidth allocation percentage allocated to the corresponding network device function instance.
      NetworkDeviceFunction {objectA reference to the NetworkDeviceFunction associated with this bandwidth setting of this Network Port.
See the NetworkDeviceFunction schema for details on this property.
            @odata.id
      }
} ]
stringread-onlyLink to a NetworkDeviceFunction resource. See the Links section and the NetworkDeviceFunction schema for details.
NetDevFuncMinBWAlloc [ {arrayThe array of minimum bandwidth allocation percentages for the Network Device Functions associated with this port.
      MinBWAllocPercentinteger
(%)
read-write (null)The minimum bandwidth allocation percentage allocated to the corresponding network device function instance.
      NetworkDeviceFunction {objectA reference to the NetworkDeviceFunction associated with this bandwidth setting of this Network Port.
See the NetworkDeviceFunction schema for details on this property.
            @odata.id
      }
} ]
stringread-onlyLink to a NetworkDeviceFunction resource. See the Links section and the NetworkDeviceFunction schema for details.
NumberDiscoveredRemotePorts (v1.2+)integerread-only (null)The number of ports not on this adapter that this port has discovered.
PhysicalPortNumberstringread-only (null)The physical port number label for this port.
PortMaximumMTUintegerread-only (null)The largest maximum transmission unit (MTU) that can be configured for this network port.
SignalDetectedbooleanread-only (null)Whether or not the port has detected enough signal on enough lanes to establish link.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
SupportedEthernetCapabilities [ ] array (string
(enum))
read-only (null)The set of Ethernet capabilities that this port supports.
See SupportedEthernetCapabilities in Property Details, below, for the possible values of this property.
SupportedLinkCapabilities [ {arrayThe self-described link capabilities of this port.
      AutoSpeedNegotiation (v1.2+)booleanread-only (null)Indicates whether the port has the capability to auto negotiate speed.
      CapableLinkSpeedMbps (v1.2+) [ ] array
(integer, null)
read-onlyThe self-described link network speed capabilities of this port. Note: Should this be a new enumerated type of link speeds?.
      LinkNetworkTechnologystring
(enum)
read-only (null)The self-described link network technology capabilities of this port.
See LinkNetworkTechnology in Property Details, below, for the possible values of this property.
      LinkSpeedMbps (deprecated v1.2)
} ]
integer
(Mbit/s)
read-only (null)The speed of the link in Mbps when this link network technology is active. Deprecated v1.2+. This property has been Deprecated in favor of the CapableLinkSpeedMbps collection found in NetworkPort.v1_2_0.
VendorId (v1.2+)stringread-only (null)The Vendor Identification for this port.
WakeOnLANEnabledbooleanread-write (null)Whether Wake on LAN (WoL) is enabled for this network port.

Property Details

ActiveLinkTechnology:

Network Port Active Link Technology.

stringDescription
EthernetThe port is capable of connecting to an Ethernet network.
FibreChannelThe port is capable of connecting to a Fibre Channel network.
InfiniBandThe port is capable of connecting to an InfiniBand network.

FCPortConnectionType:

This is the connection type of this port.

stringDescription
ExtenderFabricThis port connection type is an extender fabric port.
GenericThis port connection type is a generic fabric port.
NotConnectedThis port is not connected.
NPortThis port connects via an N-Port to a switch.
PointToPointThis port connects in a Point-to-point configuration.
PrivateLoopThis port connects in a private loop configuration.
PublicLoopThis port connects in a public configuration.

FlowControlConfiguration:

The locally configured 802.3x flow control setting for this network port.

stringDescription
NoneNo IEEE 802.3x flow control is enabled on this port.
RXIEEE 802.3x flow control may be initiated by the link partner.
TXIEEE 802.3x flow control may be initiated by this station.
TX_RXIEEE 802.3x flow control may be initiated by this station or the link partner.

FlowControlStatus:

The 802.3x flow control behavior negotiated with the link partner for this network port (Ethernet-only).

stringDescription
NoneNo IEEE 802.3x flow control is enabled on this port.
RXIEEE 802.3x flow control may be initiated by the link partner.
TXIEEE 802.3x flow control may be initiated by this station.
TX_RXIEEE 802.3x flow control may be initiated by this station or the link partner.

LinkNetworkTechnology:

The self-described link network technology capabilities of this port.

stringDescription
EthernetThe port is capable of connecting to an Ethernet network.
FibreChannelThe port is capable of connecting to a Fibre Channel network.
InfiniBandThe port is capable of connecting to an InfiniBand network.

LinkStatus:

The status of the link between this port and its link partner.

stringDescription
DownThe port is enabled but link is down.
UpThe port is enabled and link is good (up).

SupportedEthernetCapabilities:

The set of Ethernet capabilities that this port supports.

stringDescription
EEEIEEE 802.3az Energy Efficient Ethernet (EEE) is supported on this port.
WakeOnLANWake on LAN (WoL) is supported on this port.

PCIeDevice 1.3.1

v1.3v1.2v1.1v1.0
2018.22017.32017.12016.2

This is the schema definition for the PCIeDevice resource. It represents the properties of a PCIeDevice attached to a System.

URIs:

Assembly (v1.2+) {objectA reference to the Assembly resource associated with this PCIe device.
See the Assembly schema for details on this property.
      @odata.id
}
stringread-onlyLink to a Assembly resource. See the Links section and the Assembly schema for details.
AssetTagstringread-write (null)The user assigned asset tag for this PCIe device.
DeviceTypestring
(enum)
read-onlyThe device type for this PCIe device.
See DeviceType in Property Details, below, for the possible values of this property.
FirmwareVersionstringread-only (null)The version of firmware for this PCIe device.
Links {objectThe links object contains the links to other resources that are related to this resource.
      Chassis [ {arrayAn array of references to the chassis in which the PCIe device is contained.
            @odata.id
      } ]
stringread-onlyLink to a Chassis resource. See the Links section and the Chassis schema for details.
      Oem { }objectSee the OEM object definition in the Common properties section.
      PCIeFunctions [ {arrayAn array of references to PCIeFunctions exposed by this device.
            @odata.id
      } ]
}
stringread-onlyLink to a PCIeFunction resource. See the Links section and the PCIeFunction schema for details.
Manufacturerstringread-only (null)This is the manufacturer of this PCIe device.
Modelstringread-only (null)This is the model number for the PCIe device.
PartNumberstringread-only (null)The part number for this PCIe device.
PCIeInterface (v1.3+) {objectThe PCIe interface details for this PCIe device.
      LanesInUseintegerread-only (null)This is the number of PCIe lanes in use by this device.
      MaxLanesintegerread-only (null)This is the number of PCIe lanes supported by this device.
      MaxPCIeTypestring
(enum)
read-only (null)The highest version of the PCIe specification supported by this device.
See MaxPCIeType in Property Details, below, for the possible values of this property.
      Oem { }objectSee the OEM object definition in the Common properties section.
      PCIeType
}
string
(enum)
read-only (null)The version of the PCIe specification in use by this device.
See PCIeType in Property Details, below, for the possible values of this property.
SerialNumberstringread-only (null)The serial number for this PCIe device.
SKUstringread-only (null)This is the SKU for this PCIe device.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.

Property Details

DeviceType:

The device type for this PCIe device.

stringDescription
MultiFunctionA multi-function PCIe device.
SimulatedA PCIe device which is not currently physically present, but is being simulated by the PCIe infrastructure.
SingleFunctionA single-function PCIe device.

MaxPCIeType:

The highest version of the PCIe specification supported by this device.

stringDescription
Gen1A PCIe v1.0 slot.
Gen2A PCIe v2.0 slot.
Gen3A PCIe v3.0 slot.
Gen4A PCIe v4.0 slot.
Gen5A PCIe v5.0 slot.

PCIeType:

The version of the PCIe specification in use by this device.

stringDescription
Gen1A PCIe v1.0 slot.
Gen2A PCIe v2.0 slot.
Gen3A PCIe v3.0 slot.
Gen4A PCIe v4.0 slot.
Gen5A PCIe v5.0 slot.

Example Response

{
    "@odata.id": "/redfish/v1/Systems/1/PCIeDevices/NIC",
    "@odata.type": "#PCIeDevice.v1_3_0.PCIeDevice",
    "Id": "NIC",
    "Name": "Simple Two-Port NIC",
    "Description": "Simple Two-Port NIC PCIe Device",
    "AssetTag": "ORD-4302015-18432RS",
    "Manufacturer": "Contoso",
    "Model": "SuperNIC 2000",
    "SKU": "89587433",
    "SerialNumber": "2M220100SL",
    "PartNumber": "232-4598D7",
    "DeviceType": "MultiFunction",
    "FirmwareVersion": "12.342-343",
    "Status": {
        "State": "Enabled",
        "Health": "OK",
        "HealthRollup": "OK"
    },
    "PCIeInterface": {
        "PCIeType": "Gen2",
        "MaxPCIeType": "Gen3",
        "LanesInUse": 4,
        "MaxLanes": 4
    },
    "Links": {
        "Chassis": [
            {
                "@odata.id": "/redfish/v1/Chassis/1"
            }
        ],
        "PCIeFunctions": [
            {
                "@odata.id": "/redfish/v1/Systems/1/PCIeDevices/NIC/PCIeFunctions/1"
            },
            {
                "@odata.id": "/redfish/v1/Systems/1/PCIeDevices/NIC/PCIeFunctions/2"
            }
        ],
        "Oem": {}
    },
    "Oem": {}
}

PCIeFunction 1.2.2

v1.2v1.1v1.0
2018.12017.12016.2

This is the schema definition for the PCIeFunction resource. It represents the properties of a PCIeFunction attached to a System.

URIs:

ClassCodestringread-only (null)The Class Code of this PCIe function.
DeviceClassstring
(enum)
read-onlyThe class for this PCIe Function.
See DeviceClass in Property Details, below, for the possible values of this property.
DeviceIdstringread-only (null)The Device ID of this PCIe function.
FunctionIdintegerread-only (null)The the PCIe Function identifier.
FunctionTypestring
(enum)
read-onlyThe type of the PCIe Function.
See FunctionType in Property Details, below, for the possible values of this property.
Links {objectThe links object contains the links to other resources that are related to this resource.
      Drives [ {arrayAn array of references to the drives which the PCIe device produces.
            @odata.id
      } ]
stringread-onlyLink to a Drive resource. See the Links section and the Drive schema for details.
      EthernetInterfaces [ {arrayAn array of references to the ethernet interfaces which the PCIe device produces.
            @odata.id
      } ]
stringread-onlyLink to a EthernetInterface resource. See the Links section and the EthernetInterface schema for details.
      NetworkDeviceFunctions (v1.2+) [ {arrayAn array of references to the Network Device Functions which the PCIe device produces.
            @odata.id
      } ]
stringread-onlyLink to a NetworkDeviceFunction resource. See the Links section and the NetworkDeviceFunction schema for details.
      Oem { }objectSee the OEM object definition in the Common properties section.
      PCIeDevice {objectA reference to the PCIeDevice on which this function resides.
See the PCIeDevice schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a PCIeDevice resource. See the Links section and the PCIeDevice schema for details.
      StorageControllers [ {arrayAn array of references to the storage controllers which the PCIe device produces.
            @odata.id
      } ]
}
stringread-onlyLink to a StorageController resource. See the Links section and the Storage schema for details.
RevisionIdstringread-only (null)The Revision ID of this PCIe function.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
SubsystemIdstringread-only (null)The Subsystem ID of this PCIe function.
SubsystemVendorIdstringread-only (null)The Subsystem Vendor ID of this PCIe function.
VendorIdstringread-only (null)The Vendor ID of this PCIe function.

Property Details

DeviceClass:

The class for this PCIe Function.

stringDescription
BridgeA bridge.
CommunicationControllerA communication controller.
CoprocessorA coprocessor.
DisplayControllerA display controller.
DockingStationA docking station.
EncryptionControllerAn encryption controller.
GenericSystemPeripheralA generic system peripheral.
InputDeviceControllerAn input device controller.
IntelligentControllerAn intelligent controller.
MassStorageControllerA mass storage controller.
MemoryControllerA memory controller.
MultimediaControllerA multimedia controller.
NetworkControllerA network controller.
NonEssentialInstrumentationA non-essential instrumentation.
OtherA other class. The function Device Class Id needs to be verified.
ProcessingAcceleratorsA processing accelerators.
ProcessorA processor.
SatelliteCommunicationsControllerA satellite communications controller.
SerialBusControllerA serial bus controller.
SignalProcessingControllerA signal processing controller.
UnassignedClassAn unassigned class.
UnclassifiedDeviceAn unclassified device.
WirelessControllerA wireless controller.

FunctionType:

The type of the PCIe Function.

stringDescription
PhysicalA physical PCie function.
VirtualA virtual PCIe function.

Example Response

{
    "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/FC/Functions/2",
    "@odata.type": "#PCIeFunction.v1_0_0.PCIeFunction",
    "Id": "2",
    "Name": "FC Port 2",
    "Description": "FC Port 2",
    "FunctionId": 2,
    "FunctionType": "Physical",
    "DeviceClass": "NetworkController",
    "DeviceId": "0xABCD",
    "VendorId": "0xABCD",
    "ClassCode": "0x010802",
    "RevisionId": "0x00",
    "SubsystemId": "0xABCD",
    "SubsystemVendorId": "0xABCD",
    "Status": {
        "State": "Enabled",
        "Health": "OK",
        "HealthRollup": "OK"
    },
    "Links": {
        "PCIeDevice": {
            "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/FC"
        }
    },
    "Oem": {}
}

PCIeSlots 1.1.0

v1.1v1.0
2019.12018.2

This is the schema definition for the PCIe Slot properties.

URIs:

HotPluggable (v1.1+)booleanread-only (null)Indicates whether the PCIe slot supports hotplug.
Slots [ {arrayAn array of PCI Slot information.
      Lanesintegerread-only (null)This is the number of PCIe lanes supported by this slot.
      Links {objectContains references to other resources that are related to this resource.
            Oem { }objectSee the OEM object definition in the Common properties section.
            PCIeDevice [ {arrayAn array of references to the PCIe Devices contained in this slot.
                  @odata.id
            } ]
      }
stringread-onlyLink to a PCIeDevice resource. See the Links section and the PCIeDevice schema for details.
      Location { }objectThe Location of the PCIe slot.
See the Location object for details on this property.
      Oem { }objectSee the OEM object definition in the Common properties section.
      PCIeTypestring
(enum)
read-only (null)This is the PCIe specification supported by this slot.
See PCIeType in Property Details, below, for the possible values of this property.
      SlotTypestring
(enum)
read-only (null)This is the PCIe slot type for this slot.
See SlotType in Property Details, below, for the possible values of this property.
      Status { }
} ]
objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.

Property Details

PCIeType:

This is the PCIe specification supported by this slot.

stringDescription
Gen1A PCIe v1.0 slot.
Gen2A PCIe v2.0 slot.
Gen3A PCIe v3.0 slot.
Gen4A PCIe v4.0 slot.
Gen5A PCIe v5.0 slot.

SlotType:

This is the PCIe slot type for this slot.

stringDescription
FullLengthFull-Length PCIe slot.
HalfLengthHalf-Length PCIe slot.
LowProfileLow-Profile or Slim PCIe slot.
M2PCIe M.2 slot.
MiniMini PCIe slot.
OEMAnd OEM-specific slot.

Example Response

{
    "@odata.type": "#PCIeSlots.v1_0_0.PCIeSlots",
    "Id": "1",
    "Name": "PCIe Slot Information",
    "Slots": [
        {
            "PCIeType": "Gen3",
            "Lanes": 16,
            "SlotType": "FullLength",
            "Status": {
                "State": "Enabled"
            },
            "Location": {
                "PartLocation": {
                    "ServiceLabel": "Slot 1",
                    "LocationOrdinalValue": 1,
                    "LocationType": "Slot",
                    "Orientation": "LeftToRight",
                    "Reference": "Rear"
                }
            },
            "Links": {
                "PCIeDevice": [
                    {
                        "@odata.id": "/redfish/v1/Systems/1/PCIeDevices/NIC"
                    }
                ]
            }
        },
        {
            "PCIeType": "Gen4",
            "Lanes": 4,
            "SlotType": "FullLength",
            "Status": {
                "State": "Absent"
            },
            "Location": {
                "PartLocation": {
                    "ServiceLabel": "Slot 2",
                    "LocationOrdinalValue": 2,
                    "LocationType": "Slot",
                    "Orientation": "LeftToRight",
                    "Reference": "Rear"
                }
            }
        },
        {
            "PCIeType": "Gen3",
            "Lanes": 1,
            "SlotType": "HalfLength",
            "Status": {
                "State": "Absent"
            },
            "Location": {
                "PartLocation": {
                    "ServiceLabel": "Slot 3",
                    "LocationOrdinalValue": 3,
                    "LocationType": "Slot",
                    "Orientation": "LeftToRight",
                    "Reference": "Rear"
                }
            }
        }
    ],
    "Oem": {},
    "@odata.context": "/redfish/v1/$metadata#PCIeSlots.PCIeSlots",
    "@odata.id": "/redfish/v1/Chassis/1/PCIeSlots"
}

Port 1.1.2

v1.1v1.0
2017.32016.2

Port contains properties describing a port of a switch, controller, chassis, or any other device that could be connected to another entity.

URIs:

CurrentSpeedGbpsnumber
(Gbit/s)
read-only (null)The current speed of this port.
Links {objectContains references to other resources that are related to this resource.
      AssociatedEndpoints [ {arrayAn array of references to the endpoints that connect through this port.
            @odata.id
      } ]
stringread-onlyLink to a Endpoint resource. See the Links section and the Endpoint schema for details.
      ConnectedSwitches [ {arrayAn array of references to the switches that connect to the device through this port.
            @odata.id
      } ]
stringread-onlyLink to a Switch resource. See the Links section and the Switch schema for details.
      ConnectedSwitchPorts [ {arrayAn array of references to the ports that connect to the switch through this port.
            @odata.id
      } ]
stringread-onlyLink to another Port resource.
      Oem { }
}
objectSee the OEM object definition in the Common properties section.
Location (v1.1+) { }objectThe Location of the port.
See the Location object for details on this property.
MaxSpeedGbpsnumber
(Gbit/s)
read-only (null)The maximum speed of this port as currently configured.
PortIdstringread-only (null)This is the label of this port on the physical package for this port.
PortProtocolstring
(enum)
read-only (null)The protocol being sent over this port.
See PortProtocol in Property Details, below, for the possible values of this property.
PortTypestring
(enum)
read-only (null)This is the type of this port.
See PortType in Property Details, below, for the possible values of this property.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
Widthintegerread-only (null)The number of lanes, phys, or other physical transport links that this port contains.

Actions

Reset

This action is used to reset this port.

URIs:

The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.

{
      ResetType
}
string
(enum)
read-writeThe type of reset to be performed.
See ResetType in Property Details, below, for the possible values of this property.

Property Details

PortProtocol:

The protocol being sent over this port.

stringDescription
AHCIAdvanced Host Controller Interface.
FCFibre Channel.
FCoEFibre Channel over Ethernet.
FCPFibre Channel Protocol for SCSI.
FICONFIbre CONnection (FICON).
FTPFile Transfer Protocol.
HTTPHypertext Transport Protocol.
HTTPSSecure Hypertext Transport Protocol.
I2CInter-Integrated Circuit Bus.
iSCSIInternet SCSI.
iWARPInternet Wide Area Remote Direct Memory Access Protocol.
NFSv3Network File System version 3.
NFSv4Network File System version 4.
NVMeNon-Volatile Memory Express.
NVMeOverFabricsNVMe over Fabrics.
OEMOEM specific.
PCIePCI Express.
RoCERDMA over Converged Ethernet Protocol.
RoCEv2RDMA over Converged Ethernet Protocol Version 2.
SASSerial Attached SCSI.
SATASerial AT Attachment.
SFTPSecure File Transfer Protocol.
SMBServer Message Block (aka CIFS Common Internet File System).
UHCIUniversal Host Controller Interface.
USBUniversal Serial Bus.

PortType:

This is the type of this port.

stringDescription
BidirectionalPortThis port connects to any type of device.
DownstreamPortThis port connects to a target device.
InterswitchPortThis port connects to another switch.
ManagementPortThis port connects to a switch manager.
UnconfiguredPortThis port has not yet been configured.
UpstreamPortThis port connects to a host device.

ResetType:

The type of reset to be performed.

stringDescription
ForceOffTurn the unit off immediately (non-graceful shutdown).
ForceOnTurn the unit on immediately.
ForceRestartPerform an immediate (non-graceful) shutdown, followed by a restart.
GracefulRestartPerform a graceful shutdown followed by a restart of the system.
GracefulShutdownPerform a graceful shutdown and power off.
NmiGenerate a Diagnostic Interrupt (usually an NMI on x86 systems) to cease normal operations, perform diagnostic actions and typically halt the system.
OnTurn the unit on.
PowerCyclePerform a power cycle of the unit.
PushPowerButtonSimulate the pressing of the physical power button on this unit.

Example Response

{
    "@odata.type": "#Port.v1_1_1.Port",
    "Id": "1",
    "Name": "SAS Port 1",
    "Description": "SAS Port 1",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "PortId": "1",
    "PortProtocol": "SAS",
    "PortType": "BidirectionalPort",
    "CurrentSpeedGbps": 48,
    "Width": 4,
    "MaxSpeedGbps": 48,
    "Actions": {
        "Oem": {}
    },
    "Links": {
        "AssociatedEndpoints": [
            {
                "@odata.id": "/redfish/v1/Fabrics/SAS/Endpoints/Initiator1"
            }
        ]
    },
    "Oem": {},
    "@odata.context": "/redfish/v1/$metadata#Port.Port",
    "@odata.id": "/redfish/v1/Fabrics/SAS/Switches/Switch1/Ports/1"
}

Power 1.5.3

v1.5v1.4v1.3v1.2v1.1v1.0
2017.32017.22017.12016.22016.11.0

This is the schema definition for the Power Metrics. It represents the properties for Power Consumption and Power Limiting.

URIs:

PowerControl [ {arrayThis is the definition for power control function (power reading/limiting).
      @odata.idstringread-only requiredThe unique identifier for a resource.
      Actions (v1.3+) { }objectThe available actions for this resource.
      MemberIdstringread-only requiredThis is the identifier for the member within the collection.
      Namestringread-only (null)Power Control Function name.
      Oem { }objectSee the OEM object definition in the Common properties section.
      PhysicalContext (v1.4+)string
(enum)
read-onlyDescribes the area, device, or set of devices to which this power control applies.
See PhysicalContext in Property Details, below, for the possible values of this property.
      PowerAllocatedWattsnumber
(Watts)
read-only (null)The total amount of power that has been allocated (or budegeted)to chassis resources.
      PowerAvailableWattsnumber
(Watts)
read-only (null)The amount of power not already budgeted and therefore available for additional allocation. (powerCapacity - powerAllocated). This indicates how much reserve power capacity is left.
      PowerCapacityWattsnumber
(Watts)
read-only (null)The total amount of power available to the chassis for allocation. This may the power supply capacity, or power budget assigned to the chassis from an up-stream chassis.
      PowerConsumedWattsnumber
(Watts)
read-only (null)The actual power being consumed by the chassis.
      PowerLimit {objectPower limit status and configuration information for this chassis.
            CorrectionInMsinteger
(ms)
read-write (null)The time required for the limiting process to reduce power consumption to below the limit.
            LimitExceptionstring
(enum)
read-write (null)The action that is taken if the power cannot be maintained below the LimitInWatts.
See LimitException in Property Details, below, for the possible values of this property.
            LimitInWatts
      }
number
(Watts)
read-write (null)The Power limit in watts. Set to null to disable power capping.
      PowerMetrics {objectPower readings for this chassis.
            AverageConsumedWattsnumber
(Watts)
read-only (null)The average power level over the measurement window (the last IntervalInMin minutes).
            IntervalInMininteger
(min)
read-only (null)The time interval (or window) in which the PowerMetrics are measured over.
            MaxConsumedWattsnumber
(Watts)
read-only (null)The highest power consumption level that has occured over the measurement window (the last IntervalInMin minutes).
            MinConsumedWatts
      }
number
(Watts)
read-only (null)The lowest power consumption level over the measurement window (the last IntervalInMin minutes).
      PowerRequestedWattsnumber
(Watts)
read-only (null)The potential power that the chassis resources are requesting which may be higher than the current level being consumed since requested power includes budget that the chassis resource wants for future use.
      RelatedItem [ {arrayThe ID(s) of the resources associated with this Power Limit.
            @odata.id
      } ]
stringread-onlyThe unique identifier for a resource.
      Status { }
} ]
objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
PowerSupplies [ {arrayDetails of the power supplies associated with this system or device.
      @odata.idstringread-only requiredThe unique identifier for a resource.
      Actions (v1.3+) { }objectThe available actions for this resource.
      Assembly (v1.5+) {objectA reference to the Assembly resource associated with this power supply.
See the Assembly schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a Assembly resource. See the Links section and the Assembly schema for details.
      EfficiencyPercent (v1.5+)number
(%)
read-only (null)The measured efficiency of this Power Supply as a percentage.
      FirmwareVersionstringread-only (null)The firmware version for this Power Supply.
      HotPluggable (v1.5+)booleanread-only (null)Indicates if this device can be inserted or removed while the equipment is in operation.
      IndicatorLED (v1.2+)string
(enum)
read-write (null)The state of the indicator LED, used to identify the power supply.
See IndicatorLED in Property Details, below, for the possible values of this property.
      InputRanges (v1.1+) [ {arrayThis is the input ranges that the power supply can use.
            InputTypestring
(enum)
read-only (null)The Input type (AC or DC).
See InputType in Property Details, below, for the possible values of this property.
            MaximumFrequencyHznumber
(Hz)
read-only (null)The maximum line input frequency at which this power supply input range is effective.
            MaximumVoltagenumber
(Volts)
read-only (null)The maximum line input voltage at which this power supply input range is effective.
            MinimumFrequencyHznumber
(Hz)
read-only (null)The minimum line input frequency at which this power supply input range is effective.
            MinimumVoltagenumber
(Volts)
read-only (null)The minimum line input voltage at which this power supply input range is effective.
            Oem { }objectSee the OEM object definition in the Common properties section.
            OutputWattage
      } ]
number
(Watts)
read-only (null)The maximum capacity of this Power Supply when operating in this input range.
      LastPowerOutputWattsnumber
(Watts)
read-only (null)The average power output of this Power Supply.
      LineInputVoltagenumber
(Volts)
read-only (null)The line input voltage at which the Power Supply is operating.
      LineInputVoltageTypestring
(enum)
read-only (null)The line voltage type supported as an input to this Power Supply.
See LineInputVoltageType in Property Details, below, for the possible values of this property.
      Location (v1.5+) { }objectThe Location of the power supply.
See the Location object for details on this property.
      Manufacturer (v1.1+)stringread-only (null)This is the manufacturer of this power supply.
      MemberIdstringread-only requiredThis is the identifier for the member within the collection.
      Modelstringread-only (null)The model number for this Power Supply.
      Namestringread-only (null)The name of the Power Supply.
      Oem { }objectSee the OEM object definition in the Common properties section.
      PartNumberstringread-only (null)The part number for this Power Supply.
      PowerCapacityWattsnumber
(Watts)
read-only (null)The maximum capacity of this Power Supply.
      PowerInputWatts (v1.5+)number
(Watts)
read-only (null)The measured input power of this Power Supply.
      PowerOutputWatts (v1.5+)number
(Watts)
read-only (null)The measured output power of this Power Supply.
      PowerSupplyTypestring
(enum)
read-only (null)The Power Supply type (AC or DC).
See PowerSupplyType in Property Details, below, for the possible values of this property.
      Redundancy [ {arrayA reference to a set of Redundancy entities that provide redundant services for this resource. See the Redundancy object definition in the Common objects section.
            @odata.id
      } ]
stringread-onlyThe unique identifier for a resource.
      RelatedItem [ {arrayThe ID(s) of the resources associated with this Power Limit.
            @odata.id
      } ]
stringread-onlyThe unique identifier for a resource.
      SerialNumberstringread-only (null)The serial number for this Power Supply.
      SparePartNumberstringread-only (null)The spare part number for this Power Supply.
      Status { }
} ]
objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
Redundancy [ {arrayRedundancy information for the power subsystem of this system or device.
      @odata.id
} ]
stringread-onlyThe unique identifier for a resource.
Voltages [ {arrayThis is the definition for voltage sensors.
      @odata.idstringread-only requiredThe unique identifier for a resource.
      Actions (v1.3+) { }objectThe available actions for this resource.
      LowerThresholdCriticalnumber
(Volts)
read-only (null)Below normal range but not yet fatal.
      LowerThresholdFatalnumber
(Volts)
read-only (null)Below normal range and is fatal.
      LowerThresholdNonCriticalnumber
(Volts)
read-only (null)Below normal range.
      MaxReadingRangenumber
(Volts)
read-only (null)Maximum value for this Voltage sensor.
      MemberIdstringread-only requiredThis is the identifier for the member within the collection.
      MinReadingRangenumber
(Volts)
read-only (null)Minimum value for this Voltage sensor.
      Namestringread-only (null)Voltage sensor name.
      Oem { }objectSee the OEM object definition in the Common properties section.
      PhysicalContextstring
(enum)
read-onlyDescribes the area or device to which this voltage measurement applies.
See PhysicalContext in Property Details, below, for the possible values of this property.
      ReadingVoltsnumber
(Volts)
read-only (null)The present reading of the voltage sensor.
      RelatedItem [ {arrayDescribes the areas or devices to which this voltage measurement applies.
            @odata.id
      } ]
stringread-onlyThe unique identifier for a resource.
      SensorNumberintegerread-only (null)A numerical identifier to represent the voltage sensor.
      Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
      UpperThresholdCriticalnumber
(Volts)
read-only (null)Above normal range but not yet fatal.
      UpperThresholdFatalnumber
(Volts)
read-only (null)Above normal range and is fatal.
      UpperThresholdNonCritical
} ]
number
(Volts)
read-only (null)Above normal range.

Property Details

IndicatorLED:

The state of the indicator LED, used to identify the power supply.

stringDescription
BlinkingThe Indicator LED is blinking.
LitThe Indicator LED is lit.
OffThe Indicator LED is off.

InputType:

The Input type (AC or DC).

stringDescription
ACAlternating Current (AC) input range.
DCDirect Current (DC) input range.

LimitException:

The action that is taken if the power cannot be maintained below the LimitInWatts.

stringDescription
HardPowerOffTurn the power off immediately when the limit is exceeded.
LogEventOnlyLog an event when the limit is exceeded, but take no further action.
NoActionTake no action when the limit is exceeded.
OemTake an OEM-defined action.

LineInputVoltageType:

The line voltage type supported as an input to this Power Supply.

stringDescription
AC120VAC 120V nominal input.
AC240VAC 240V nominal input.
AC277VAC 277V nominal input.
ACandDCWideRangeWide range AC or DC input.
ACHighLine (deprecated v1.3)277V AC input. Deprecated v1.3+. This value has been Deprecated in favor of AC277V.
ACLowLine (deprecated v1.3)100-127V AC input. Deprecated v1.3+. This value has been Deprecated in favor of AC120V.
ACMidLine (deprecated v1.3)200-240V AC input. Deprecated v1.3+. This value has been Deprecated in favor of AC240V.
ACWideRangeWide range AC input.
DC240VDC 240V nominal input.
DC380VHigh Voltage DC input (380V).
DCNeg48V-48V DC input.
UnknownThe power supply line input voltage type cannot be determined.

PhysicalContext:

Describes the area or device to which this voltage measurement applies.

stringDescription
AcceleratorAn Accelerator.
ACInputAn AC Input.
ACMaintenanceBypassInputAn AC Maintenance Bypass Input.
ACOutputAn AC Output.
ACStaticBypassInputAn AC Static Bypass Input.
ACUtilityInputAn AC Utility Input.
ASICAn ASIC device, such as networking chip or a chipset component.
BackThe back of the chassis.
BackplaneA backplane within the chassis.
ChassisThe entire chassis.
ComputeBayWithin a compute bay.
CoolingSubsystemThe entire cooling (air and liquid) subsystem.
CPUA Processor (CPU).
CPUSubsystemThe entire Processor (CPU) subsystem.
DCBusA DC Bus.
ExhaustThe air exhaust point(s) or region of the chassis.
ExpansionBayWithin an expansion bay.
FanA fan.
FPGAA Field Programmable Gate Array (FPGA).
FrontThe front of the chassis.
GPUA Graphics Processor (GPU).
GPUSubsystemThe entire Graphics Processor (GPU) subsystem.
IntakeThe air intake point(s) or region of the chassis.
LiquidInletThe liquid inlet point of the chassis.
LiquidOutletThe liquid outlet point of the chassis.
LowerThe lower portion of the chassis.
MemoryA memory device.
MemorySubsystemThe entire Memory subsystem.
MotorA motor.
NetworkBayWithin a networking bay.
NetworkingDeviceA networking device.
PowerSubsystemThe entire power subsystem.
PowerSupplyA power supply.
PowerSupplyBayWithin a power supply bay.
RectifierA rectifier device.
RoomThe room.
StorageBayWithin a storage bay.
StorageDeviceA storage device.
SystemBoardThe system board (PCB).
TransformerA Transformer.
UpperThe upper portion of the chassis.
VoltageRegulatorA voltage regulator device.

PowerSupplyType:

The Power Supply type (AC or DC).

stringDescription
ACAlternating Current (AC) power supply.
ACorDCPower Supply supports both DC or AC.
DCDirect Current (DC) power supply.
UnknownThe power supply type cannot be determined.

Example Response

{
    "@odata.type": "#Power.v1_5_1.Power",
    "Id": "Power",
    "Name": "Power",
    "PowerControl": [
        {
            "@odata.id": "/redfish/v1/Chassis/1U/Power#/PowerControl/0",
            "MemberId": "0",
            "Name": "Server Power Control",
            "PowerConsumedWatts": 344,
            "PowerRequestedWatts": 800,
            "PowerAvailableWatts": 0,
            "PowerCapacityWatts": 800,
            "PowerAllocatedWatts": 800,
            "PowerMetrics": {
                "IntervalInMin": 30,
                "MinConsumedWatts": 271,
                "MaxConsumedWatts": 489,
                "AverageConsumedWatts": 319
            },
            "PowerLimit": {
                "LimitInWatts": 500,
                "LimitException": "LogEventOnly",
                "CorrectionInMs": 50
            },
            "RelatedItem": [
                {
                    "@odata.id": "/redfish/v1/Systems/437XR1138R2"
                },
                {
                    "@odata.id": "/redfish/v1/Chassis/1U"
                }
            ],
            "Status": {
                "State": "Enabled",
                "Health": "OK"
            },
            "Oem": {}
        }
    ],
    "Voltages": [
        {
            "@odata.id": "/redfish/v1/Chassis/1U/Power#/Voltages/0",
            "MemberId": "0",
            "Name": "VRM1 Voltage",
            "SensorNumber": 11,
            "Status": {
                "State": "Enabled",
                "Health": "OK"
            },
            "ReadingVolts": 12,
            "UpperThresholdNonCritical": 12.5,
            "UpperThresholdCritical": 13,
            "UpperThresholdFatal": 15,
            "LowerThresholdNonCritical": 11.5,
            "LowerThresholdCritical": 11,
            "LowerThresholdFatal": 10,
            "MinReadingRange": 0,
            "MaxReadingRange": 20,
            "PhysicalContext": "VoltageRegulator",
            "RelatedItem": [
                {
                    "@odata.id": "/redfish/v1/Systems/437XR1138R2"
                },
                {
                    "@odata.id": "/redfish/v1/Chassis/1U"
                }
            ]
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1U/Power#/Voltages/1",
            "MemberId": "1",
            "Name": "VRM2 Voltage",
            "SensorNumber": 12,
            "Status": {
                "State": "Enabled",
                "Health": "OK"
            },
            "ReadingVolts": 5,
            "UpperThresholdNonCritical": 5.5,
            "UpperThresholdCritical": 7,
            "LowerThresholdNonCritical": 4.75,
            "LowerThresholdCritical": 4.5,
            "MinReadingRange": 0,
            "MaxReadingRange": 20,
            "PhysicalContext": "VoltageRegulator",
            "RelatedItem": [
                {
                    "@odata.id": "/redfish/v1/Systems/437XR1138R2"
                },
                {
                    "@odata.id": "/redfish/v1/Chassis/1U"
                }
            ]
        }
    ],
    "PowerSupplies": [
        {
            "@odata.id": "/redfish/v1/Chassis/1U/Power#/PowerSupplies/0",
            "MemberId": "0",
            "Name": "Power Supply Bay",
            "Status": {
                "State": "Enabled",
                "Health": "Warning"
            },
            "Oem": {},
            "PowerSupplyType": "AC",
            "LineInputVoltageType": "ACWideRange",
            "LineInputVoltage": 120,
            "PowerCapacityWatts": 800,
            "LastPowerOutputWatts": 325,
            "Model": "499253-B21",
            "Manufacturer": "ManufacturerName",
            "FirmwareVersion": "1.00",
            "SerialNumber": "1Z0000001",
            "PartNumber": "0000001A3A",
            "SparePartNumber": "0000001A3A",
            "InputRanges": [
                {
                    "InputType": "AC",
                    "MinimumVoltage": 100,
                    "MaximumVoltage": 120,
                    "OutputWattage": 800
                },
                {
                    "InputType": "AC",
                    "MinimumVoltage": 200,
                    "MaximumVoltage": 240,
                    "OutputWattage": 1300
                }
            ],
            "RelatedItem": [
                {
                    "@odata.id": "/redfish/v1/Chassis/1U"
                }
            ]
        }
    ],
    "Oem": {},
    "@odata.context": "/redfish/v1/$metadata#Power.Power",
    "@odata.id": "/redfish/v1/Chassis/1U/Power"
}

PrivilegeRegistry 1.1.3

v1.1v1.0
2017.12016.3

This is the schema definition for Operation to Privilege mapping.

Mappings [ {arrayThis property describes the mappings between entities and the relevant privileges used to access them.
      Entitystringread-onlyIndicates entity name. e.g., Manager.
      OperationMap {objectList mapping between HTTP method and privilege required for entity.
            DELETE [ {arrayIndicates privilege required for HTTP DELETE operation.
                  Privilege [ ]
            } ]
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
            GET [ {arrayIndicates privilege required for HTTP GET operation.
                  Privilege [ ]
            } ]
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
            HEAD [ {arrayIndicates privilege required for HTTP HEAD operation.
                  Privilege [ ]
            } ]
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
            PATCH [ {arrayIndicates privilege required for HTTP PATCH operation.
                  Privilege [ ]
            } ]
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
            POST [ {arrayIndicates privilege required for HTTP POST operation.
                  Privilege [ ]
            } ]
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
            PUT [ {arrayIndicates privilege required for HTTP PUT operation.
                  Privilege [ ]
            } ]
      }
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
      PropertyOverrides [ {arrayIndicates privilege overrides of property or element within a entity.
            OperationMap {objectList mapping between HTTP operation and privilege needed to perform operation.
                  DELETE [ {arrayIndicates privilege required for HTTP DELETE operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
                  GET [ {arrayIndicates privilege required for HTTP GET operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
                  HEAD [ {arrayIndicates privilege required for HTTP HEAD operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
                  PATCH [ {arrayIndicates privilege required for HTTP PATCH operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
                  POST [ {arrayIndicates privilege required for HTTP POST operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
                  PUT [ {arrayIndicates privilege required for HTTP PUT operation.
                        Privilege [ ]
                  } ]
            }
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
            Targets [ ]
      } ]
array
(string, null)
read-onlyIndicates the URI or Entity.
      ResourceURIOverrides [ {arrayIndicates privilege overrides of Resource URI.
            OperationMap {objectList mapping between HTTP operation and privilege needed to perform operation.
                  DELETE [ {arrayIndicates privilege required for HTTP DELETE operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
                  GET [ {arrayIndicates privilege required for HTTP GET operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
                  HEAD [ {arrayIndicates privilege required for HTTP HEAD operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
                  PATCH [ {arrayIndicates privilege required for HTTP PATCH operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
                  POST [ {arrayIndicates privilege required for HTTP POST operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
                  PUT [ {arrayIndicates privilege required for HTTP PUT operation.
                        Privilege [ ]
                  } ]
            }
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
            Targets [ ]
      } ]
array
(string, null)
read-onlyIndicates the URI or Entity.
      SubordinateOverrides [ {arrayIndicates privilege overrides of subordinate resource.
            OperationMap {objectList mapping between HTTP operation and privilege needed to perform operation.
                  DELETE [ {arrayIndicates privilege required for HTTP DELETE operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
                  GET [ {arrayIndicates privilege required for HTTP GET operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
                  HEAD [ {arrayIndicates privilege required for HTTP HEAD operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
                  PATCH [ {arrayIndicates privilege required for HTTP PATCH operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
                  POST [ {arrayIndicates privilege required for HTTP POST operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
                  PUT [ {arrayIndicates privilege required for HTTP PUT operation.
                        Privilege [ ]
                  } ]
            }
array
(string)
read-onlyLists the privileges that are allowed to perform the given type of HTTP operation on the entity type.
            Targets [ ]
      } ]
} ]
array
(string, null)
read-onlyIndicates the URI or Entity.
OEMPrivilegesUsed [ ] array
(string)
read-onlyLists the set of OEM Priviliges used in building this mapping.
PrivilegesUsed [ ] array (string
(enum))
read-onlyLists the set of Redfish standard priviliges used in building this mapping.
See PrivilegesUsed in Property Details, below, for the possible values of this property.

Property Details

PrivilegesUsed:

Lists the set of Redfish standard priviliges used in building this mapping.

stringDescription
ConfigureComponentsAble to configure components managed by this service.
ConfigureManagerAble to configure Manager resources.
ConfigureSelfAble to change the password for the current user Account.
ConfigureUsersAble to configure Users and their Accounts.
LoginAble to log into the service and read resources.

Example Response

{
    "@odata.type": "#PrivilegeRegistry.v1_0_0.PrivilegeRegistry",
    "Id": "Contoso_1.0.1_PrivilegeRegistry",
    "Name": "Privilege Map",
    "PrivilegesUsed": [
        "Login",
        "ConfigureManager",
        "ConfigureUsers",
        "ConfigureComponents",
        "ConfigureSelf"
    ],
    "OEMPrivilegesUsed": [],
    "Mappings": [
        {
            "Entity": "Manager",
            "OperationMap": {
                "GET": [
                    {
                        "Privilege": [
                            "Login"
                        ]
                    }
                ],
                "HEAD": [
                    {
                        "Privilege": [
                            "Login"
                        ]
                    }
                ],
                "PATCH": [
                    {
                        "Privilege": [
                            "ConfigureManager"
                        ]
                    }
                ],
                "POST": [
                    {
                        "Privilege": [
                            "ConfigureManager"
                        ]
                    }
                ],
                "PUT": [
                    {
                        "Privilege": [
                            "ConfigureManager"
                        ]
                    }
                ],
                "DELETE": [
                    {
                        "Privilege": [
                            "ConfigureManager"
                        ]
                    }
                ]
            }
        }
    ]
}

Processor 1.5.0

v1.5v1.4v1.3v1.2v1.1v1.0
2019.12018.32018.12017.32017.11.0

This is the schema definition for the Processor resource. It represents the properties of a processor attached to a System.

URIs:

AccelerationFunctions (v1.4+) {objectA reference to the collection of Acceleration Functions associated with this Processor.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of AccelerationFunction. See the AccelerationFunction schema for details.
Assembly (v1.2+) {objectA reference to the Assembly resource associated with this processor.
See the Assembly schema for details on this property.
      @odata.id
}
stringread-onlyLink to a Assembly resource. See the Links section and the Assembly schema for details.
FPGA (v1.4+) {objectThe properties specific for Processors of type FPGA.
      ExternalInterfaces [ {arrayAn array of the FPGA external interfaces.
            Ethernet {objectDescribes the Ethernet related information about this FPGA interface.
                  MaxLanesintegerread-only (null)This is the number of lanes supported by this interface.
                  MaxSpeedMbpsinteger
(Mbit/s)
read-only (null)The maximum speed supported by this interface.
                  Oem { }
            }
objectSee the OEM object definition in the Common properties section.
            InterfaceTypestring
(enum)
read-only (null)The FPGA interface type.
See InterfaceType in Property Details, below, for the possible values of this property.
            PCIe {objectDescribes the PCI-e related information about this FPGA interface.
See the PCIeDevice schema for details on this property.
                  @odata.id
            }
      } ]
stringread-onlyLink to a PCIeInterface resource. See the Links section and the PCIeDevice schema for details.
      FirmwareIdstringread-onlyThe FPGA firmware identifier.
      FirmwareManufacturerstringread-onlyThe FPGA firmware manufacturer.
      FirmwareVersionstringread-onlyThe FPGA firmware version.
      FpgaTypestring
(enum)
read-onlyThe FPGA type.
See FpgaType in Property Details, below, for the possible values of this property.
      HostInterface {objectThe FPGA interface to the host.
            Ethernet {objectDescribes the Ethernet related information about this FPGA interface.
                  MaxLanesintegerread-only (null)This is the number of lanes supported by this interface.
                  MaxSpeedMbpsinteger
(Mbit/s)
read-only (null)The maximum speed supported by this interface.
                  Oem { }
            }
objectSee the OEM object definition in the Common properties section.
            InterfaceTypestring
(enum)
read-only (null)The FPGA interface type.
See InterfaceType in Property Details, below, for the possible values of this property.
            PCIe {objectDescribes the PCI-e related information about this FPGA interface.
See the PCIeDevice schema for details on this property.
                  @odata.id
            }
      }
stringread-onlyLink to a PCIeInterface resource. See the Links section and the PCIeDevice schema for details.
      Modelstringread-onlyThe FPGA model.
      Oem { }objectSee the OEM object definition in the Common properties section.
      PCIeVirtualFunctionsintegerread-writeThe number of the PCIe Virtual Functions.
      ProgrammableFromHostbooleanread-write (null)This flag indicates if the FPGA firmware can be reprogrammed from the host using system software.
      ReconfigurationSlots [ {arrayAn array of the FPGA reconfiguration slots. A reconfiguration slot is used by an FPGA to contain an acceleration function that can change as the FPGA is being provisioned.
            AccelerationFunction {objectA link to the Acceleration Function provided by the code programmed into a reconfiguration slot.
See the AccelerationFunction schema for details on this property.
                  @odata.id
            }
stringread-onlyLink to a AccelerationFunction resource. See the Links section and the AccelerationFunction schema for details.
            ProgrammableFromHostbooleanread-write (null)This flag indicates if the reconfiguration slot can be reprogrammed from the host using system software.
            SlotIdstringread-only (null)The FPGA reconfiguration slot identifier.
            UUID
      } ]
}
stringread-only (null)The universal unique identifier (UUID) for this reconfiguration slot.
InstructionSetstring
(enum)
read-only (null)The instruction set of the processor.
See InstructionSet in Property Details, below, for the possible values of this property.
Links (v1.1+) {objectContains references to other resources that are related to this resource.
      Chassis {objectA reference to the Chassis which contains this Processor.
See the Chassis schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a Chassis resource. See the Links section and the Chassis schema for details.
      ConnectedProcessors (v1.4+) [ {arrayAn array of references to the processors directly connected to this processor.
            @odata.id
      } ]
stringread-onlyLink to another Processor resource.
      Endpoints (v1.4+) [ {arrayAn array of references to the endpoints that connect to this processor.
            @odata.id
      } ]
stringread-onlyLink to a Endpoint resource. See the Links section and the Endpoint schema for details.
      Oem { }objectSee the OEM object definition in the Common properties section.
      PCIeDevice (v1.4+) {objectA reference to the PCIeDevice associated with this Processor.
See the PCIeDevice schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a PCIeDevice resource. See the Links section and the PCIeDevice schema for details.
      PCIeFunctions (v1.4+) [ {arrayAn array of references to the PCIeFunctions associated with this Processor.
            @odata.id
      } ]
}
stringread-onlyLink to a PCIeFunction resource. See the Links section and the PCIeFunction schema for details.
Location (v1.2+) { }objectThe Location of the processor.
See the Location object for details on this property.
Manufacturerstringread-only (null)The processor manufacturer.
MaxSpeedMHzinteger
(MHz)
read-only (null)The maximum clock speed of the processor.
MaxTDPWatts (v1.4+)integer
(Watts)
read-only (null)The maximum Thermal Design Power (TDP) in watts.
Metrics (v1.4+) {objectA reference to the Metrics associated with this Processor.
See the ProcessorMetrics schema for details on this property.
      @odata.id
}
stringread-onlyLink to a ProcessorMetrics resource. See the Links section and the ProcessorMetrics schema for details.
Modelstringread-only (null)The product model number of this device.
ProcessorArchitecturestring
(enum)
read-only (null)The architecture of the processor.
See ProcessorArchitecture in Property Details, below, for the possible values of this property.
ProcessorId {objectIdentification information for this processor.
      EffectiveFamilystringread-only (null)The effective Family for this processor.
      EffectiveModelstringread-only (null)The effective Model for this processor.
      IdentificationRegistersstringread-only (null)The contents of the Identification Registers (CPUID) for this processor.
      MicrocodeInfostringread-only (null)The Microcode Information for this processor.
      Stepstringread-only (null)The Step value for this processor.
      VendorId
}
stringread-only (null)The Vendor Identification for this processor.
ProcessorMemory (v1.4+) [ {arrayThe memory directly attached or integrated witin this Procesor.
      CapacityMiBinteger
(mebibytes)
read-only (null)The memory capacity in MiB.
      IntegratedMemorybooleanread-only (null)This indicates whether this memory is integrated within the Processor.
      MemoryTypestring
(enum)
read-only (null)The type of memory used by this processor.
See MemoryType in Property Details, below, for the possible values of this property.
      SpeedMHz
} ]
integerread-only (null)The operating speed of the memory in MHz.
ProcessorTypestring
(enum)
read-only (null)The type of processor.
See ProcessorType in Property Details, below, for the possible values of this property.
Socketstringread-only (null)The socket or location of the processor.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
SubProcessors (v1.3+) {objectA reference to the collection of Sub-Processors associated with this system, such as cores or threads that are part of a processor.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of Processor. See the Processor schema for details.
TDPWatts (v1.4+)integer
(Watts)
read-only (null)The nominal Thermal Design Power (TDP) in watts.
TotalCoresintegerread-only (null)The total number of cores contained in this processor.
TotalEnabledCores (v1.5+)integerread-only (null)The total number of enabled cores contained in this processor.
TotalThreadsintegerread-only (null)The total number of execution threads supported by this processor.
UUIDstringread-only (null)The universal unique identifier (UUID) for this processor.

Property Details

FpgaType:

The FPGA type.

stringDescription
DiscreteThe discrete FPGA device.
IntegratedThe FPGA device integrasted with other porcessor in the single chip.

InstructionSet:

The instruction set of the processor.

stringDescription
ARM-A32ARM 32-bit.
ARM-A64ARM 64-bit.
IA-64Intel IA-64.
MIPS32MIPS 32-bit.
MIPS64MIPS 64-bit.
OEMOEM-defined.
PowerISA (v1.4+)PowerISA-64 or PowerISA-32.
x86x86 32-bit.
x86-64x86 64-bit.

InterfaceType:

The FPGA interface type.

stringDescription
EthernetAn Ethernet interface.
OEMAn OEM defined interface.
PCIeA PCI Express interface.
QPIThe Intel QuickPath Interconnect.
UPIThe Intel UltraPath Interconnect.

MemoryType:

The type of memory used by this processor.

stringDescription
DDRDouble data rate synchronous dynamic random-access memory.
DDR2Double data rate type two synchronous dynamic random-access memory.
DDR3Double data rate type three synchronous dynamic random-access memory.
DDR4Double data rate type four synchronous dynamic random-access memory.
DDR5Double data rate type five synchronous dynamic random-access memory.
FlashFlash memory.
GDDRSynchronous graphics random-access memory.
GDDR2Double data rate type two synchronous graphics random-access memory.
GDDR3Double data rate type three synchronous graphics random-access memory.
GDDR4Double data rate type four synchronous graphics random-access memory.
GDDR5Double data rate type five synchronous graphics random-access memory.
GDDR5XDouble data rate type five synchronous graphics random-access memory.
GDDR6Double data rate type five synchronous graphics random-access memory.
HBM1High Bandwidth Memory.
HBM2The second generation of High Bandwidth Memory.
HBM3The third generation of High Bandwidth Memory.
L1CacheL1 cache.
L2CacheL2 cache.
L3CacheL3 cache.
L4CacheL4 cache.
L5CacheL5 cache.
L6CacheL6 cache.
L7CacheL7 cache.
OEMOEM-defined.
SDRAMSynchronous dynamic random-access memory.
SGRAMSynchronous graphics RAM.
SRAMStatic random-access memory.

ProcessorArchitecture:

The architecture of the processor.

stringDescription
ARMARM.
IA-64Intel Itanium.
MIPSMIPS.
OEMOEM-defined.
Power (v1.4+)Power.
x86x86 or x86-64.

ProcessorType:

The type of processor.

stringDescription
AcceleratorAn Accelerator.
Core (v1.3+)A Core in a Processor.
CPUA Central Processing Unit.
DSPA Digital Signal Processor.
FPGAA Field Programmable Gate Array.
GPUA Graphics Processing Unit.
OEMAn OEM-defined Processing Unit.
Thread (v1.3+)A Thread in a Processor.

Example Response

{
    "@odata.type": "#Processor.v1_3_1.Processor",
    "Id": "CPU1",
    "Name": "Processor",
    "Socket": "CPU 1",
    "ProcessorType": "CPU",
    "ProcessorArchitecture": "x86",
    "InstructionSet": "x86-64",
    "Manufacturer": "Intel(R) Corporation",
    "Model": "Multi-Core Intel(R) Xeon(R) processor 7xxx Series",
    "ProcessorId": {
        "VendorId": "GenuineIntel",
        "IdentificationRegisters": "0x34AC34DC8901274A",
        "EffectiveFamily": "0x42",
        "EffectiveModel": "0x61",
        "Step": "0x1",
        "MicrocodeInfo": "0x429943"
    },
    "MaxSpeedMHz": 3700,
    "TotalCores": 8,
    "TotalThreads": 16,
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "@odata.context": "/redfish/v1/$metadata#Processor.Processor",
    "@odata.id": "/redfish/v1/Systems/437XR1138R2/Processors/CPU1"
}

ProcessorMetrics 1.0.1

v1.0
2018.3

ProcessorMetrics contains usage and health statistics for a Processor (all Cores).

URIs:

AverageFrequencyMHznumber
(MHz)
read-only (null)The average frequency of the processor.
BandwidthPercentnumber
(%)
read-only (null)The CPU bandwidth as a percentage.
Cache [ {arrayThe processor cache metrics.
      CacheMissnumberread-only (null)The number of cache line misses in millions.
      CacheMissesPerInstructionnumberread-only (null)The number of cache misses per instruction.
      HitRationumberread-only (null)The cache line hit ratio.
      Levelstringread-only (null)The cache level.
      OccupancyBytesinteger
(bytes)
read-only (null)The total cache level occupancy in bytes.
      OccupancyPercent
} ]
number
(%)
read-only (null)The total cache occupancy percentage.
ConsumedPowerWattnumber
(Watts)
read-only (null)The power consumed by the processor.
CoreMetrics [ {arrayThe processor core metrics.
      CoreCache [ {arrayThe cache metrics of this core in the processor.
            CacheMissnumberread-only (null)The number of cache line misses in millions.
            CacheMissesPerInstructionnumberread-only (null)The number of cache misses per instruction.
            HitRationumberread-only (null)The cache line hit ratio.
            Levelstringread-only (null)The cache level.
            OccupancyBytesinteger
(bytes)
read-only (null)The total cache level occupancy in bytes.
            OccupancyPercent
      } ]
number
(%)
read-only (null)The total cache occupancy percentage.
      CoreIdstringread-only (null)The processor core identifier.
      CStateResidency [ {arrayThe C-state residency of this core in the processor.
            Levelstringread-only (null)The level of C-state, e.g. C0, C1, C2.
            ResidencyPercent
      } ]
number
(%)
read-only (null)The percentage of time that the processor or core has spent in this particular level of C-state.
      InstructionsPerCyclenumberread-only (null)The number of instructions per clock cycle of this core.
      IOStallCountnumberread-only (null)The number of stalled cycles due to I/O operations.
      MemoryStallCountnumberread-only (null)The number of stalled cycles due to memory operations.
      UnhaltedCycles
} ]
numberread-only (null)The unhalted cycles count of this core.
FrequencyRationumberread-only (null)The frequency relative to the nominal processor frequency ratio.
KernelPercentnumber
(%)
read-only (null)The percentage of time spent in kernel mode.
LocalMemoryBandwidthBytesinteger
(bytes)
read-only (null)The local memory bandwidth usage in bytes.
RemoteMemoryBandwidthBytesinteger
(bytes)
read-only (null)The remote memory bandwidth usage in bytes.
TemperatureCelsiusnumber
(Celsius)
read-only (null)The temperature of the processor.
ThrottlingCelsiusnumber
(Celsius)
read-only (null)The CPU margin to throttle (temperature offset in degree Celsius).
UserPercentnumber
(%)
read-only (null)The percentage of time spent in user mode.

Example Response

{
    "@odata.type": "#ProcessorMetrics.v1_0_0.ProcessorMetrics",
    "Id": "Metrics",
    "Name": "Processor Metrics",
    "BandwidthPercent": 62,
    "AverageFrequencyMHz": 2400,
    "ThrottlingCelsius": 65,
    "TemperatureCelsius": 41,
    "ConsumedPowerWatt": 82,
    "FrequencyRatio": 0.00432,
    "Cache": [
        {
            "Level": "3",
            "CacheMiss": 0.12,
            "HitRatio": 0.719,
            "CacheMissesPerInstruction": 0.00088,
            "OccupancyBytes": 3030144,
            "OccupancyPercent": 90.1
        }
    ],
    "LocalMemoryBandwidthBytes": 18253611008,
    "RemoteMemoryBandwidthBytes": 81788928,
    "KernelPercent": 2.3,
    "UserPercent": 34.7,
    "CoreMetrics": [
        {
            "CoreId": "core0",
            "InstructionsPerCycle": 1.16,
            "UnhaltedCycles": 6254383746,
            "MemoryStallCount": 58372,
            "IOStallCount": 2634872,
            "CoreCache": [
                {
                    "Level": "2",
                    "CacheMiss": 0.472,
                    "HitRatio": 0.57,
                    "CacheMissesPerInstruction": 0.00346,
                    "OccupancyBytes": 198231,
                    "OccupancyPercent": 77.4
                }
            ],
            "CStateResidency": [
                {
                    "Level": "C0",
                    "Residency": 1.13
                },
                {
                    "Level": "C1",
                    "Residency": 26
                },
                {
                    "Level": "C3",
                    "Residency": 0.00878
                },
                {
                    "Level": "C6",
                    "Residency": 0.361
                },
                {
                    "Level": "C7",
                    "Residency": 72.5
                }
            ]
        }
    ],
    "Oem": {},
    "@odata.id": "/redfish/v1/Systems/1/Processors/FPGA1/ProcessorMetrics"
}

ResourceBlock 1.3.1

v1.3v1.2v1.1v1.0
2018.32018.22018.12017.1

This schema defines a Resource Block resource.

URIs:

CompositionStatus {object requiredThis property describes the composition status details for this Resource Block.
      CompositionStatestring
(enum)
read-only required (null)This property represents the current state of the Resource Block from a composition perspective.
See CompositionState in Property Details, below, for the possible values of this property.
      MaxCompositions (v1.1+)integerread-only (null)The maximum number of compositions in which this Resource Block is capable of participating simultaneously.
      NumberOfCompositions (v1.1+)integerread-only (null)The number of compositions in which this Resource Block is currently participating.
      Reservedbooleanread-write (null)This represents if the Resource Block is reserved by any client.
      SharingCapable (v1.1+)booleanread-only (null)Indicates if this Resource Block is capable of participating in multiple compositions simultaneously.
      SharingEnabled (v1.1+)
}
booleanread-write (null)Indicates if this Resource Block is allowed to participate in multiple compositions simultaneously.
ComputerSystems [ {arrayAn array of references to the Computer Systems available in this Resource Block.
      @odata.id
} ]
stringread-onlyLink to a ComputerSystem resource. See the Links section and the ComputerSystem schema for details.
Drives (v1.3+) [ {arrayAn array of references to the Drives available in this Resource Block.
      @odata.id
} ]
stringread-onlyLink to a Drive resource. See the Links section and the Drive schema for details.
EthernetInterfaces [ {arrayAn array of references to the Ethernet Interfaces available in this Resource Block.
      @odata.id
} ]
stringread-onlyLink to a EthernetInterface resource. See the Links section and the EthernetInterface schema for details.
Links {objectContains references to other resources that are related to this resource.
      Chassis [ {arrayAn array of references to the Chassis in which this Resource Block is contained.
            @odata.id
      } ]
stringread-onlyLink to a Chassis resource. See the Links section and the Chassis schema for details.
      ComputerSystems [ {arrayAn array of references to the Computer Systems that are composed from this Resource Block.
            @odata.id
      } ]
stringread-onlyLink to a ComputerSystem resource. See the Links section and the ComputerSystem schema for details.
      Oem { }objectSee the OEM object definition in the Common properties section.
      Zones [ {arrayAn array of references to the Zones in which this Resource Block is bound.
            @odata.id
      } ]
}
stringread-onlyLink to a Zone resource. See the Links section and the Zone schema for details.
Memory [ {arrayAn array of references to the Memory available in this Resource Block.
      @odata.id
} ]
stringread-onlyLink to a Memory resource. See the Links section and the Memory schema for details.
NetworkInterfaces [ {arrayAn array of references to the Network Interfaces available in this Resource Block.
      @odata.id
} ]
stringread-onlyLink to a NetworkInterface resource. See the Links section and the NetworkInterface schema for details.
Processors [ {arrayAn array of references to the Processors available in this Resource Block.
      @odata.id
} ]
stringread-onlyLink to a Processor resource. See the Links section and the Processor schema for details.
ResourceBlockType [ ] array (string
(enum))
read-onlyThis property represents the types of resources available on this Resource Block.
See ResourceBlockType in Property Details, below, for the possible values of this property.
SimpleStorage [ {arrayAn array of references to the Simple Storage available in this Resource Block.
      @odata.id
} ]
stringread-onlyLink to a SimpleStorage resource. See the Links section and the SimpleStorage schema for details.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
Storage [ {arrayAn array of references to the Storage available in this Resource Block.
      @odata.id
} ]
stringread-onlyLink to a Storage resource. See the Links section and the Storage schema for details.

Property Details

CompositionState:

This property represents the current state of the Resource Block from a composition perspective.

stringDescription
ComposedFinal successful state of a Resource Block which has participated in composition.
ComposedAndAvailable (v1.1+)Indicates the Resource Block is currently participating in one or more compositions, and is available to be used in more compositions.
ComposingIntermediate state indicating composition is in progress.
FailedThe final composition resulted in failure and manual intervention may be required to fix it.
Unavailable (v1.2+)Indicates the Resource Block has been made unavailable by the service, such as due to maintenance being performed on the Resource Block.
UnusedIndicates the Resource Block is free and can participate in composition.

ResourceBlockType:

This property represents the types of resources available on this Resource Block.

stringDescription
ComputeThis Resource Block contains both Processor and Memory resources in a manner that creates a compute complex.
ComputerSystemThis Resource Block contains ComputerSystem resources.
Expansion (v1.2+)This Resource Block is capable of changing over time based on its configuration. Different types of devices within this Resource Block can be added and removed over time.
MemoryThis Resource Block contains Memory resources.
NetworkThis Resource Block contains Network resources, such as Ethernet Interfaces.
ProcessorThis Resource Block contains Processor resources.
StorageThis Resource Block contains Storage resources, such as Storage and Simple Storage.

Example Response

{
    "@odata.type": "#ResourceBlock.v1_2_0.ResourceBlock",
    "Id": "ComputeBlock1",
    "Name": "Compute Block 1",
    "ResourceBlockType": [
        "Compute"
    ],
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "CompositionStatus": {
        "Reserved": false,
        "CompositionState": "Composed",
        "SharingCapable": false,
        "MaxCompositions": 1,
        "NumberOfCompositions": 1
    },
    "Processors": [
        {
            "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ComputeBlock1/Processors/Block1CPU0"
        },
        {
            "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ComputeBlock1/Processors/Block1CPU1"
        }
    ],
    "Memory": [
        {
            "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ComputeBlock1/Memory/Block1DIMM0"
        },
        {
            "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ComputeBlock1/Memory/Block1DIMM1"
        },
        {
            "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ComputeBlock1/Memory/Block1DIMM2"
        },
        {
            "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ComputeBlock1/Memory/Block1DIMM3"
        }
    ],
    "Storage": [],
    "SimpleStorage": [],
    "EthernetInterfaces": [
        {
            "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ComputeBlock1/EthernetInterfaces/Block1OnboardNIC"
        }
    ],
    "ComputerSystems": [],
    "Links": {
        "ComputerSystems": [
            {
                "@odata.id": "/redfish/v1/Systems/ComposedSystem"
            }
        ],
        "Chassis": [
            {
                "@odata.id": "/redfish/v1/Chassis/ComposableModule1"
            }
        ],
        "Zones": [
            {
                "@odata.id": "/redfish/v1/CompositionService/ResourceZones/1"
            }
        ]
    },
    "Oem": {},
    "@odata.context": "/redfish/v1/$metadata#ResourceBlock.ResourceBlock",
    "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ComputeBlock1"
}

Role 1.2.3

v1.2v1.1v1.0
2017.22017.11.0

This resource defines a user role to be used in conjunction with a Manager Account.

URIs:

AssignedPrivileges [ ] array (string
(enum))
read-writeThe redfish privileges that this role includes.
See AssignedPrivileges in Property Details, below, for the possible values of this property.
IsPredefinedbooleanread-onlyThis property is used to indicate if the Role is one of the Redfish Predefined Roles vs a Custom role.
OemPrivileges [ ] array
(string)
read-writeThe OEM privileges that this role includes.
RoleId (v1.2+)stringread-only required on createThis property contains the name of the Role.

Property Details

AssignedPrivileges:

The redfish privileges that this role includes.

stringDescription
ConfigureComponentsAble to configure components managed by this service.
ConfigureManagerAble to configure Manager resources.
ConfigureSelfAble to change the password for the current user Account.
ConfigureUsersAble to configure Users and their Accounts.
LoginAble to log into the service and read resources.

Example Response

{
    "@odata.type": "#Role.v1_2_2.Role",
    "Id": "Administrator",
    "Name": "User Role",
    "Description": "Admin User Role",
    "IsPredefined": true,
    "AssignedPrivileges": [
        "Login",
        "ConfigureManager",
        "ConfigureUsers",
        "ConfigureSelf",
        "ConfigureComponents"
    ],
    "OemPrivileges": [
        "OemClearLog",
        "OemPowerControl"
    ],
    "@odata.context": "/redfish/v1/$metadata#Role.Role",
    "@odata.id": "/redfish/v1/AccountService/Roles/Administrator"
}

SecureBoot 1.0.5

v1.0
2016.1

This resource contains UEFI Secure Boot information. It represents properties for managing the UEFI Secure Boot functionality of a system.

URIs:

SecureBootCurrentBootstring
(enum)
read-only (null)Secure Boot state during the current boot cycle.
See SecureBootCurrentBoot in Property Details, below, for the possible values of this property.
SecureBootEnablebooleanread-write (null)Enable or disable UEFI Secure Boot (takes effect on next boot).
SecureBootModestring
(enum)
read-only (null)Current Secure Boot Mode.
See SecureBootMode in Property Details, below, for the possible values of this property.

Actions

ResetKeys

This action is used to reset the Secure Boot keys.

URIs:

The following table shows the parameters for the action which are included in the POST body to the URI shown in the "target" property of the Action.

{
      ResetKeysType
}
string
(enum)
read-writeThe type of keys to reset or delete.
See ResetKeysType in Property Details, below, for the possible values of this property.

Property Details

ResetKeysType:

The type of keys to reset or delete.

stringDescription
DeleteAllKeysDelete the content of all UEFI Secure Boot key databases (PK, KEK, DB, DBX). This puts the system in Setup Mode.
DeletePKDelete the content of the PK UEFI Secure Boot database. This puts the system in Setup Mode.
ResetAllKeysToDefaultReset the content of all UEFI Secure Boot key databases (PK, KEK, DB, DBX) to their default values.

SecureBootCurrentBoot:

Secure Boot state during the current boot cycle.

stringDescription
DisabledSecure Boot is currently disabled.
EnabledSecure Boot is currently enabled.

SecureBootMode:

Current Secure Boot Mode.

stringDescription
AuditModeSecure Boot is currently in Audit Mode.
DeployedModeSecure Boot is currently in Deployed Mode.
SetupModeSecure Boot is currently in Setup Mode.
UserModeSecure Boot is currently in User Mode.

Example Response

{
    "@odata.id": "/redfish/v1/Systems/1/SecureBoot",
    "@odata.type": "#SecureBoot.v1_0_0.SecureBoot",
    "Id": "SecureBoot",
    "Name": "UEFI Secure Boot",
    "Actions": {
        "#SecureBoot.ResetKeys": {
            "target": "/redfish/v1/Systems/1/SecureBoot/Actions/SecureBoot.ResetKeys",
            "ResetKeysType@Redfish.AllowableValues": [
                "ResetAllKeysToDefault",
                "DeleteAllKeys",
                "DeletePK"
            ]
        },
        "Oem": {}
    },
    "SecureBootEnable": false,
    "SecureBootCurrentBoot": "Disabled",
    "SecureBootMode": "UserMode",
    "Oem": {}
}

Sensor 1.0.1

v1.0
2018.3

This schema defines a Sensor to be used in conjunction with data center equipment.

URIs:

Accuracynumberread-only (null)Estimated percent error of measured vs. actual values.
AdjustedMaxAllowableOperatingValuenumberread-only (null)Adjusted maximum allowable operating value for this equipment based on the current environmental conditions present.
AdjustedMinAllowableOperatingValuenumberread-only (null)Adjusted minimum allowable operating value for this equipment based on the current environmental conditions present.
ApparentVAnumberread-only (null)The product of Voltage and Current for an AC circuit, in Volt-Amperes units.
ElectricalContextstring
(enum)
read-only (null)The combination of current-carrying conductors.
See ElectricalContext in Property Details, below, for the possible values of this property.
LoadPercentnumberread-only (null)The power load utilization for this Sensor.
Location { }objectThe location information for this Sensor.
See the Location object for details on this property.
MaxAllowableOperatingValuenumberread-only (null)Maximum allowable operating value for this equipment.
MinAllowableOperatingValuenumberread-only (null)Minimum allowable operating value for this equipment.
PeakReadingnumberread-only (null)The peak reading value for this sensor.
PeakReadingTimestringread-only (null)The time at which the Peak Reading value occurred.
PhysicalContextstring
(enum)
read-only (null)Describes the area or device to which this sensor measurement applies.
See PhysicalContext in Property Details, below, for the possible values of this property.
PhysicalSubContextstring
(enum)
read-only (null)Describes the usage or location within a device to which this sensor measurement applies.
See PhysicalSubContext in Property Details, below, for the possible values of this property.
PowerFactornumberread-only (null)The power factor for this Sensor.
Precisionnumberread-only (null)Number of significant digits in the Reading.
ReactiveVARnumberread-only (null)The square root of the difference term of squared ApparentVA and squared Power (Reading) for a circuit, expressed in VAR units.
Readingnumberread-only (null)The present value for this Sensor.
ReadingRangeMaxnumberread-only (null)The maximum value of Reading possible for this Sensor.
ReadingRangeMinnumberread-only (null)The minimum value of Reading possible for this Sensor.
ReadingTypestring
(enum)
read-only (null)The kind of sensor being represented.
See ReadingType in Property Details, below, for the possible values of this property.
ReadingUnitsstringread-only (null)Units in which the reading and thresholds are measured.
SensingFrequencynumberread-only (null)The time interval between readings of the physical sensor.
SensorResetTimestringread-only (null)The time at which the time-based properties were last reset.
Status { }objectThis property describes the status and health of the resource and its children.
See the Status object for details on this property.
Thresholds {objectThe set of thresholds defined for this sensor.
      LowerCaution {objectBelow normal range.
            Activationstring
(enum)
read-write (null)The direction of crossing that activates this threshold.
See Activation in Property Details, below, for the possible values of this property.
            DwellTimestringread-write (null)The time interval over which the sensor reading must have passed through this Threshold value before the threshold is considered to be violated.
            Reading
      }
numberread-write (null)The threshold value.
      LowerCritical {objectBelow normal range but not yet fatal.
            Activationstring
(enum)
read-write (null)The direction of crossing that activates this threshold.
See Activation in Property Details, below, for the possible values of this property.
            DwellTimestringread-write (null)The time interval over which the sensor reading must have passed through this Threshold value before the threshold is considered to be violated.
            Reading
      }
numberread-write (null)The threshold value.
      LowerFatal {objectBelow normal range and fatal.
            Activationstring
(enum)
read-write (null)The direction of crossing that activates this threshold.
See Activation in Property Details, below, for the possible values of this property.
            DwellTimestringread-write (null)The time interval over which the sensor reading must have passed through this Threshold value before the threshold is considered to be violated.
            Reading
      }
numberread-write (null)The threshold value.
      UpperCaution {objectAbove normal range.
            Activationstring
(enum)
read-write (null)The direction of crossing that activates this threshold.
See Activation in Property Details, below, for the possible values of this property.
            DwellTimestringread-write (null)The time interval over which the sensor reading must have passed through this Threshold value before the threshold is considered to be violated.
            Reading
      }
numberread-write (null)The threshold value.
      UpperCritical {objectAbove normal range but not yet fatal.
            Activationstring
(enum)
read-write (null)The direction of crossing that activates this threshold.
See Activation in Property Details, below, for the possible values of this property.
            DwellTimestringread-write (null)The time interval over which the sensor reading must have passed through this Threshold value before the threshold is considered to be violated.
            Reading
      }
numberread-write (null)The threshold value.
      UpperFatal {objectAbove normal range and fatal.
            Activationstring
(enum)
read-write (null)The direction of crossing that activates this threshold.
See Activation in Property Details, below, for the possible values of this property.
            DwellTimestringread-write (null)The time interval over which the sensor reading must have passed through this Threshold value before the threshold is considered to be violated.
            Reading
      }
}
numberread-write (null)The threshold value.
VoltageTypestring
(enum)
read-only (null)The voltage type (AC or DC) for this sensor.
See VoltageType in Property Details, below, for the possible values of this property.

Actions

ResetStatistics

This action is used to reset statistics related to this sensor.

URIs:

(This action takes no parameters.)

Property Details

Activation:

The direction of crossing that activates this threshold.

stringDescription
DecreasingValue decreases below the threshold.
EitherValue crosses the threshold in either direction.
IncreasingValue increases above the threshold.

ElectricalContext:

The combination of current-carrying conductors.

stringDescription
Line1The circuits sharing L1 current-carrying conductor.
Line1ToLine2The circuit formed by L1 and L2 current-carrying conductors when PhaseWiringType.TwoPhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire.
Line1ToNeutralThe circuit formed by L1 and Neutral current-carrying conductors when PhaseWiringType.OnePhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire.
Line1ToNeutralAndL1L2The circuits formed by L1, L2, and Neutral current-carrying conductors when PhaseWiringType.TwoPhase4Wire or ThreePhase5Wire.
Line2The circuits sharing L2 current-carrying conductor when PhaseWiringType.ThreePhase4Wire. TwoPhase4Wire, or ThreePhase5Wire.
Line2ToLine3The circuit formed by L2 and L3 current-carrying conductors when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire.
Line2ToNeutralThe circuit formed by L2 and Neutral current-carrying conductors when PhaseWiringType.TwoPhase4Wire or ThreePhase5Wire.
Line2ToNeutralAndL1L2The circuits formed by L1, L2, and Neutral current-carrying conductors when PhaseWiringType.TwoPhase4Wire or ThreePhase5Wire.
Line2ToNeutralAndL2L3The circuits formed by L2, L3, and Neutral current-carrying conductors when PhaseWiringType.ThreePhase5Wire.
Line3The circuits sharing L3 current-carrying conductor when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire.
Line3ToLine1The circuit formed by L3 and L1 current-carrying conductors when PhaseWiringType.ThreePhase4Wire or ThreePhase5Wire.
Line3ToNeutralThe circuit formed by L3 and Neutral current-carrying conductors when PhaseWiringType.ThreePhase5Wire.
Line3ToNeutralAndL3L1The circuits formed by L3, L1, and Neutral current-carrying conductors when PhaseWiringType.ThreePhase5Wire.
LineToLineThe circuit formed by two current-carrying conductors when PhaseWiringType.TwoPhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire.
LineToNeutralThe circuit formed by a line and Neutral current-carrying conductor when PhaseWiringType.OnePhase3Wire, TwoPhase4Wire, ThreePhase4Wire, or ThreePhase5Wire.
NeutralThe grounded current-carrying return circuit of current-carrying conductors when PhaseWiringType.OnePhase3Wire, TwoPhase4Wire, or ThreePhase5Wire.
TotalThe circuits formed by all current-carrying conductors for any PhaseWiringType.

PhysicalContext:

Describes the area or device to which this sensor measurement applies.

stringDescription
AcceleratorAn Accelerator.
ACInputAn AC Input.
ACMaintenanceBypassInputAn AC Maintenance Bypass Input.
ACOutputAn AC Output.
ACStaticBypassInputAn AC Static Bypass Input.
ACUtilityInputAn AC Utility Input.
ASICAn ASIC device, such as networking chip or a chipset component.
BackThe back of the chassis.
BackplaneA backplane within the chassis.
ChassisThe entire chassis.
ComputeBayWithin a compute bay.
CoolingSubsystemThe entire cooling (air and liquid) subsystem.
CPUA Processor (CPU).
CPUSubsystemThe entire Processor (CPU) subsystem.
DCBusA DC Bus.
ExhaustThe air exhaust point(s) or region of the chassis.
ExpansionBayWithin an expansion bay.
FanA fan.
FPGAA Field Programmable Gate Array (FPGA).
FrontThe front of the chassis.
GPUA Graphics Processor (GPU).
GPUSubsystemThe entire Graphics Processor (GPU) subsystem.
IntakeThe air intake point(s) or region of the chassis.
LiquidInletThe liquid inlet point of the chassis.
LiquidOutletThe liquid outlet point of the chassis.
LowerThe lower portion of the chassis.
MemoryA memory device.
MemorySubsystemThe entire Memory subsystem.
MotorA motor.
NetworkBayWithin a networking bay.
NetworkingDeviceA networking device.
PowerSubsystemThe entire power subsystem.
PowerSupplyA power supply.
PowerSupplyBayWithin a power supply bay.
RectifierA rectifier device.
RoomThe room.
StorageBayWithin a storage bay.
StorageDeviceA storage device.
SystemBoardThe system board (PCB).
TransformerA Transformer.
UpperThe upper portion of the chassis.
VoltageRegulatorA voltage regulator device.

PhysicalSubContext:

Describes the usage or location within a device to which this sensor measurement applies.

stringDescription
InputThe input.
OutputThe output.

ReadingType:

The kind of sensor being represented.

stringDescription
AirFlowAirflow.
AltitudeAltitude.
BarometricBarometric Pressure.
CurrentCurrent.
EnergyJoulesEnergy consumption (Joules).
EnergykWhEnergy consumption (kW/h).
FrequencyFrequency.
HumidityRelative Humidity.
LiquidFlowLiquid flow.
LiquidLevelLiquid level.
PowerPower.
PressurePressure.
RotationalRotational.
TemperatureTemperature.
VoltageVoltage (AC or DC).

VoltageType:

The voltage type (AC or DC) for this sensor.

stringDescription
ACAlternating Current.
DCDirect Current.

Example Response

{
    "@odata.type": "#Sensor.v1_0_0.Sensor",
    "Id": "CabinetTemp",
    "Name": "Rack Temperature",
    "ReadingType": "Temperature",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "Reading": 31,
    "ReadingUnits": "C",
    "ReadingRangeMin": 0,
    "ReadingRangeMax": 70,
    "Accuracy": 0.25,
    "Precision": 1,
    "SensingFrequency": 3,
    "PhysicalContext": "Chassis",
    "Thresholds": {
        "UpperCritical": {
            "Reading": 40,
            "Activation": "Increasing"
        },
        "UpperCaution": {
            "Reading": 35,
            "Activation": "Increasing"
        },
        "LowerCaution": {
            "Reading": 10,
            "Activation": "Increasing"
        }
    },
    "Oem": {},
    "@odata.id": "/redfish/v1/Chassis/1/Sensors/CabinetTemp"
}

SerialInterface 1.1.4

v1.1v1.0
2017.11.0

This schema defines an asynchronous serial interface resource.

URIs:

BitRatestring
(enum)
read-writeThe receive and transmit rate of data flow, typically in bits-per-second (bps), over the serial connection.
See BitRate in Property Details, below, for the possible values of this property.
ConnectorTypestring
(enum)
read-onlyThe type of connector used for this interface.
See ConnectorType in Property Details, below, for the possible values of this property.
DataBitsstring
(enum)
read-writeThe number of data bits that will follow the start bit over the serial connection.
See DataBits in Property Details, below, for the possible values of this property.
FlowControlstring
(enum)
read-writeThe type of flow control, if any, that will be imposed on the serial connection.
See FlowControl in Property Details, below, for the possible values of this property.
InterfaceEnabledbooleanread-write (null)This indicates whether this interface is enabled.
Paritystring
(enum)
read-writeThe type of parity used by the sender and receiver in order to detect errors over the serial connection.
See Parity in Property Details, below, for the possible values of this property.
PinOutstring
(enum)
read-only (null)The physical pin configuration needed for a serial connector.
See PinOut in Property Details, below, for the possible values of this property.
SignalTypestring
(enum)
read-onlyThe type of signal used for the communication connection - RS232 or RS485.
See SignalType in Property Details, below, for the possible values of this property.
StopBitsstring
(enum)
read-writeThe period of time before the next start bit is transmitted.
See StopBits in Property Details, below, for the possible values of this property.

Property Details

BitRate:

The receive and transmit rate of data flow, typically in bits-per-second (bps), over the serial connection.

stringDescription
115200A bit rate of 115200bps.
1200A bit rate of 1200bps.
19200A bit rate of 19200bps.
230400A bit rate of 230400bps.
2400A bit rate of 2400bps.
38400A bit rate of 38400bps.
4800A bit rate of 4800bps.
57600A bit rate of 57600bps.
9600A bit rate of 9600bps.

ConnectorType:

The type of connector used for this interface.

stringDescription
DB25 FemaleA DB25 Female connector.
DB25 MaleA DB25 Male connector.
DB9 FemaleA DB9 Female connector.
DB9 MaleA DB9 Male connector.
mUSBA mUSB connector.
RJ11An RJ11 connector.
RJ45An RJ45 connector.
USBA USB connector.
uUSBA uUSB connector.

DataBits:

The number of data bits that will follow the start bit over the serial connection.

stringDescription
55 bits of data following the start bit.
66 bits of data following the start bit.
77 bits of data following the start bit.
88 bits of data following the start bit.

FlowControl:

The type of flow control, if any, that will be imposed on the serial connection.

stringDescription
HardwareOut of band flow control imposed.
NoneNo flow control imposed.
SoftwareXON/XOFF in-band flow control imposed.

Parity:

The type of parity used by the sender and receiver in order to detect errors over the serial connection.

stringDescription
EvenAn even parity bit.
MarkA mark parity bit.
NoneNo parity bit.
OddAn odd parity bit.
SpaceA space parity bit.

PinOut:

The physical pin configuration needed for a serial connector.

stringDescription
CiscoThe Cisco pin configuration.
CycladesThe Cyclades pin configuration.
DigiThe Digi pin configuration.

SignalType:

The type of signal used for the communication connection - RS232 or RS485.

stringDescription
Rs232The serial interface follows RS232.
Rs485The serial interface follows RS485.

StopBits:

The period of time before the next start bit is transmitted.

stringDescription
11 stop bit following the data bits.
22 stop bits following the data bits.

Example Response

{
    "@odata.type": "#SerialInterface.v1_1_3.SerialInterface",
    "Id": "TTY0",
    "Name": "Manager Serial Interface 1",
    "Description": "Management for Serial Interface",
    "InterfaceEnabled": true,
    "SignalType": "Rs232",
    "BitRate": "115200",
    "Parity": "None",
    "DataBits": "8",
    "StopBits": "1",
    "FlowControl": "None",
    "ConnectorType": "RJ45",
    "PinOut": "Cyclades",
    "@odata.context": "/redfish/v1/$metadata#SerialInterface.SerialInterface",
    "@odata.id": "/redfish/v1/Managers/BMC/SerialInterfaces/TTY0"
}

ServiceRoot 1.5.1

v1.5v1.4v1.3v1.2v1.1v1.0
2018.32018.22017.32017.12016.21.0

This object represents the root Redfish service.

URIs:

AccountService {objectThis is a link to the Account Service.
See the AccountService schema for details on this property.
      @odata.id
}
stringread-onlyLink to a AccountService resource. See the Links section and the AccountService schema for details.
CertificateService (v1.5+) {objectThis is a link to the CertificateService.
See the CertificateService schema for details on this property.
      @odata.id
}
stringread-onlyLink to a CertificateService resource. See the Links section and the CertificateService schema for details.
Chassis {objectThis is a link to a collection of Chassis.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of Chassis. See the Chassis schema for details.
CompositionService (v1.2+) {objectThis is a link to the CompositionService.
See the CompositionService schema for details on this property.
      @odata.id
}
stringread-onlyLink to a CompositionService resource. See the Links section and the CompositionService schema for details.
EventService {objectThis is a link to the EventService.
See the EventService schema for details on this property.
      @odata.id
}
stringread-onlyLink to a EventService resource. See the Links section and the EventService schema for details.
Fabrics (v1.1+) {objectA link to a collection of all fabric entities.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of Fabric. See the Fabric schema for details.
JobService (v1.4+) {objectThis is a link to the JobService.
See the JobService schema for details on this property.
      @odata.id
}
stringread-onlyLink to a JobService resource. See the Links section and the JobService schema for details.
JsonSchemas {objectThis is a link to a collection of Json-Schema files.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of JsonSchemaFile. See the JsonSchemaFile schema for details.
Links {object requiredContains references to other resources that are related to this resource.
      Oem { }objectSee the OEM object definition in the Common properties section.
      Sessions {object requiredLink to a collection of Sessions.
Contains a link to a resource.
            @odata.id
      }
}
stringread-onlyLink to Collection of Session. See the Session schema for details.
Managers {objectThis is a link to a collection of Managers.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of Manager. See the Manager schema for details.
Product (v1.3+)stringread-only (null)The product associated with this Redfish service.
ProtocolFeaturesSupported (v1.3+) {objectContains information about protocol features supported by the service.
      ExcerptQuery (v1.4+)booleanread-onlyThis indicates whether the 'excerpt' query parameter is supported.
      ExpandQuery {objectContains information about the use of $expand in the service.
            ExpandAllbooleanread-onlyThis indicates whether the $expand support of asterisk (expand all entries) is supported.
            Levelsbooleanread-onlyThis indicates whether the expand support of the $levels qualifier is supported by the service.
            Linksbooleanread-onlyThis indicates whether the $expand support of tilde (expand only entries in the Links section) is supported.
            MaxLevelsintegerread-onlyThis indicates the maximum number value of the $levels qualifier in $expand operations.
            NoLinks
      }
booleanread-onlyThis indicates whether the $expand support of period (expand only entries not in the Links section) is supported.
      FilterQuerybooleanread-onlyThis indicates whether the $filter query parameter is supported.
      OnlyMemberQuery (v1.4+)booleanread-onlyThis indicates whether the 'only' query parameter is supported.
      SelectQuery
}
booleanread-onlyThis indicates whether the $select query parameter is supported.
RedfishVersionstringread-onlyThe version of the Redfish service.
Registries {objectThis is a link to a collection of Registries.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of MessageRegistryFile. See the MessageRegistryFile schema for details.
ResourceBlocks (v1.5+) {objectA link to a collection of all resource block entities. This collection is intended for implementations that do not contain a Composition Service, but will expose resources to an orchestrator that implements a Composition Service.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of ResourceBlock. See the ResourceBlock schema for details.
SessionService {objectThis is a link to the Sessions Service.
See the SessionService schema for details on this property.
      @odata.id
}
stringread-onlyLink to a SessionService resource. See the Links section and the SessionService schema for details.
StorageServices {objectA link to a collection of all storage service entities.
      @odata.id
}
stringread-onlyThe unique identifier for a resource.
StorageSystems {objectThis is a link to a collection of storage systems.
      @odata.id
}
stringread-onlyThe unique identifier for a resource.
Systems {objectThis is a link to a collection of Systems.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of ComputerSystem. See the ComputerSystem schema for details.
Tasks {objectThis is a link to the Task Service.
See the TaskService schema for details on this property.
      @odata.id
}
stringread-onlyLink to a TaskService resource. See the Links section and the TaskService schema for details.
TelemetryService (v1.4+)