DMTF Redfish

Document Identifier: DSP2046

Date: 2019-09-13

Version: 2019.2




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 that 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 these 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?

These 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 case-sensitive name of the JSON property as it appears in the JSON payload. For properties added to the schema after the initial v1.0.0 release, the property version appears in parentheses. Deprecated properties are noted with the deprecated property version in parentheses.
Type The JSON data type for the property. The value is boolean, number, string, or object. String types that use defined enumerations state (enum). Number types state their units, where used.
Attributes If the implementation supports it, indicates whether the property is read-only or read-write, and whether the Service may return a null value if the property value 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 OpenAPI Specification v3.0 support. 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 by using a fixed path structure, with appropriate path segments equal to the value of Id properties of members along the path.

To determine support for v1.6.0 and OpenAPI, compare the RedfishVersion property value in the Service root (\redfish\v1\). Services that report a 1.6.0 or greater value, such as 1.6.1 or 1.7.0, adhere to the URI definitions shown.

The URI listings do not apply to Redfish Services that report support of versions earlier than Specification v1.6.0. For those Services, clients must use the API's hypermedia features to discover links from the Service root to each Resource. While Services typically match the URIs listed in this documents for many of their Resources, this is not guaranteed and results 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 in this guide to avoid repetition in the Reference Guide property tables. Note that several of these properties are payload annotations, but appear in this guide because they are required for all Redfish Resources.

@odata.contextstringread-onlyThe URL to a metadata document with a fragment that describes the data, which is typically rooted at the top-level singleton or collection. Technically, the metadata document has to only define, or reference, any of the types that it directly uses, and different payloads could reference different metadata documents. However, because this property provides a root URL for resolving a relative reference, such as @odata.id, the API returns the canonical metadata document.
@odata.etagstringread-onlyThe current ETag for the Resource.
@odata.idstringread-only requiredThe unique ID for the Resource.
@odata.typestringread-only requiredThe type of a resource.
Descriptionstringread-onlyThe human-readable description for the Resource.
Idstringread-onlyThe ID that uniquely identifies the Resource within the collection that contains it. This value is unique within a collection.
Namestringread-only requiredThe human-readable moniker for a Resource. The type is string. The value is NOT necessarily unique across Resource instances within a collection.
Oem { }objectThe manufacturer- or provider-specific extension moniker that divides 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 { }objectThe Redfish actions available for this Resource.
Links { }objectThe 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. Find all directly referenced, or subordinate, Resource properties from the root of the Resource.
RelatedItem [ {arrayAn array of links. Each link points to a Resource or part of a Resource as defined by that Resource's schema. This representation is not intended to be a strong linking methodology like other references. Instead, it shows a relationship between elements or subelements in disparate parts of the service. For example, fans may be in one area of the system and processors in another. The relationship between the two might not be obvious. This property can show that one is related to the other. In this example, it might indicate that a specific fan cools a specific processor.
      @odata.id
} ]
stringread-onlyThe unique identifier for a resource.

Payload annotations

Payload annotations enable a Service to provide additional information about a 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:

Property@Schema.Term


where

Variable Description
Property The JSON property being annotated.
Schema The schema file that contains the definition for the annotation.
Term The name of the annotation.
@Message.ExtendedInfo { }objectThe additional information for a set of message structures for a property. These messages 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-onlyThe string values that a service accepts for a property or action parameter.

In this example, the ResetType property is annotated with the AllowableValues term, which the Redfish schema defines. Redfish is an alias for RedfishExtensions. This code indicates to the client that the Service supports the On and ForceOff values 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 @Schema.Term form, 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 URI to an ActionInfo Resource, which describes the parameters that this Action instance supports.
@Redfish.CollectionCapabilities { }objectThe reference to the Resource that represents the POST capabilities of a collection.
For property details, see CollectionCapabilities.
@Redfish.MaintenanceWindow { }objectThe maintenance window configuration that defines when to apply settings or operations to a Resource.
For property details, see MaintenanceWindow.
@Redfish.OperationApplyTimestring
(enum)
read-writeThe client's requested apply time to complete a create, delete, or action operation.
For the possible property values, see @Redfish.OperationApplyTime in Property Details.
@Redfish.OperationApplyTimeSupport { }objectAn indication of whether a client can request a specific apply time for a create, delete, or action operation for a Resource through the OperationApplyTime term.
For property details, see OperationApplyTimeSupport.
@Redfish.Settings { }objectThe reference to the Resource that represents the settings to apply to this object.
For property details, see Settings.
@Redfish.SettingsApplyTime { }objectThe configuration settings that define when to apply the settings to a Resource.
For property details, see PreferredApplyTime.

Property Details

@Redfish.OperationApplyTime:

The client's requested apply time to complete a create, delete, or action operation.

stringDescription
AtMaintenanceWindowStartThe requested operation is applied within the administrator-specified maintenance window.
ImmediateThe requested operation is applied immediately.
InMaintenanceWindowOnResetThe requested operation is applied after a reset but within the administrator-specified maintenance window.
OnResetThe requested operation is applied on a reset.

This example annotates the object with the Redfish schema-defined ActionInfo term. Redfish is an alias for RedfishExtensions. This term indicates that the client can find more information about the #ComputerSystem.Reset action at the /redfish/v1/Systems/1/ResetActionInfo URI:

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

Common objects

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

Actions

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

#{action name} {objectA single Redfish action.
      @Redfish.ActionInfostringread-onlyThe URI for an ActionInfo Resource that describes this action.
      target
}
stringread-onlyThe target URI for the POST operation to invoke the action.

Identifier

Any additional identifiers for a Resource.

DurableName (v1.1+)stringread-only (null)The world-wide, persistent name of the Resource.
DurableNameFormat (v1.1+)string
(enum)
read-only (null)The format of the durable name property.
For the possible property values, see DurableNameFormat in Property Details.

Property Details

DurableNameFormat:

The format of the durable name property.

stringDescription
EUIThe IEEE-defined 64-bit Extended Unique Identifier (EUI).
FC_WWNThe Fibre Channel (FC) World Wide Name (WWN).
iQNThe iSCSI Qualified Name (iQN).
NAAThe Name Address Authority (NAA) format.
NQN (v1.6+)The NVMe Qualified Name (NQN).
NSID (v1.6+)The NVM Namespace Identifier (NSID).
UUIDThe Universally Unique Identifier (UUID).

IPv4Address

This type describes an IPv4 address.

Addressstringread-write (null)The IPv4 address.
AddressOriginstring
(enum)
read-only (null)This indicates how the address was determined.
For the possible property values, see AddressOrigin in Property Details.
Gatewaystringread-write (null)The IPv4 gateway for this address.
Oem { }objectSee the Oem object definition in the Common properties section.
SubnetMaskstringread-write (null)The IPv4 subnet mask.

Property Details

AddressOrigin:

This indicates how the address was determined.

stringDescription
BOOTPA BOOTP service-provided address.
DHCPA DHCPv4 service-provided address.
IPv4LinkLocalThe address is valid for only this network segment, or link.
StaticA user-configured static address.

IPv6Address

This type describes an IPv6 address.

Addressstringread-write (null)The IPv6 address.
AddressOriginstring
(enum)
read-only (null)This indicates how the address was determined.
For the possible property values, see AddressOrigin in Property Details.
AddressStatestring
(enum)
read-only (null)The current RFC4862-defined state of this address.
For the possible property values, see AddressState in Property Details.
Oem { }objectSee the Oem object definition in the Common properties section.
PrefixLengthintegerread-only (null)The IPv6 address prefix Length.

Property Details

AddressOrigin:

This indicates how the address was determined.

stringDescription
DHCPv6A DHCPv6 service-provided address.
LinkLocalThe address is valid for only this network segment, or link.
SLAACA stateless autoconfiguration (SLAAC) service-provided address.
StaticA static user-configured address.

AddressState:

The current RFC4862-defined state of this address.

stringDescription
DeprecatedThis address is currently within its valid lifetime but is now outside its RFC4862-defined preferred lifetime.
FailedThis address has failed Duplicate Address Detection (DAD) testing, as defined in RFC4862, section 5.4, and is not currently in use.
PreferredThis address is currently within both its RFC4862-defined valid and preferred lifetimes.
TentativeThis address is currently undergoing Duplicate Address Detection (DAD) testing, as defined in RFC4862, section 5.4.

IPv6GatewayStaticAddress

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

Address (v1.1+)stringread-write required (null)A valid IPv6 address.
Oem (v1.1+) { }objectSee the Oem object definition in the Common properties section.
PrefixLength (v1.1+)integerread-write (null)The IPv6 network prefix length, in bits, for this address.

IPv6StaticAddress

This type 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, in bits, of this IPv6 address.

Location

The location of a Resource.

AltitudeMeters (v1.6+)number
(meters)
read-write (null)The altitude of the Resource in meters.
Contacts (v1.7+) [ {arrayAn array 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)The location of the Resource. Deprecated in v1.5 and later. This property has been deprecated in favor of the PostalAddress, Placement, and PartLocation properties.
InfoFormat (v1.1+, deprecated v1.5)stringread-only (null)The format of the Info property. Deprecated in v1.5 and later. This property has been deprecated in favor of the PostalAddress, Placement, and PartLocation properties.
Latitude (v1.6+)number
(deg)
read-write (null)The latitude of the Resource.
Longitude (v1.6+)number
(deg)
read-write (null)The longitude of the 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, the LocationOrdinalValue is 2.
      LocationTypestring
(enum)
read-only (null)The type of location of the part, such as slot, bay, socket and slot.
For the possible property values, see LocationType in Property Details.
      Orientationstring
(enum)
read-only (null)The orientation for the ordering of the slot enumeration used by the LocationOrdinalValue property.
For the possible property values, see Orientation in Property Details.
      Referencestring
(enum)
read-only (null)The reference point for the part location. Provides guidance about the general location of the part.
For the possible property values, see Reference in Property Details.
      ServiceLabel
}
stringread-only (null)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)The name of a rack location within a row.
      RackOffsetintegerread-write (null)The vertical location of the item, in terms of RackOffsetUnits.
      RackOffsetUnitsstring
(enum)
read-write (null)The type of rack units in use.
For the possible property values, see RackOffsetUnits in Property Details.
      Row
}
stringread-write (null)The name of the row.
PostalAddress (v1.3+) {objectThe postal address of the addressed Resource.
      AdditionalCodestringread-write (null)The additional code.
      AdditionalInfo (v1.7+)stringread-write (null)The room designation or other additional information.
      Buildingstringread-write (null)The name of the building.
      Citystringread-write (null)City, township, or shi (JP).
      Communitystringread-write (null)The postal community name.
      Countrystringread-write (null)The country.
      Districtstringread-write (null)A county, parish, gun (JP), or district (IN).
      Divisionstringread-write (null)City division, borough, dity district, ward, or chou (JP).
      Floorstringread-write (null)The floor.
      GPSCoords (deprecated v1.6)stringread-write (null)The GPS coordinates of the part. Deprecated in v1.6 and later. This property has been deprecated in favor of the Longitude and Latitude properties.
      HouseNumberintegerread-write (null)The numeric portion of house number.
      HouseNumberSuffixstringread-write (null)The house number suffix.
      Landmarkstringread-write (null)The landmark.
      LeadingStreetDirectionstringread-write (null)A leading street direction.
      Location (deprecated v1.7)stringread-write (null)The room designation or other additional information. Deprecated in v1.7 and later. This property has been deprecated in favor of the AdditionalInfo property.
      Namestringread-write (null)The name.
      Neighborhoodstringread-write (null)Neighborhood or block.
      PlaceTypestringread-write (null)The description of the type of place that is addressed.
      POBoxstringread-write (null)The post office box (PO box).
      PostalCodestringread-write (null)The postal code or zip code.
      Roadstringread-write (null)The primary road or street.
      RoadBranchstringread-write (null)The road branch.
      RoadPostModifierstringread-write (null)The road post-modifier.
      RoadPreModifierstringread-write (null)The road pre-modifier.
      RoadSectionstringread-write (null)The road section.
      RoadSubBranchstringread-write (null)The road sub branch.
      Roomstringread-write (null)The name or number of the room.
      Seatstringread-write (null)The seat, such as the desk, cubicle, or 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)The name or number of the apartment unit or suite.

Property Details

LocationType:

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

stringDescription
BayThe bay as the type of location.
ConnectorThe connector as the type of location.
SlotThe slot as the type of location.
SocketThe socket as the type of location.

Orientation:

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

stringDescription
BackToFrontThe ordering for the LocationOrdinalValue is back to front.
BottomToTopThe ordering for LocationOrdinalValue is bottom to top.
FrontToBackThe ordering for LocationOrdinalValue is front to back.
LeftToRightThe ordering for the LocationOrdinalValue is left to right.
RightToLeftThe ordering for the LocationOrdinalValue is right to left.
TopToBottomThe ordering for the LocationOrdinalValue is top to bottom.

RackOffsetUnits:

The type of rack units in use.

stringDescription
EIA_310A rack unit that is equal to 1.75 in (44.45 mm).
OpenUA rack unit that is equal to 48 mm (1.89 in).

Reference:

The reference point for the part location. Provides guidance about the general location of the part.

stringDescription
BottomThe part is in the bottom of the unit.
FrontThe part is in the front of the unit.
LeftThe part is on the left side of of the unit.
MiddleThe part is in the middle of the unit.
RearThe part is in the rear of the unit.
RightThe part is on the right side of the unit.
TopThe part is in the top of the unit.

MaintenanceWindow

The maintenance window assignment for applying settings or operations to a Resource.

MaintenanceWindowDurationInSeconds (v1.2+)integer
(seconds)
read-write requiredThe expiry time of maintenance window in seconds.
MaintenanceWindowStartTime (v1.2+)stringread-write requiredThe start time of a maintenance window.

Message

The message that the Redfish Service returns.

Messagestringread-only (null)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 requiredThe key for this message used to find the message in a Message Registry.
Oem { }objectSee the Oem object definition in the Common properties section.
RelatedProperties [ ] array
(string)
read-onlyA set 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)The severity of the errors.

OperationApplyTimeSupport

The client can request a specific apply time of a create, delete, or action operation of a Resource.

MaintenanceWindowDurationInSeconds (v1.2+)integer
(seconds)
read-onlyThe expiry time of maintenance window in seconds.
MaintenanceWindowResource (v1.2+) {objectThe location of the maintenance window settings.
      @odata.id
}
stringread-onlyThe unique identifier for a resource.
MaintenanceWindowStartTime (v1.2+)stringread-onlyThe start time of a maintenance window.
SupportedValues (v1.2+) [ ] array (string
(enum))
read-onlyThe types of apply times that the client can request when performing a create, delete, or action operation.
For the possible property values, see SupportedValues in Property Details.

Property Details

SupportedValues:

The types of apply times that the client can request when performing a create, delete, or action operation.

stringDescription
AtMaintenanceWindowStartThe requested operation is applied within the administrator-specified maintenance window.
ImmediateThe requested operation is applied immediately.
InMaintenanceWindowOnResetThe requested operation is applied after a reset but within the administrator-specified maintenance window.
OnResetThe requested operation is applied on a reset.

PCIeInterface

This type describes a PCIe Interface.

LanesInUse (v1.3+)integerread-only (null)The number of PCIe lanes in use by this device.
MaxLanes (v1.3+)integerread-only (null)The number of PCIe lanes supported by this device.
MaxPCIeType (v1.3+)string
(enum)
read-only (null)The highest version of the PCIe specification supported by this device.
For the possible property values, see MaxPCIeType in Property Details.
Oem (v1.3+) { }objectOem extension object.
For property details, see Oem.
PCIeType (v1.3+)string
(enum)
read-only (null)The version of the PCIe specification in use by this device.
For the possible property values, see PCIeType in Property Details.

Property Details

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.

PreferredApplyTime

The preferred time to apply configuration settings.

ApplyTime (v1.1+)string
(enum)
read-writeThe time when to apply the settings.
For the possible property values, see ApplyTime in Property Details.
MaintenanceWindowDurationInSeconds (v1.1+)integer
(seconds)
read-writeThe expiry time of maintenance window in seconds.
MaintenanceWindowStartTime (v1.1+)stringread-writeThe start time of a maintenance window.

Property Details

ApplyTime:

The time when to apply the settings.

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 the month when scheduled occurrences are enabled. 0 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 the month and months of the year. If not present, all days of the week are enabled. Days of the week.
For the possible property values, see EnabledDaysOfWeek in Property Details.
EnabledIntervals (v1.1+) [ ] array
(string, null)
read-writeIntervals when scheduled occurrences are enabled.
EnabledMonthsOfYear [ ] array (string
(enum))
read-write (null)The months of the year when scheduled occurrences are enabled. If not present, all months of the year are enabled. Months of the year.
For the possible property values, see EnabledMonthsOfYear in Property Details.
InitialStartTimestringread-write (null)The date and time when the initial occurrence is scheduled to occur.
Lifetimestringread-write (null)The time after provisioning when the schedule as a whole expires.
MaxOccurrencesintegerread-write (null)The maximum number of scheduled occurrences.
Namestringread-write (null)The schedule name.
RecurrenceIntervalstringread-write (null)The amount of time until the next occurrence occurs.

Property Details

EnabledDaysOfWeek:

Days of the week when scheduled occurrences are enabled, for enabled days of the month and months of the year. If not present, all days of the week are enabled. Days of the week.

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

EnabledMonthsOfYear:

The months of the year when scheduled occurrences are enabled. If not present, all months of the year 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

The Resource settings.

ETagstringread-only (null)The entity tag (ETag) of the Resource to which the settings were applied, after the application.
MaintenanceWindowResource (v1.2+) {objectThe location of the maintenance window settings.
      @odata.id
}
stringread-onlyThe unique identifier for a resource.
Messages [ { } ]array (object)An array of messages associated with the settings. The message that the Redfish Service returns.
For property details, see Message.
SettingsObject {objectThe link to the Resource that the client may PUT or PATCH to modify the Resource.
      @odata.id
}
stringread-onlyThe unique identifier for a resource.
SupportedApplyTimes (v1.1+) [ ] array (string
(enum))
read-onlyThe time when the settings can be applied.
For the possible property values, see SupportedApplyTimes in Property Details.
Timestringread-only (null)The time when the settings were applied.

Property Details

SupportedApplyTimes:

The time when the settings 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

The status and health of a Resource and its children.

Healthstring
(enum)
read-only (null)The health state of this Resource in the absence of its dependent Resources.
For the possible property values, see Health in Property Details.
HealthRollupstring
(enum)
read-only (null)The overall health state from the view of this Resource.
For the possible property values, see HealthRollup in Property Details.
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)The known state of the Resource, such as, enabled.
For the possible property values, see State in Property Details.

Property Details

Health:

The health state of this Resource in the absence of its dependent Resources.

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

HealthRollup:

The overall health state from the view of this Resource.

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

State:

The known state of the Resource, such as, enabled.

stringDescription
AbsentThis function or Resource is either not present or detected.
Deferring (v1.2+)The element does not process any commands but queues new requests.
DisabledThis function or Resource is disabled.
EnabledThis function or Resource is enabled.
InTestThis function or Resource is undergoing testing.
Quiesced (v1.2+)The element is enabled but only processes a restricted set of commands.
StandbyOfflineThis function or Resource is enabled but awaits an external action to activate it.
StandbySpareThis function or Resource is part of a redundancy set and awaits a failover or other external action to activate it.
StartingThis function or Resource is starting.
UnavailableOffline (v1.1+)This function or Resource is present but cannot be used.
Updating (v1.2+)The element is updating and may be unavailable or degraded.

Redundancy

Other Resource schemas use this redundancy definition.

@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.
For the possible property values, see Mode in Property Details.
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.
For property details, see Oem.
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.
For property details, see Status.

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 in a collection 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 have the same Resource type, or the 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)The description of this Resource. Used for commonality in the schema definitions.
Members [ {array requiredThe members of this collection.
      @odata.id
} ]
stringread-onlyThe 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 member.
Oem { }objectThe manufacturer- or provider-specific extension moniker that divides the Oem object into sections.

As shown in the following example, a Redfish Service may provide management functionality for several Computer Systems, and therefore a ComputerSystemCollection Resource is provided. This example shows a Service with multiple ComputerSystem instances, or 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 and later)

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. To discover these URIs, follow 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/​JobService/​Log/​Entries
/​redfish/​v1/​Managers/​{ManagerId}/​LogServices/​{LogServiceId}/​Entries
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​LogServices/​{LogServiceId}/​Entries
/​redfish/​v1/​Systems/​{ComputerSystemId}/​LogServices/​{LogServiceId}/​Entries
/​redfish/​v1/​TelemetryService/​LogService/​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
PCIeDeviceCollection
/​redfish/​v1/​Chassis/​{ChassisId}/​PCIeDevices
/​redfish/​v1/​Systems/​{ComputerSystemId}/​PCIeDevices
PCIeFunctionCollection
/​redfish/​v1/​Chassis/​{ChassisId}/​PCIeDevices/​{PCIeDeviceId}/​PCIeFunctions
/​redfish/​v1/​Systems/​{ComputerSystemId}/​PCIeDevices/​{PCIeDeviceId}/​PCIeFunctions
PortCollection
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Storage/​{StorageId}/​StorageControllers/​{StorageControllerMemberId}/​Ports
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​Storage/​{StorageId}/​StorageControllers/​{StorageControllerMemberId}/​Ports
/​redfish/​v1/​Fabrics/​{FabricId}/​Switches/​{SwitchId}/​Ports
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Storage/​{StorageId}/​StorageControllers/​{StorageControllerMemberId}/​Ports
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​Storage/​{StorageId}/​StorageControllers/​{StorageControllerMemberId}/​Ports
/​redfish/​v1/​Systems/​{ComputerSystemId}/​Storage/​{StorageId}/​StorageControllers/​{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 by using DMTF's Redfish Documentation Generator to merge the contents of the schema files from DMTF Redfish Schema bundle (DSP8010) with supplemental text.

AccelerationFunction 1.0.2

v1.0
2018.3

The AccelerationFunction schema describes an acceleration function that a processor implements. This can include functions such as audio processing, compression, encryption, packet inspection, packet switching, scheduling, or video processing.

URIs:

AccelerationFunctionTypestring
(enum)
read-only (null)The acceleration function type.
For the possible property values, see AccelerationFunctionType in Property Details.
FpgaReconfigurationSlots [ ] array
(string)
read-onlyAn array of the reconfiguration slot identifiers of the FPGA that this acceleration function occupies.
Links {objectThe links to other Resources that are related to this Resource.
      Endpoints [ {arrayAn array of links to the endpoints that connect to this acceleration 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 links 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, in watts.
Status { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
UUIDstringread-only (null)The UUID for this acceleration function.
Versionstringread-onlyThe acceleration function version.

Property Details

AccelerationFunctionType:

The acceleration function type.

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_2.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.6.0

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

The AccountService schema defines an Account Service. The properties are common to, and enable management of, all user accounts. The properties include the password requirements and control features, such as account lockout. The schema also contains links to the manager accounts and roles.

URIs:

AccountLockoutCounterResetAfterinteger
(seconds)
read-writeThe period of time, in seconds, between the last failed login attempt and the reset of the lockout threshold counter. This value must be less than or equal to the AccountLockoutDuration value. A reset sets the counter to 0.
AccountLockoutCounterResetEnabled (v1.5+)booleanread-writeAn indication of whether the threshold counter is reset after AccountLockoutCounterResetAfter expires. If true, it is reset. If false, only a successful login resets the threshold counter and if the user reaches the AccountLockoutThreshold limit, the account will be locked out indefinitely and only an administrator-issued reset clears the threshold counter. If this property is absent, the default is true.
AccountLockoutDurationinteger
(seconds)
read-write (null)The period of time, in seconds, that an account is locked after the number of failed login attempts reaches the account lockout threshold, within the period between the last failed login attempt and the reset of the lockout threshold counter. If this value is 0, no lockout will occur. If the AccountLockoutCounterResetEnabled value is false, this property is ignored.
AccountLockoutThresholdintegerread-write (null)The number of allowed failed login attempts before a user account is locked for a specified duration. If 0, the account is never locked.
Accounts {objectThe 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 Active Directory external account provider that this Account Service supports.
      AccountProviderType (deprecated v1.5)string
(enum)
read-only (null)The type of external account provider to which this Service connects.
For the possible property values, see AccountProviderType in Property Details. Deprecated in v1.5 and later. This property is deprecated because the account provider type is known when used in the LDAP and ActiveDirectory objects.
      Authentication {objectThe authentication information for the external account provider.
            AuthenticationTypestring
(enum)
read-write (null)The type of authentication used to connect to the external account provider.
For the possible property values, see AuthenticationType in Property Details.
            KerberosKeytabstringread-write (null)The Base64-encoded version of the Kerberos keytab for this Service. A PATCH or PUT operation writes the keytab. This property is null in responses.
            Oem { }objectSee the Oem object definition in the Common properties section.
            Passwordstringread-write (null)The password for this Service. A PATCH or PUT request writes the password. This property is null in responses.
            Tokenstringread-write (null)The token for this Service. A PATCH or PUT operation writes the token. This property is null in responses.
            Username
      }
stringread-writeThe user name for the Service.
      Certificates (v1.4+) {objectThe link to a collection of certificates that the external account provider uses.
Contains a link to a resource.
            @odata.id
      }
stringread-onlyLink to Collection of Certificate. See the Certificate schema for details.
      LDAPService {objectThe additional mapping information needed to parse a generic LDAP service.
            Oem { }objectSee the Oem object definition in the Common properties section.
            SearchSettings {objectThe required settings to search an external LDAP service.
                  BaseDistinguishedNames [ ] array
(string, null)
read-writeThe base distinguished names to use to search an external LDAP service.
                  GroupNameAttributestringread-write (null)The attribute name that contains the LDAP group name entry.
                  GroupsAttributestringread-write (null)The attribute name that contains the groups for a user on the LDAP user entry.
                  UsernameAttribute
            }
      }
stringread-write (null)The attribute name that contains the LDAP user name entry.
      RemoteRoleMapping [ {arrayThe mapping rules to convert the external account providers account information to the local Redfish Role.
            LocalRolestringread-write (null)The name of the local Redfish Role to which to map the remote user or group.
            Oem { }objectSee the Oem object definition in the Common properties section.
            RemoteGroupstringread-write (null)The name of the remote group, or the remote role in the case of a Redfish Service, that maps to the local Redfish Role to which this entity links.
            RemoteUser
      } ]
stringread-write (null)The name of the remote user that maps to the local Redfish Role to which this entity links.
      ServiceAddresses [ ] array
(string, null)
read-writeThe addresses of the user account providers to which this external account provider links. The format of this field depends on the type of external account provider.
      ServiceEnabled
}
booleanread-write (null)An indication of whether this service is enabled.
AdditionalExternalAccountProviders (v1.3+) {objectThe additional external account providers that this Account Service uses.
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 that are allowed before the failed attempt is logged to the manager log.
LDAP (v1.3+) {objectThe first LDAP external account provider that this Account Service supports.
      AccountProviderType (deprecated v1.5)string
(enum)
read-only (null)The type of external account provider to which this Service connects.
For the possible property values, see AccountProviderType in Property Details. Deprecated in v1.5 and later. This property is deprecated because the account provider type is known when used in the LDAP and ActiveDirectory objects.
      Authentication {objectThe authentication information for the external account provider.
            AuthenticationTypestring
(enum)
read-write (null)The type of authentication used to connect to the external account provider.
For the possible property values, see AuthenticationType in Property Details.
            KerberosKeytabstringread-write (null)The Base64-encoded version of the Kerberos keytab for this Service. A PATCH or PUT operation writes the keytab. This property is null in responses.
            Oem { }objectSee the Oem object definition in the Common properties section.
            Passwordstringread-write (null)The password for this Service. A PATCH or PUT request writes the password. This property is null in responses.
            Tokenstringread-write (null)The token for this Service. A PATCH or PUT operation writes the token. This property is null in responses.
            Username
      }
stringread-writeThe user name for the Service.
      Certificates (v1.4+) {objectThe link to a collection of certificates that the external account provider uses.
Contains a link to a resource.
            @odata.id
      }
stringread-onlyLink to Collection of Certificate. See the Certificate schema for details.
      LDAPService {objectThe additional mapping information needed to parse a generic LDAP service.
            Oem { }objectSee the Oem object definition in the Common properties section.
            SearchSettings {objectThe required settings to search an external LDAP service.
                  BaseDistinguishedNames [ ] array
(string, null)
read-writeThe base distinguished names to use to search an external LDAP service.
                  GroupNameAttributestringread-write (null)The attribute name that contains the LDAP group name entry.
                  GroupsAttributestringread-write (null)The attribute name that contains the groups for a user on the LDAP user entry.
                  UsernameAttribute
            }
      }
stringread-write (null)The attribute name that contains the LDAP user name entry.
      RemoteRoleMapping [ {arrayThe mapping rules to convert the external account providers account information to the local Redfish Role.
            LocalRolestringread-write (null)The name of the local Redfish Role to which to map the remote user or group.
            Oem { }objectSee the Oem object definition in the Common properties section.
            RemoteGroupstringread-write (null)The name of the remote group, or the remote role in the case of a Redfish Service, that maps to the local Redfish Role to which this entity links.
            RemoteUser
      } ]
stringread-write (null)The name of the remote user that maps to the local Redfish Role to which this entity links.
      ServiceAddresses [ ] array
(string, null)
read-writeThe addresses of the user account providers to which this external account provider links. The format of this field depends on the type of external account provider.
      ServiceEnabled
}
booleanread-write (null)An indication of whether this service is enabled.
LocalAccountAuth (v1.3+)string
(enum)
read-writeAn indication of how the Service uses the accounts collection within this Account Service as part of authentication. The enumerated values describe the details for each mode.
For the possible property values, see LocalAccountAuth in Property Details.
MaxPasswordLengthintegerread-onlyThe maximum password length for this Account Service.
MinPasswordLengthintegerread-onlyThe minimum password length for this Account Service.
PrivilegeMap (v1.1+) {objectThe link to the mapping of the privileges required to complete 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 {objectThe collection of Redfish Roles.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of Role. See the Role schema for details.
ServiceEnabledbooleanread-write (null)An indication of whether the Account Service is enabled. If true, it is enabled. If false, it is disabled and users cannot be created, deleted, or modified, and new sessions cannot be started. However, established sessions may still continue to run. Any service, such as the Session Service, that attempts to access the disabled Account Service fails. However, this does not affect HTTP Basic Authentication connections.
Status { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.

Property Details

AccountProviderType:

The type of external account provider to which this Service connects.

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

AuthenticationType:

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.
UsernameAndPasswordA user name and password combination.

LocalAccountAuth:

An indication of how the Service uses the accounts collection within this Account Service as part of authentication. The enumerated values describe the details for each mode.

stringDescription
DisabledThe service never authenticates users based on the Account Service-defined accounts collection.
EnabledThe service authenticates users based on the Account Service-defined accounts collection.
FallbackThe service authenticates users based on the Account Service-defined accounts collection only if any external account providers are currently unreachable.
LocalFirst (v1.6+)The service first authenticates users based on the Account Service-defined accounts collection. If authentication fails, the Service authenticates by using external account providers.

Example Response

{
    "@odata.type": "#AccountService.v1_6_0.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,
    "AccountLockoutCounterResetEnabled": true,
    "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.id": "/redfish/v1/AccountService"
}

ActionInfo 1.1.2

v1.1v1.0
2018.22016.2

The ActionInfo schema defines the supported parameters and other information for a Redfish action. Supported parameters can differ among vendors and even among Resource instances. This data can ensure that action requests from applications contain supported parameters.

Parameters [ {arrayThe list of parameters included in the specified Redfish action.
      AllowableValues [ ] array
(string, null)
read-onlyThe allowable values for this parameter as applied to this action target.
      DataTypestring
(enum)
read-only (null)The JSON property type for this parameter.
For the possible property values, see DataType in Property Details.
      MaximumValue (v1.1+)numberread-only (null)The maximum supported value for 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 data type of an object-based parameter.
      Required
} ]
booleanread-onlyAn indication of whether the parameter is required to complete this action.

Property Details

DataType:

The JSON property type for this parameter.

stringDescription
BooleanA boolean.
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_2.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.id": "/redfish/v1/Systems/1/ResetActionInfo"
}

Assembly 1.2.2

v1.2v1.1v1.0
2018.22018.12017.3

The Assembly schema defines an assembly. Assembly information contains details about a device, such as part number, serial number, manufacturer, and production date. It also provides access to the original data for the assembly.

URIs:

Assemblies [ {arrayThe assembly records.
      @odata.idstringread-only requiredThe unique identifier for a resource.
      Actions { }objectThe available actions for this Resource.
      BinaryDataURIstringread-only (null)The URI at which to access an image of the assembly information.
      Descriptionstringread-only (null)The description of the assembly.
      EngineeringChangeLevelstringread-only (null)The engineering change level of the assembly.
      MemberIdstringread-only requiredThe identifier for the member within the collection.
      Modelstringread-only (null)The model number of the assembly.
      Namestringread-only (null)The name of the assembly.
      Oem { }objectSee the Oem object definition in the Common properties section.
      PartNumberstringread-only (null)The part number of the assembly.
      PhysicalContext (v1.2+)string
(enum)
read-onlyThe area or device to which the assembly data applies.
For the possible property values, see PhysicalContext in Property Details.
      Producerstringread-only (null)The producer or manufacturer of the assembly.
      ProductionDatestringread-only (null)The production date of the assembly.
      SerialNumber (v1.2+)stringread-only (null)The serial number of the assembly.
      SKUstringread-only (null)The SKU of the assembly.
      SparePartNumberstringread-only (null)The spare part number of the assembly.
      Status (v1.1+) { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
      Vendorstringread-only (null)The vendor of the assembly.
      Version
} ]
stringread-only (null)The version of the assembly.

Property Details

PhysicalContext:

The area or device to which the 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 a networking chip or chipset component.
BackThe back of the chassis.
BackplaneA backplane within the chassis.
ChassisThe entire chassis.
ComputeBayWithin a compute bay.
CoolingSubsystemThe entire cooling, or air and liquid, subsystem.
CPUA processor (CPU).
CPUSubsystemThe entire processor (CPU) subsystem.
DCBusA DC bus.
ExhaustThe air exhaust point or points or region of the chassis.
ExpansionBayWithin an expansion bay.
FanA fan.
FPGAAn FPGA.
FrontThe front of the chassis.
GPUA graphics processor (GPU).
GPUSubsystemThe entire graphics processor (GPU) subsystem.
IntakeThe air intake point or points 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_2.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.2

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

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

Languagestringread-only requiredThe RFC5646-conformant language code for the Attribute Registry.
OwningEntitystringread-only requiredThe organization or company that publishes this Attribute Registry.
RegistryEntries {objectThe list of all attributes and their metadata for this component.
      Attributes [ {arrayAn array of attributes and their possible values in the Attribute Registry.
            AttributeNamestringread-only requiredThe unique name for the attribute.
            CurrentValuestring, boolean, numberread-only (null)The placeholder of the current value for the attribute.
            DefaultValuestring, boolean, numberread-only (null)The default value for the attribute.
            DisplayNamestringread-only (null)The user-readable display string for the attribute in the defined language.
            DisplayOrderintegerread-only (null)The ascending order, as a number, in which this attribute appears relative to other attributes.
            GrayOutbooleanread-only (null)An indication of whether this attribute is grayed out. A grayed-out attribute is not active and is grayed out in user interfaces but the attribute value can be modified.
            HelpTextstringread-only (null)The help text for the attribute.
            Hiddenbooleanread-only (null)An indication of whether this attribute is hidden in user interfaces.
            Immutablebooleanread-only (null)An indication of whether this attribute is immutable. Immutable attributes shall not be modified and typically reflect a hardware state.
            IsSystemUniquePropertybooleanread-only (null)An indication of whether this attribute is unique for this system and should not be replicated.
            LowerBoundintegerread-only (null)The lower limit for an integer attribute.
            MaxLengthintegerread-only (null)The maximum character length of a string attribute.
            MenuPathstringread-only (null)The path that describes the menu hierarchy of this attribute.
            MinLengthintegerread-only (null)The minimum character length of the string attribute.
            Oem (v1.3+) { }objectSee the Oem object definition in the Common properties section.
            ReadOnlybooleanread-only (null)An indication of whether this attribute is read-only. A read-only attribute cannot be modified, and should be grayed out in user interfaces.
            ResetRequired (v1.2+)booleanread-only (null)An indication of whether a system or device reset is required for this attribute value change to take effect.
            ScalarIncrementintegerread-only (null)The amount to increment or decrement an integer attribute each time a user requests a value change. The 0 value indicates a free-form numeric user-input attribute.
            Typestring
(enum)
read-onlyThe attribute type.
For the possible property values, see Type in Property Details.
            UefiDevicePath (v1.2+)stringread-only (null)The UEFI device path that qualifies this attribute.
            UefiKeywordName (v1.2+)stringread-onlyThe UEFI keyword string for this attribute.
            UefiNamespaceId (v1.2+)stringread-onlyThe UEFI namespace ID for the attribute.
            UpperBoundintegerread-only (null)The upper limit for an integer attribute.
            Value [ {arrayAn array of the possible values for enumerated attribute values.
                  ValueDisplayNamestringread-only (null)A user-readable display string of the value for the attribute in the defined language.
                  ValueName
            } ]
stringread-only requiredThe unique value name for the attribute.
            ValueExpressionstringread-only (null)A valid regular expression, according to the Perl regular expression dialect, that validates the attribute value. Applies to only string and integer attributes.
            WarningTextstringread-only (null)The warning text for the attribute.
            WriteOnly
      } ]
booleanread-only (null)An indication of whether this attribute is write-only. A write-only attribute reverts to its initial value after settings are applied.
      Dependencies [ {arrayAn array of dependencies of attributes on this component.
            Dependency {objectThe dependency expression for one or more attributes in this Attribute Registry.
                  MapFrom [ {arrayAn array of the map-from conditions for a mapping dependency.
                        MapFromAttributestringread-onlyThe attribute to use to evaluate this dependency expression.
                        MapFromConditionstring
(enum)
read-onlyThe condition to use to evaluate this dependency expression.
For the possible property values, see MapFromCondition in Property Details.
                        MapFromPropertystring
(enum)
read-onlyThe metadata property for the attribute that the MapFromAttribute property specifies to use to evaluate this dependency expression.
For the possible property values, see MapFromProperty in Property Details.
                        MapFromValuestring, boolean, numberread-only (null)The value to use to evaluate this dependency expression.
                        MapTerms
                  } ]
string
(enum)
read-onlyThe logical term that combines two or more map-from conditions in this dependency expression. For example, AND for logical AND, or OR for logical OR.
For the possible property values, see MapTerms in Property Details.
                  MapToAttributestringread-onlyThe AttributeName of the attribute that is affected by this dependency expression.
                  MapToPropertystring
(enum)
read-onlyThe metadata property for the attribute that contains the map-from condition that evaluates this dependency expression.
For the possible property values, see MapToProperty in Property Details.
                  MapToValue
            }
string, boolean, numberread-only (null)The value that the map-to property changes 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.
For the possible property values, see Type in Property Details.
      Menus [ {arrayAn array for the attributes menus and their hierarchy in the Attribute Registry.
            DisplayNamestringread-only (null)The user-readable display string of this menu in the defined language.
            DisplayOrderintegerread-only (null)The ascending order, as a number, in which this menu appears relative to other menus.
            GrayOutbooleanread-only (null)An indication of whether this menu is grayed out. A grayed-only menu is not accessible in user interfaces.
            Hidden (v1.3+)booleanread-only (null)An indication of whether this menu is hidden in user interfaces.
            MenuNamestringread-onlyThe unique name string of this menu.
            MenuPathstringread-only (null)The path to the menu names 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)An indication of whether this menu is read-only. A read-only menu, its properties, and sub-menus are not accessible in user interfaces.
RegistryVersionstringread-only requiredThe Attribute Registry version.
SupportedSystems [ {arrayAn array of systems that this Attribute Registry supports.
      FirmwareVersion (v1.1+)stringread-only (null)Firmware version.
      ProductNamestringread-only (null)The product name of the computer system to which this Attribute Registry applies.
      SystemId
} ]
stringread-only (null)The ID of the systems to which this Attribute Registry applies.

Property Details

MapFromCondition:

The condition to use 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 metadata property for the attribute that the MapFromAttribute property specifies to use 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 that combines two or more map-from conditions in this dependency expression. For example, `AND` for logical AND, or `OR` for logical OR.

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

MapToProperty:

The metadata property for the attribute that contains the map-from condition that evaluates 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. If the condition evaluates to `true`, the attribute or state changes to the mapped value.

Example Response

{
    "@odata.type": "#AttributeRegistry.v1_3_2.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.1.0

v1.1v1.0
2019.22016.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 finds 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_]+$"
Links (v1.1+) {objectThe links to other Resources that are related to this Resource.
      ActiveSoftwareImage {objectThe link to the SoftwareInventory that represents the active BIOS firmware image.
See the SoftwareInventory schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a SoftwareInventory resource. See the Links section and the SoftwareInventory schema for details.
      Oem { }objectSee the Oem object definition in the Common properties section.
      SoftwareImages [ {arrayThe images that are associated with this BIOS.
            @odata.id
      } ]
}
stringread-onlyLink to a SoftwareInventory resource. See the Links section and the SoftwareInventory schema for details.

Actions

ChangePassword

This action changes a BIOS password.

URIs:

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

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

ResetBios

This action resets the BIOS attributes to default.

URIs:

(This action takes no parameters.)

Example Response

{
    "@odata.type": "#Bios.v1_1_0.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_2_2.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.id": "/redfish/v1/Systems/437XR1138R2/Bios"
}

BootOption 1.0.3

v1.0
2017.3

The BootOption schema describes a boot option. It represents the properties of a bootable device available in the system.

URIs:

Aliasstring
(enum)
read-only (null)The alias of this boot source.
For the possible property values, see Alias in Property Details.
BootOptionEnabledbooleanread-write (null)An indication of whether the boot option is enabled. If true, it is enabled. If false, the boot option that the boot order array on the computer system contains is skipped. In the UEFI context, this property shall influence the load option active flag for the boot option.
BootOptionReferencestringread-only required (null)The unique boot option.
DisplayNamestringread-only (null)The user-readable display name of the boot option that appears in the boot order list in the user interface.
RelatedItem [ {arrayAn array of one or more IDs for the Resources associated with this boot option.
      @odata.id
} ]
stringread-onlyThe unique identifier for a resource.
UefiDevicePathstringread-only (null)The UEFI device path 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 or DVD.
DiagsBoot to 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, such as an iSCSI target.
SDCardBoot from an SD card.
UefiBootNextBoot to the UEFI device that the BootNext property specifies.
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 system BIOS-specified USB device.
UtilitiesBoot to the manufacturer's utilities program or programs.

Example Response

{
    "@odata.id": "/redfish/v1/Systems/1/BootOptions/1",
    "@odata.type": "#BootOption.v1_0_3.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.1

v1.1v1.0
2019.12018.3

The Certificate schema describes a certificate that proves 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.
For the possible property values, see CertificateType in Property Details.
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 key usage extension, which defines the purpose of the public keys in this certificate. The usages of a key contained within a certificate.
For the possible property values, see KeyUsage in Property Details.
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 generates a new key-pair for a certificate and produces a certificate signing request.

URIs:

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

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

Renew

This action generates a certificate signing request by using the existing information and key-pair of the certificate.

URIs:

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

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

Property Details

CertificateType:

The format of the certificate.

stringDescription
PEMA Privacy Enhanced Mail (PEM)-encoded certificate.
PKCS7A Privacy Enhanced Mail (PEM)-encoded PKCS7 certificate.

KeyUsage:

The key usage extension, which defines the purpose of the public keys in this certificate. The usages of a key contained within a certificate.

stringDescription
ClientAuthenticationTLS WWW client authentication.
CodeSigningSigns downloadable executable code.
CRLSigningVerifies signatures on certificate revocation lists (CLRs).
DataEnciphermentDirectly enciphers raw user data without an intermediate symmetric cipher.
DecipherOnlyDeciphers data while performing a key agreement.
DigitalSignatureVerifies digital signatures, other than signatures on certificates and CRLs.
EmailProtectionEmail protection.
EncipherOnlyEnciphers data while performing a key agreement.
KeyAgreementKey agreement.
KeyCertSignVerifies signatures on public key certificates.
KeyEnciphermentEnciphers private or secret keys.
NonRepudiationVerifies digital signatures, other than signatures on certificates and CRLs, and provides a non-repudiation service that protects against the signing entity falsely denying some action.
OCSPSigningSigns OCSP responses.
ServerAuthenticationTLS WWW server authentication.
TimestampingBinds the hash of an object to a time.

Example Response

{
    "@odata.type": "#Certificate.v1_1_1.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.2

v1.0
2018.3

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

URIs:

Links {objectThe links to other Resources that are related to this Resource.
      Certificates [ {arrayAn array of links 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_2.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.2

v1.0
2018.3

The CertificateService schema describes a Certificate Service that represents the actions available to manage certificates and links to the certificates.

URIs:

CertificateLocations {objectThe information about 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 makes a certificate signing request.

URIs:

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

{
      AlternativeNames [ ] array
(string)
read-writeThe additional host names of the component to secure.
      CertificateCollection {object requiredThe URI of the Certificate Resource Collection where the certificate is installed after the certificate authority (CA) signs the certificate.
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 apply 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 to secure.
      ContactPersonstringread-writeThe name of the user making the request.
      Countrystringread-write requiredThe two-letter country code 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 KeyPairAlgorithm parameter value.
      KeyCurveIdstringread-writeThe curve ID to use with the key, if needed based on the KeyPairAlgorithm parameter value.
      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.
For the possible property values, see KeyUsage in Property Details.
      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 replaces a certificate.

URIs:

The following table shows the parameters for the action that 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-write requiredThe format of the certificate.
For the possible property values, see CertificateType in Property Details.
      CertificateUri {object requiredThe 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 Privacy Enhanced Mail (PEM)-encoded certificate.
PKCS7A Privacy Enhanced Mail (PEM)-encoded PKCS7 certificate.

KeyUsage:

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

stringDescription
ClientAuthenticationTLS WWW client authentication.
CodeSigningSigns downloadable executable code.
CRLSigningVerifies signatures on certificate revocation lists (CLRs).
DataEnciphermentDirectly enciphers raw user data without an intermediate symmetric cipher.
DecipherOnlyDeciphers data while performing a key agreement.
DigitalSignatureVerifies digital signatures, other than signatures on certificates and CRLs.
EmailProtectionEmail protection.
EncipherOnlyEnciphers data while performing a key agreement.
KeyAgreementKey agreement.
KeyCertSignVerifies signatures on public key certificates.
KeyEnciphermentEnciphers private or secret keys.
NonRepudiationVerifies digital signatures, other than signatures on certificates and CRLs, and provides a non-repudiation service that protects against the signing entity falsely denying some action.
OCSPSigningSigns OCSP responses.
ServerAuthenticationTLS WWW server authentication.
TimestampingBinds the hash of an object to a time.

Example Response

{
    "@odata.type": "#CertificateService.v1_0_2.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.10.0

v1.10v1.9v1.8v1.7v1.6v1.5v1.4v1.3v1.2v1.10v1.1v1.0
2019.22018.32018.22018.12017.32017.12016.32016.22016.12019.21.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, such as sensors, that operate outside of a system's data plane are linked either directly or indirectly through this Resource. A subsystem that operates outside of a system's data plane are not accessible to software that runs on the system.

URIs:

Assembly (v1.6+) {objectThe link to the Assembly 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.
For the possible property values, see ChassisType in Property Details.
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.
For the possible property values, see EnvironmentalClass in Property Details.
HeightMm (v1.4+)number
(mm)
read-only (null)The height of the chassis.
IndicatorLEDstring
(enum)
read-write (null)The state of the indicator LED, which identifies the chassis.
For the possible property values, see IndicatorLED in Property Details.
Links {objectThe links to other Resources that are related to this Resource.
      ComputerSystems [ {arrayAn array of links to the computer systems that this chassis directly and wholly contains.
            @odata.id
      } ]
stringread-onlyLink to a ComputerSystem resource. See the Links section and the ComputerSystem schema for details.
      ContainedBy {objectThe link to the chassis that contains this chassis.
            @odata.id
      }
stringread-onlyLink to another Chassis resource.
      Contains [ {arrayAn array of links to any other chassis that this chassis has in it.
            @odata.id
      } ]
stringread-onlyLink to another Chassis resource.
      CooledBy [ {arrayAn array of one or more IDs of Resources that cool this chassis. Normally, the ID is for either a chassis or a specific set of fans.
            @odata.id
      } ]
stringread-onlyThe unique identifier for a resource.
      Drives (v1.2+) [ {arrayAn array of links to the 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 links 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 links 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+, deprecated v1.10) [ {arrayAn array of links to the PCIe devices located in this chassis. This property has been deprecated in favor of the PCIeDevices Resource Collection in the root of this Resource.
            @odata.id
      } ]
stringread-onlyLink to a PCIeDevice resource. See the Links section and the PCIeDevice schema for details.
      PoweredBy [ {arrayAn array of one or more IDs of Resources that power this chassis. Normally, the ID is for either a chassis or a specific set of power supplies.
            @odata.id
      } ]
stringread-onlyThe unique identifier for a resource.
      Processors (v1.9+) [ {arrayAn array of links 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 links 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 links 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 links 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.
For property details, see Location.
LogServices {objectThe link 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+) {objectThe link 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.
PCIeDevices (v1.10+) {objectThe link to the collection of PCIe devices located in this chassis.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of PCIeDevice. See the PCIeDevice schema for details.
PCIeSlots (v1.8+) {objectThe link to the PCIe slot properties for 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.
For the possible property values, see IntrusionSensor in Property Details.
      IntrusionSensorNumberintegerread-only (null)A numerical identifier to represent the physical security sensor.
      IntrusionSensorReArm
}
string
(enum)
read-only (null)The method that restores this physical security sensor to the normal state.
For the possible property values, see IntrusionSensorReArm in Property Details.
Power {objectThe link to the power properties, or power supplies, power policies, and sensors, for 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.0.1+)string
(enum)
read-only (null)The current power state of the chassis.
For the possible property values, see PowerState in Property Details.
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 { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
Thermal {objectThe link to the thermal properties, such as fans, cooling, and sensors, for 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.
UUID (v1.7+)stringread-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 resets the chassis but does not reset systems or other contained Resources, although side effects may occur that affect those Resources.

URIs:

The following table shows the parameters for the action that 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.
For the possible property values, see ResetType in Property Details.

Property Details

ChassisType:

The type of physical form factor of the chassis.

stringDescription
BladeAn enclosed or semi-enclosed, typically vertically-oriented, system chassis that 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 that contains devices for a particular subsystem or function.
DrawerAn enclosed or semi-enclosed, typically horizontally-oriented, system chassis that may be slid into a multi-system chassis.
EnclosureA generic term for a chassis that does not fit any other description.
ExpansionA chassis that 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 that 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 that 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 that 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 that 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 that 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 Class 'A1'.
A2ASHRAE Environmental Class 'A2'.
A3ASHRAE Environmental Class 'A3'.
A4ASHRAE Environmental Class 'A4'.

IndicatorLED:

The state of the indicator LED, which identifies the chassis.

stringDescription
BlinkingThe indicator LED is blinking.
LitThe indicator LED is lit.
OffThe indicator LED is off.
Unknown (deprecated v1.2)The state of the indicator LED cannot be determined. 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 to be in an insecure state.
NormalNo abnormal physical security condition is detected at this time.
TamperingDetectedPhysical tampering of the monitored entity is detected.

IntrusionSensorReArm:

The method that restores this physical security sensor to the normal state.

stringDescription
AutomaticBecause no abnormal physical security condition is detected, this sensor is automatically restored to the normal state.
ManualA manual re-arm of this sensor restores it to the normal state.

PowerState:

The current power state of the chassis.

stringDescription
OffThe components within the chassis have no power, except some components may continue to have AUX power, such as the management controller.
OnThe components within the chassis have power.
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.

stringDescription
ForceOffTurn off the unit immediately (non-graceful shutdown).
ForceOnTurn on the unit immediately.
ForceRestartShut down immediately and non-gracefully and restart the system.
GracefulRestartShut down gracefully and restart the system.
GracefulShutdownShut down gracefully and power off.
NmiGenerate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system.
OnTurn on the unit.
PowerCyclePower cycle the unit.
PushPowerButtonSimulate the pressing of the physical power button on this unit.

Example Response

{
    "@odata.type": "#Chassis.v1_10_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.id": "/redfish/v1/Chassis/1U"
}

CompositionService 1.1.2

v1.1v1.0
2018.22017.1

The CompositionService schema describes a Composition Service and its properties and links to the Resources available for composition.

URIs:

AllowOverprovisioning (v1.1+)booleanread-write (null)An indication of whether this service is allowed to overprovision a composition relative to the composition request.
AllowZoneAffinity (v1.1+)booleanread-only (null)An indication of whether a client can request that a specific Resource Zone fulfill a composition request.
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)An indication of whether this service is enabled.
Status { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.

Example Response

{
    "@odata.type": "#CompositionService.v1_1_2.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.id": "/redfish/v1/CompositionService"
}

ComputerSystem 1.8.0

v1.8v1.7v1.6v1.5v1.4v1.3v1.2v1.1v1.0
2019.22019.12018.32017.32017.12016.32016.22016.11.0

The ComputerSystem schema represents a computer or system instance and the software-visible Resources, or items within the data plane, such as memory, CPU, and other devices that it can access. Details of those Resources or subsystems are also linked through this Resource.

URIs:

AssetTagstringread-write (null)The user-definable tag that can track this computer system for inventory or other client purposes.
Bios (v1.1+) {objectThe link 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 {objectThe boot settings for this system.
      AliasBootOrder (v1.6+) [ ] array (string
(enum))
read-write (null)Ordered array of boot source aliases representing the persistent boot order associated with this computer system.
For the possible property values, see AliasBootOrder in Property Details.
      BootNext (v1.5+)stringread-write (null)The BootOptionReference of the Boot Option to perform a one-time boot from when BootSourceOverrideTarget is UefiBootNext.
      BootOptions (v1.5+) {objectThe link 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-writeAn array of BootOptionReference strings that represent the persistent boot order for with this computer system.
      BootOrderPropertySelection (v1.6+)string
(enum)
read-write (null)The name of the boot order property that the system uses for the persistent boot order.
For the possible property values, see BootOrderPropertySelection in Property Details.
      BootSourceOverrideEnabledstring
(enum)
read-write (null)The state of the boot source override feature.
For the possible property values, see BootSourceOverrideEnabled in Property Details.
      BootSourceOverrideMode (v1.1+)string
(enum)
read-write (null)The BIOS boot mode to use when the system boots from the BootSourceOverrideTarget boot source.
For the possible property values, see BootSourceOverrideMode in Property Details.
      BootSourceOverrideTargetstring
(enum)
read-write (null)The current boot source to use at the next boot instead of the normal boot device, if BootSourceOverrideEnabled is true.
For the possible property values, see BootSourceOverrideTarget in Property Details.
      Certificates (v1.7+) {objectThe link to a collection of certificates used for booting through HTTPS by this computer system.
Contains a link to a resource.
            @odata.id
      }
stringread-onlyLink to Collection of Certificate. See the Certificate schema for details.
      UefiTargetBootSourceOverride
}
stringread-write (null)The UEFI device path of the device from which to boot when BootSourceOverrideTarget is UefiTarget.
EthernetInterfaces {objectThe link 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
}
read-onlyThe link to a collection of storage services that this computer system supports.
HostingRoles (v1.2+) [ ] array (string
(enum))
read-onlyThe hosting roles that this computer system supports. The enumerations of HostingRoles specify different features that the hosting ComputerSystem supports.
For the possible property values, see HostingRoles in Property Details.
HostNamestringread-write (null)The DNS host name, without any domain information.
HostWatchdogTimer (v1.5+) {objectThe host watchdog timer functionality for this system.
      FunctionEnabledbooleanread-write required (null)An indication of whether a user has enabled the host watchdog timer functionality. This property indicates only that a user has enabled the timer. To activate the timer, installation of additional host-based software is necessary; an update to this property does not initiate the timer.
      Oem { }objectSee the Oem object definition in the Common properties section.
      Status { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
      TimeoutActionstring
(enum)
read-write required (null)The action to perform when the watchdog timer reaches its timeout value.
For the possible property values, see TimeoutAction in Property Details.
      WarningAction
}
string
(enum)
read-write (null)The action to perform when the watchdog timer is close to reaching its timeout value. This action typically occurs from three to ten seconds before to the timeout value, but the exact timing is dependent on the implementation.
For the possible property values, see WarningAction in Property Details.
IndicatorLEDstring
(enum)
read-write (null)The state of the indicator LED, which identifies the system.
For the possible property values, see IndicatorLED in Property Details.
Links {objectThe links to other Resources that are related to this Resource.
      Chassis [ {arrayAn array of links to the chassis that contains this system.
            @odata.id
      } ]
stringread-onlyLink to a Chassis resource. See the Links section and the Chassis schema for details.
      ConsumingComputerSystems (v1.5+) [ {arrayAn array of links 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 one or more IDs for Resources that cool this computer system. Normally, the ID is for either a chassis or a specific set of fans.
            @odata.id
      } ]
stringread-onlyThe unique identifier for a resource.
      Endpoints (v1.2+) [ {arrayAn array of links 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 links 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 one or more IDs for Resources that power this computer system. Normally, the ID is for either a chassis or a specific set of power supplies.
            @odata.id
      } ]
stringread-onlyThe unique identifier for a resource.
      ResourceBlocks (v1.4+) [ {arrayAn array of links 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 links to ComputerSystems that contribute, in whole or in part, to the implementation of this ComputerSystem.
            @odata.id
      } ]
}
stringread-onlyLink to another ComputerSystem resource.
LogServices {objectThe link 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+) {objectThe link 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+) {objectThe link 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 {objectThe central memory of the system in general detail.
      MemoryMirroring (v1.1+)string
(enum)
read-only (null)The ability and type of memory mirroring that this computer system supports.
For the possible property values, see MemoryMirroring in Property Details.
      Metrics (v1.8+) {objectThe link to the metrics associated with all memory in this system.
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.
      Status { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
      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+) {objectThe link 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+) [ {arrayThe link to a collection of PCIe devices that this computer system uses.
      @odata.id
} ]
stringread-onlyLink to a PCIeDevice resource. See the Links section and the PCIeDevice schema for details.
PCIeFunctions (v1.2+) [ {arrayThe link to a collection of PCIe functions that this computer system uses.
      @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.
For the possible property values, see PowerRestorePolicy in Property Details.
PowerStatestring
(enum)
read-only (null)The current power state of the system.
For the possible property values, see PowerState in Property Details.
Processors {objectThe link 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 {objectThe 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+) {objectThe link 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 { }
}
objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
Redundancy (v1.5+) [ {arrayThe link to a collection of redundancy entities. Each entity specifies a kind and level of redundancy and a collection, or redundancy set, of other computer systems that provide the specified redundancy to this computer system.
      @odata.id
} ]
stringread-onlyThe unique identifier for a resource.
SecureBoot (v1.1+) {objectThe link to the UEFI Secure Boot 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 {objectThe link 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 { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
Storage (v1.1+) {objectThe link 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 that this Resource represents.
For the possible property values, see SystemType in Property Details.
TrustedModules (v1.1+) [ {arrayAn array of trusted modules in the system.
      FirmwareVersionstringread-only (null)The firmware version of this Trusted Module.
      FirmwareVersion2 (v1.3+)stringread-only (null)The second firmware version of this Trusted Module, if applicable.
      InterfaceTypestring
(enum)
read-only (null)The interface type of the Trusted Module.
For the possible property values, see InterfaceType in Property Details.
      InterfaceTypeSelection (v1.3+)string
(enum)
read-only (null)The interface type selection supported by this Trusted Module.
For the possible property values, see InterfaceTypeSelection in Property Details.
      Oem { }objectSee the Oem object definition in the Common properties section.
      Status { }
} ]
objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
UUIDstringread-only (null)The UUID for this system.
For more information about this property, see Property Details.

Actions

AddResourceBlock

This action adds a Resource Block to a system.

URIs:

The following table shows the parameters for the action that 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 {object requiredThe 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 removes a Resource Block from a system.

URIs:

The following table shows the parameters for the action that 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 {object requiredThe 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 resets the system.

URIs:

The following table shows the parameters for the action that 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.
For the possible property values, see ResetType in Property Details.

SetDefaultBootOrder

This action sets the BootOrder 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 or DVD.
DiagsBoot to 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, such as an iSCSI target.
SDCardBoot from an SD card.
UefiBootNextBoot to the UEFI device that the BootNext property specifies.
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 system BIOS-specified USB device.
UtilitiesBoot to the manufacturer's utilities program or programs.

BootOrderPropertySelection:

The name of the boot order property that the system uses for the persistent boot order.

stringDescription
AliasBootOrderThe system uses the AliasBootOrder property to specify the persistent boot order.
BootOrderThe system uses the BootOrder property to specify the persistent boot order.

BootSourceOverrideEnabled:

The state of the boot source override feature.

stringDescription
ContinuousThe system boots to the target specified in the BootSourceOverrideTarget property until this property is `Disabled`.
DisabledThe system boots normally.
OnceOn its next boot cycle, the system boots one time to the boot source override target. Then, the BootSourceOverrideEnabled value is reset to `Disabled`.

BootSourceOverrideMode:

The BIOS boot mode to use when the system boots from the BootSourceOverrideTarget boot source.

stringDescription
LegacyThe system boots in non-UEFI boot mode to the boot source override target.
UEFIThe system boots in UEFI boot mode to the boot source override target.

BootSourceOverrideTarget:

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

stringDescription
BiosSetupBoot to the BIOS setup utility.
CdBoot from the CD or DVD.
DiagsBoot to 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, such as an iSCSI target.
SDCard (v1.1+)Boot from an SD card.
UefiBootNext (v1.5+)Boot to the UEFI device that the BootNext property specifies.
UefiHttp (v1.1+)Boot from a UEFI HTTP network location.
UefiShellBoot to the UEFI Shell.
UefiTargetBoot to the UEFI device specified in the UefiTargetBootSourceOverride property.
UsbBoot from a system BIOS-specified USB device.
UtilitiesBoot to the manufacturer's utilities program or programs.

HostingRoles:

The hosting 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, which identifies the system.

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

InterfaceType:

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 through platform software, such as a BIOS configuration attribute.
FirmwareUpdateThe TrustedModule supports switching InterfaceType through a firmware update.
NoneThe TrustedModule does not support switching the InterfaceType.
OemMethodThe TrustedModule supports switching InterfaceType through an OEM proprietary mechanism.

MemoryMirroring:

The ability and type of memory mirroring that this computer system supports.

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 always remains powered off when power is applied.
AlwaysOnThe system always powers on when power is applied.
LastStateThe system returns to its last on or off power state when power is applied.

PowerState:

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.

stringDescription
ForceOffTurn off the unit immediately (non-graceful shutdown).
ForceOnTurn on the unit immediately.
ForceRestartShut down immediately and non-gracefully and restart the system.
GracefulRestartShut down gracefully and restart the system.
GracefulShutdownShut down gracefully and power off.
NmiGenerate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system.
OnTurn on the unit.
PowerCyclePower cycle the unit.
PushPowerButtonSimulate the pressing of the physical power button on this unit.

SystemType:

The type of computer system that this Resource represents.

stringDescription
Composed (v1.4+)A computer system constructed 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:

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 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 RFC4122-specified 35-character string format is xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, where each x represents a hexadecimal value from 0 to f.

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

WarningAction:

The action to perform when the watchdog timer is close to reaching its timeout value. This action typically occurs from three to ten seconds before to the timeout value, but the exact timing is dependent on the implementation.

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_8_0.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.id": "/redfish/v1/Systems/437XR1138R2"
}

Drive 1.7.0

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

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

URIs:

Assembly (v1.3+) {objectThe link to the assembly 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, in bytes, of the smallest addressable unit, or block.
CapableSpeedGbsnumber
(Gbit/s)
read-only (null)The speed, in gigabit per second (Gbit/s), at which this drive can communicate to a storage controller in ideal conditions.
CapacityBytesinteger
(bytes)
read-only (null)The size, in bytes, of this drive.
EncryptionAbilitystring
(enum)
read-only (null)The encryption ability of this drive.
For the possible property values, see EncryptionAbility in Property Details.
EncryptionStatusstring
(enum)
read-only (null)The status of the encryption of this drive.
For the possible property values, see EncryptionStatus in Property Details.
FailurePredictedbooleanread-only (null)An indication of whether this drive currently predicts a failure in the near future.
HotspareReplacementMode (v1.5+)string
(enum)
read-write (null)The replacement mode for the hot spare drive.
For the possible property values, see HotspareReplacementMode in Property Details.
HotspareTypestring
(enum)
read-only (null)The type of hot spare that this drive currently serves as.
For the possible property values, see HotspareType in Property Details.
Identifiers [ { } ]array (object)The durable names for the drive. Any additional identifiers for a Resource.
For property details, see Identifier.
IndicatorLEDstring
(enum)
read-write (null)The state of the indicator LED, that identifies the drive.
For the possible property values, see IndicatorLED in Property Details.
Links {objectThe links to other Resources that are related to this Resource.
      Chassis (v1.2+) {objectThe link to the chassis that 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 links 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 links to the PCIe functions that 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 links to the volumes that this drive either wholly or only partially contains.
            
      } ]
}
read-write
Location (deprecated v1.4) [ { } ]array (object)The location of the drive. The location of a Resource.
For property details, see Location. Deprecated in v1.4 and later. This property has been deprecated in favor of the singular property PhysicalLocation found in Drive.v1_4_0.
Manufacturerstringread-only (null)The manufacturer of this drive.
MediaTypestring
(enum)
read-only (null)The type of media contained in this drive.
For the possible property values, see MediaType in Property Details.
Modelstringread-only (null)The model number for the drive.
NegotiatedSpeedGbsnumber
(Gbit/s)
read-only (null)The speed, in gigabit per second (Gbit/s), at which this drive currently communicates to the storage controller.
Operations (v1.1+) [ {arrayThe operations currently running on the Drive.
      AssociatedTask {objectThe link 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.
      OperationNamestringread-only (null)The name of the operation.
      PercentageComplete
} ]
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.
For property details, see Location.
PredictedMediaLifeLeftPercentnumber
(%)
read-only (null)The percentage of reads and writes that are predicted to be available for the media.
Protocolstring
(enum)
read-only (null)The protocol that this drive currently uses to communicate to the storage controller.
For the possible property values, see Protocol in Property Details.
Revisionstringread-only (null)The revision of this drive. This is typically the firmware or 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)The SKU for this drive.
Status { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
StatusIndicatorstring
(enum)
read-write (null)The state of the status indicator, which communicates status information about this drive.
For the possible property values, see StatusIndicator in Property Details.
WriteCacheEnabled (v1.7+)booleanread-write (null)An indication of whether the drive write cache is enabled.

Actions

Reset

This action resets this drive.

URIs:

The following table shows the parameters for the action that 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.
For the possible property values, see ResetType in Property Details.

SecureErase

This action securely erases the contents of the drive.

URIs:

(This action takes no parameters.)

Property Details

EncryptionAbility:

The encryption ability 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 encryption 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 can unlock the drive automatically.
Unecrypted (deprecated v1.1)The drive is not currently encrypted. 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 in unencrypted form.

HotspareReplacementMode:

The replacement mode for the hot spare drive.

stringDescription
NonRevertibleThe hot spare drive that is commissioned due to a drive failure remains as a data drive and does not revert to a hot spare if the failed drive is replaced.
RevertibleThe hot spare drive that is commissioned due to a drive failure reverts to a hot spare after the failed drive is replaced and rebuilt.

HotspareType:

The type of hot spare that this drive currently serves as.

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

IndicatorLED:

The state of the indicator LED, that identifies 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 that this drive currently uses to communicate to the storage controller.

stringDescription
AHCIAdvanced Host Controller Interface (AHCI).
FCFibre Channel.
FCoEFibre Channel over Ethernet (FCoE).
FCPFibre Channel Protocol for SCSI.
FICONFIbre CONnection (FICON).
FTPFile Transfer Protocol (FTP).
HTTPHypertext Transport Protocol (HTTP).
HTTPSHypertext Transfer Protocol Secure (HTTPS).
I2CInter-Integrated Circuit Bus.
iSCSIInternet SCSI.
iWARPInternet Wide Area RDMA Protocol (iWARP).
NFSv3Network File System (NFS) version 3.
NFSv4Network File System (NFS) version 4.
NVMeNon-Volatile Memory Express (NVMe).
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.
SFTPSSH File Transfer Protocol (SFTP).
SMBServer Message Block (SMB). Also known as the Common Internet File System (CIFS).
UHCIUniversal Host Controller Interface (UHCI).
USBUniversal Serial Bus (USB).

ResetType:

The type of reset.

stringDescription
ForceOffTurn off the unit immediately (non-graceful shutdown).
ForceOnTurn on the unit immediately.
ForceRestartShut down immediately and non-gracefully and restart the system.
GracefulRestartShut down gracefully and restart the system.
GracefulShutdownShut down gracefully and power off.
NmiGenerate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system.
OnTurn on the unit.
PowerCyclePower cycle the unit.
PushPowerButtonSimulate the pressing of the physical power button on this unit.

StatusIndicator:

The state of the status indicator, which communicates status information about this drive.

stringDescription
FailThe drive has failed.
HotspareThe drive has been marked to automatically rebuild and replace a failed drive.
InACriticalArrayThe array to which this drive belongs has been degraded.
InAFailedArrayThe array to which this drive belongs has failed.
OKThe drive is OK.
PredictiveFailureAnalysisThe drive still works but is predicted to fail soon.
RebuildThe drive is being rebuilt.

Example Response

{
    "@odata.type": "#Drive.v1_7_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.id": "/redfish/v1/Systems/437XR1138R2/Storage/1/Drives/3D58ECBC375FD9F2"
}

Endpoint 1.3.2

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

The Endpoint schema contains the properties of an Endpoint Resource that 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-onlyThe link to the associated entity.
      EntityPciId {objectThe PCI ID of the connected entity.
            ClassCode (v1.2+)stringread-only (null)The Class Code, Subclass, 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.
For the possible property values, see EntityRole in Property Details.
      EntityTypestring
(enum)
read-only (null)The type of the connected entity.
For the possible property values, see EntityType in Property Details.
      Identifiers [ { } ]array (object)Identifiers for the remote entity. Any additional identifiers for a Resource.
For property details, see Identifier.
      Oem { }objectSee the Oem object definition in the Common properties section.
      PciClassCode (deprecated v1.2)stringread-only (null)The Class Code, Subclass, and Programming Interface code of this PCIe function. Deprecated in v1.2 and later. 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 in v1.2 and later. 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.
For the possible property values, see EndpointProtocol in Property Details.
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. Any additional identifiers for a Resource.
For property details, see Identifier.
IPTransportDetails (v1.1+) [ {arrayAn array of details for each IP transport supported by this endpoint. The array structure can model multiple IP addresses for this endpoint.
      IPv4Address { }objectThe IPv4 addresses assigned to the endpoint.
For property details, see IPv4Address.
      IPv6Address { }objectThe IPv6 addresses assigned to the endpoint.
For property details, see IPv6Address.
      Portnumberread-onlyThe UDP or TCP port number used by the endpoint.
      TransportProtocol
} ]
string
(enum)
read-onlyThe protocol used by the connection entity.
For the possible property values, see TransportProtocol in Property Details.
Links {objectThe links to other Resources that are related to this Resource.
      MutuallyExclusiveEndpoints [ {arrayAn array of links to the endpoints that may not be used in zones if this endpoint is in a zone.
            @odata.id
      } ]
stringread-onlyLink to another Endpoint resource.
      NetworkDeviceFunction (v1.1+) [ {arrayWhen NetworkDeviceFunction Resources are present, this array contains links to the network device functions 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 links to 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, 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 { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.

Property Details

EndpointProtocol:

The protocol supported by this endpoint.

stringDescription
AHCIAdvanced Host Controller Interface (AHCI).
FCFibre Channel.
FCoEFibre Channel over Ethernet (FCoE).
FCPFibre Channel Protocol for SCSI.
FICONFIbre CONnection (FICON).
FTPFile Transfer Protocol (FTP).
HTTPHypertext Transport Protocol (HTTP).
HTTPSHypertext Transfer Protocol Secure (HTTPS).
I2CInter-Integrated Circuit Bus.
iSCSIInternet SCSI.
iWARPInternet Wide Area RDMA Protocol (iWARP).
NFSv3Network File System (NFS) version 3.
NFSv4Network File System (NFS) version 4.
NVMeNon-Volatile Memory Express (NVMe).
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.
SFTPSSH File Transfer Protocol (SFTP).
SMBServer Message Block (SMB). Also known as the Common Internet File System (CIFS).
UHCIUniversal Host Controller Interface (UHCI).
USBUniversal Serial Bus (USB).

EntityRole:

The role of the connected entity.

stringDescription
BothThe entity can both send and receive commands, messages, and other requests to or from other entities on the fabric.
InitiatorThe entity sends commands, messages, or other types of requests to other entities on the fabric, but cannot receive commands from other entities.
TargetThe entity receives commands, messages, or other types of requests from other entities on the fabric, but cannot 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 an AccelerationFunction type.
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 type.
NetworkControllerThe entity is a network controller. The EntityLink property, if present, should contain an EthernetInterface type.
ProcessorThe entity is a processor device.
RootComplexThe entity is a PCI(e) root complex. The EntityLink property, if present, should be a ComputerSystem type.
StorageExpanderThe entity is a storage expander. The EntityLink property, if present, should be a Chassis type.
StorageInitiatorThe entity is a storage initator. The EntityLink property, if present, should be a StorageController type.
Volume (v1.1+)The entity is a volume. The EntityLink property, if present, should be a Volume type.

TransportProtocol:

The protocol used by the connection entity.

stringDescription
AHCIAdvanced Host Controller Interface (AHCI).
FCFibre Channel.
FCoEFibre Channel over Ethernet (FCoE).
FCPFibre Channel Protocol for SCSI.
FICONFIbre CONnection (FICON).
FTPFile Transfer Protocol (FTP).
HTTPHypertext Transport Protocol (HTTP).
HTTPSHypertext Transfer Protocol Secure (HTTPS).
I2CInter-Integrated Circuit Bus.
iSCSIInternet SCSI.
iWARPInternet Wide Area RDMA Protocol (iWARP).
NFSv3Network File System (NFS) version 3.
NFSv4Network File System (NFS) version 4.
NVMeNon-Volatile Memory Express (NVMe).
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.
SFTPSSH File Transfer Protocol (SFTP).
SMBServer Message Block (SMB). Also known as the Common Internet File System (CIFS).
UHCIUniversal Host Controller Interface (UHCI).
USBUniversal Serial Bus (USB).

Example Response

{
    "@odata.type": "#Endpoint.v1_3_2.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.id": "/redfish/v1/Fabrics/SAS/Endpoints/Drive1"
}

EthernetInterface 1.5.1

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)An indication of whether the speed and duplex are automatically negotiated and configured on this interface.
DHCPv4 (v1.4+) {objectDHCPv4 configuration for this interface.
      DHCPEnabledbooleanread-write (null)An indication of whether DHCP v4 is enabled on this Ethernet interface.
      FallbackAddress (v1.5+)string
(enum)
read-write (null)DHCPv4 fallback address method for this interface.
For the possible property values, see FallbackAddress in Property Details.
      UseDNSServersbooleanread-write (null)An indication of whether this interface uses DHCP v4-supplied DNS servers.
      UseDomainNamebooleanread-write (null)An indication of whether this interface uses a DHCP v4-supplied domain name.
      UseGatewaybooleanread-write (null)An indication of whether this interface uses a DHCP v4-supplied gateway.
      UseNTPServersbooleanread-write (null)An indication of whether the interface uses DHCP v4-supplied NTP servers.
      UseStaticRoutes
}
booleanread-write (null)An indication of whether the interface uses DHCP v4-supplied static routes.
DHCPv6 (v1.4+) {objectDHCPv6 configuration for this interface.
      OperatingModestring
(enum)
read-write (null)Determines the DHCPv6 operating mode for this interface.
For the possible property values, see OperatingMode in Property Details.
      UseDNSServersbooleanread-write (null)An indication of whether the interface uses DHCP v6-supplied DNS servers.
      UseDomainNamebooleanread-write (null)An indication of whether the interface uses a domain name supplied through DHCP v6 stateless mode.
      UseNTPServersbooleanread-write (null)An indication of whether the interface uses DHCP v6-supplied NTP servers.
      UseRapidCommit
}
booleanread-write (null)An indication of whether the interface uses DHCP v6 rapid commit mode for stateful mode address assignments. Do not enable this option in networks where more than one DHCP v6 server is configured to provide address assignments.
FQDNstringread-write (null)The complete, fully qualified domain name that DNS obtains for this interface.
FullDuplexbooleanread-write (null)An indication of whether full-duplex mode is enabled on the Ethernet connection for this interface.
HostNamestringread-write (null)The DNS host name, without any domain information.
InterfaceEnabledbooleanread-write (null)An indication of whether this interface is enabled.
IPv4Addresses [ { } ]array (object)The IPv4 addresses currently assigned to this interface. This type describes an IPv4 address.
For property details, see IPv4Address.
IPv4StaticAddresses (v1.4+) [ { } ]array (object) (null)The IPv4 static addresses assigned to this interface. This type describes an IPv4 address.
For property details, see IPv4Address.
IPv6Addresses [ { } ]array (object)An array of the currently assigned IPv6 addresses on this interface. This type describes an IPv6 address.
For property details, see IPv6Address.
IPv6AddressPolicyTable [ {arrayAn array that represents the RFC6724-defined address selection policy table.
      Labelintegerread-write (null)The IPv6 label, as defined in RFC6724, section 2.1.
      Precedenceintegerread-write (null)The IPv6 precedence, as defined in RFC6724, section 2.1.
      Prefix
} ]
stringread-write (null)The IPv6 address prefix, as defined in RFC6724, section 2.1.
IPv6DefaultGatewaystringread-only (null)The IPv6 default gateway address in use on this interface.
IPv6StaticAddresses [ { } ]array (object) (null)An array of the IPv6 static addresses to assign on this interface. This type represents a single IPv6 static address to be assigned on a network interface.
For property details, see IPv6StaticAddress.
IPv6StaticDefaultGateways (v1.4+) [ { } ]array (object) (null)The IPv6 static default gateways for this interface. This type represents a single IPv6 static address to be assigned on a network interface.
For property details, see IPv6GatewayStaticAddress.
Links (v1.1+) {objectThe links to other Resources that are related to this Resource.
      Chassis (v1.3+) {objectThe link to the chassis that 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 links 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+) {objectThe link 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, or port.
For the possible property values, see LinkStatus in Property Details.
MACAddressstringread-write (null)The currently configured MAC address of the interface, or logical port.
MaxIPv6StaticAddressesintegerread-only (null)The maximum number of static IPv6 addresses that can be configured on this interface.
MTUSizeintegerread-write (null)The currently configured maximum transmission unit (MTU), in bytes, on this interface.
NameServers [ ] array
(string)
read-onlyThe DNS servers in use on this interface.
PermanentMACAddressstringread-only (null)The permanent MAC address assigned to this interface, or port.
SpeedMbpsinteger
(Mbit/s)
read-write (null)The current speed, in Mbps, of this interface.
StatelessAddressAutoConfig (v1.4+) {objectStateless address autoconfiguration (SLAAC) parameters for this interface.
      IPv4AutoConfigEnabledbooleanread-write (null)An indication of whether IPv4 stateless address autoconfiguration (SLAAC) is enabled for this interface.
      IPv6AutoConfigEnabled
}
booleanread-write (null)An indication of whether IPv6 stateless address autoconfiguration (SLAAC) is enabled for this interface.
StaticNameServers (v1.4+) [ ] array
(string, null)
read-writeThe statically-defined set of DNS server IPv4 and IPv6 addresses.
Status { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
UefiDevicePathstringread-only (null)The UEFI device path for this interface.
VLAN {objectIf this network interface supports more than one VLAN, this property is absent. VLAN 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 {objectThe link to a collection of VLANs, which applies only if the interface supports more than one VLAN. If this property applies, the VLANEnabled and VLANId properties do not apply.
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, or port.

stringDescription
LinkDownNo link is detected on this interface, but the interface is connected.
LinkUpThe link is available for communication on this interface.
NoLinkNo link or connection is 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_5_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.id": "/redfish/v1/Systems/437XR1138R2/EthernetInterfaces/12446A3B0411"
}

Event 1.4.1

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 occur. This Resource contains data about events, including descriptions, severity, and a MessageId link 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. Because this is an array, more than one event can be sent simultaneously.
      Actions (v1.2+) { }objectThe available actions for this Resource.
      Context (deprecated v1.1)stringread-onlyA context can be supplied at subscription time. This property is the context value supplied by the subscriber. Deprecated in v1.1 and later. Events are triggered independently from subscriptions to those events. This property has been deprecated in favor of Context found at the root level of the object.
      EventGroupId (v1.3+)integerread-onlyThe identifier that correlates events with the same root cause. If 0, no other event is related to this event.
      EventIdstringread-onlyThe unique instance identifier of an event.
      EventTimestampstringread-onlyThe time the event occurred.
      EventType (deprecated v1.3)string
(enum)
read-only requiredThe type of event.
For the possible property values, see EventType in Property Details. Deprecated in v1.3 and later. This property has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and ResourceType properties and not on the EventType property.
      MemberIdstringread-only requiredThe identifier for the member within the collection.
      Messagestringread-onlyThe human-readable event message.
      MessageArgs [ ] array
(string)
read-onlyAn array of message arguments that are substituted for the arguments in the message when looked up in the Message Registry.
      MessageIdstringread-only requiredThe key used to find the message in a Message Registry.
      Oem { }objectSee the Oem object definition in the Common properties section.
      OriginOfCondition {objectThe Resource that originated the condition that caused the event to be generated.
            @odata.id
      }
stringread-onlyThe unique identifier for a resource.
      Severity
} ]
stringread-onlyThe severity of the event.

Property Details

EventType:

The type of event.

stringDescription
AlertA condition requires attention.
MetricReport (v1.3+)The Telemetry Service is sending a metric report.
Other (v1.4+)Because EventType is deprecated as of Redfish Specification v1.6, the event is based on a registry or Resource but not an EventType.
ResourceAddedA Resource has been added.
ResourceRemovedA Resource has been removed.
ResourceUpdatedA Resource has been updated.
StatusChangeThe status of a Resource has changed.

EventDestination 1.6.0

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

The EventDestination schema defines the target of an event subscription, including the event types 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.
DeliveryRetryPolicy (v1.6+)string
(enum)
read-write (null)This property shall contain the subscription delivery retry policy for events, where the subscription type is RedfishEvent.
For the possible property values, see DeliveryRetryPolicy in Property Details.
Destinationstringread-only required on createThe URI of the destination event receiver.
EventFormatType (v1.4+)string
(enum)
read-only (null)The content types of the message that are sent to the EventDestination.
For the possible property values, see EventFormatType in Property Details.
EventTypes (deprecated v1.5) [ ] array (string
(enum))
read-onlyThe types of events that are sent to the destination.
For the possible property values, see EventTypes in Property Details. Deprecated in v1.5 and later. This property has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and ResourceType properties and not on the EventType property. Use EventFormatType to create subscriptions for Metric Reports. If the subscription does not include this property, the service shall use a single element with a default of `Other`.
HttpHeaders [ {arrayAn array of settings for HTTP headers, such as authorization information. This array is null or an empty array in responses. An empty array is the preferred return value on read operations.
      (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-onlyThe list of MessageIds that the service sends. If this property is absent or the array is empty, events with any MessageId are sent to the subscriber.
MetricReportDefinitions (v1.6+) [ {arrayA list of metric report definitions for which the service only sends related metric reports. If this property is absent or the array is empty, metric reports that originate from any metric report definition are sent to the subscriber.
      @odata.id
} ]
stringread-onlyLink to a MetricReportDefinition resource. See the Links section and the MetricReportDefinition schema for details.
OriginResources (v1.1+) [ {arrayThe array of Resources for which the service sends only related events. If this property is absent or the array is empty, the service sends the events that originate from any Resource 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.
For the possible property values, see Protocol in Property Details.
RegistryPrefixes (v1.4+) [ ] array
(string, null)
read-onlyThe list of the prefixes for the Message Registries that contain the MessageIds that are sent to this event destination.
ResourceTypes (v1.4+) [ ] array
(string, null)
read-onlyThe list of Resource Type values (Schema names) that correspond to the OriginOfCondition. The version and full namespace should not be specified.
Status (v1.6+) { }objectThis property shall contain the status of the subscription.
For property details, see Status.
SubordinateResources (v1.4+)booleanread-only (null)An indication of whether the subscription is for events in the OriginResources array and its subordinate Resources. If true and the OriginResources array is specified, the subscription is for events in the OriginResources array and its subordinate Resources. Note that Resources associated through the Links section are not considered subordinate. If false and the OriginResources array is specified, the subscription shall be for events in the OriginResources array only. If the OriginResources array is not present, this property shall have no relevance.
SubscriptionType (v1.3+)string
(enum)
read-only required (null)The subscription type for events.
For the possible property values, see SubscriptionType in Property Details.

Actions

ResumeSubscription

This action resumes a suspended event subscription.

URIs:

(This action takes no parameters.)

Property Details

DeliveryRetryPolicy:

This property shall contain the subscription delivery retry policy for events, where the subscription type is RedfishEvent.

stringDescription
RetryForeverThe subscription is not suspended or terminated, and attempts at delivery of future events shall continue even after the after the maximum number of retries is reached.
SuspendRetriesThe subscription is suspended after the maximum number of retries is reached.
TerminateAfterRetriesThe subscription is terminated after the maximum number of retries is reached.

EventFormatType:

The content types of the message that are sent to the EventDestination.

stringDescription
EventThe subscription destination receives JSON bodies of the Resource of type Event.
MetricReportThe subscription destination receives JSON bodies of the Resource of type MetricReport.

EventTypes:

The types of events that are sent to the destination.

stringDescription
AlertA condition requires attention.
MetricReportThe Telemetry Service is sending a metric report.
OtherBecause EventType is deprecated as of Redfish Specification v1.6, the event is based on a registry or Resource but not an EventType.
ResourceAddedA Resource has been added.
ResourceRemovedA Resource has been removed.
ResourceUpdatedA Resource has been updated.
StatusChangeThe status of a Resource has changed.

Protocol:

The protocol type of the event connection.

stringDescription
RedfishThe destination follows the Redfish Specification for event notifications.

SubscriptionType:

The subscription type for events.

stringDescription
RedfishEventThe subscription follows the Redfish Specification for event notifications. To send an event notification, a service sends 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_6_0.EventDestination",
    "Id": "1",
    "Name": "EventSubscription 1",
    "Destination": "http://www.dnsname.com/Destination1",
    "SubscriptionType": "RedfishEvent",
    "DeliveryRetryPolicy": "TerminateAfterRetries",
    "Status": {
        "State": "Enabled"
    },
    "Actions": {
        "#EventDestination.ResumeSubscription": {
            "target": "/redfish/v1/EventService/Subscriptions/1/Actions/EventDestination.ResumeSubscription"
        }
    },
    "EventTypes": [
        "Alert"
    ],
    "Context": "WebUser3",
    "Protocol": "Redfish",
    "@odata.id": "/redfish/v1/EventService/Subscriptions/1"
}

EventService 1.4.0

v1.4v1.3v1.2v1.1v1.0
2019.22019.12018.22018.11.0

The EventService schema contains properties for managing event subcriptions and generates the events sent to subscribers. The Resource has links to the actual collection of subscriptions, which are called event destinations.

URIs:

DeliveryRetryAttemptsintegerread-writeThe number of times that the POST of an event is retried before the subscription terminates. This retry occurs at the service level, which means that the HTTP POST to the event destination fails with an HTTP 4XX or 5XX status code or an HTTP timeout occurs this many times before the event destination subscription terminates.
DeliveryRetryIntervalSecondsinteger
(seconds)
read-writeThe interval, in seconds, between retry attempts for sending any event.
EventFormatTypes (v1.2+) [ ] array (string
(enum))
read-only (null)The content types of the message that this service can send to the event destination.
For the possible property values, see EventFormatTypes in Property Details.
EventTypesForSubscription (deprecated v1.3) [ ] array (string
(enum))
read-onlyThe types of events to which a client can subscribe.
For the possible property values, see EventTypesForSubscription in Property Details. Deprecated in v1.3 and later. This property has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and ResourceType properties and not on the EventType property.
RegistryPrefixes (v1.2+) [ ] array
(string, null)
read-onlyThe 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-onlyThe list of @odata.type values, or Schema names, that can be specified in the ResourceTypes array in a subscription. If this property is absent or contains an empty array, the service does not support Resource type-based subscriptions.
ServerSentEventUri (v1.1+)stringread-onlyThe link to a URI for receiving Server-Sent Event representations for the events that this service generates.
ServiceEnabledbooleanread-write (null)An indication of whether this service is enabled.
SSEFilterPropertiesSupported (v1.2+) {objectThe set of properties that are supported in the $filter query parameter for the ServerSentEventUri.
      EventFormatTypebooleanread-onlyAn indication of whether the service supports the EventFormatType property in the $filter query parameter.
      EventType (deprecated v1.3)booleanread-onlyAn indication of whether the service supports the EventType property in the $filter query parameter. Deprecated in v1.3 and later. This property has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and ResourceType properties and not on the EventType property.
      MessageIdbooleanread-onlyAn indication of whether the service supports the MessageId property in the $filter query parameter.
      MetricReportDefinitionbooleanread-onlyAn indication of whether the service supports the MetricReportDefinition property in the $filter query parameter.
      OriginResourcebooleanread-onlyAn indication of whether the service supports the OriginResource property in the $filter query parameter.
      RegistryPrefixbooleanread-onlyAn indication of whether the service supports the RegistryPrefix property in the $filter query parameter.
      ResourceTypebooleanread-onlyAn indication of whether the service supports the ResourceType property in the $filter query parameter.
      SubordinateResources (v1.4+)
}
booleanread-onlyAn indication of whether the service supports the SubordinateResources property in the $filter query parameter.
Status { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
SubordinateResourcesSupported (v1.2+)booleanread-only (null)An indication of whether the service supports the SubordinateResource property on both event subscriptions and generated events.
Subscriptions {objectThe link 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 generates a test event.

URIs:

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

{
      EventGroupId (v1.3+)integerread-writeThe group ID for the event.
      EventIdstringread-writeThe ID for the event to add.
      EventTimestampstringread-writeThe date and time stamp for the event to add.
      EventType (deprecated v1.3)string
(enum)
read-writeThe type for the event to add.
For the possible property values, see EventType in Property Details. Deprecated in v1.3 and later. This parameter has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and ResourceType properties and not on the EventType property.
      Messagestringread-writeThe human-readable message for the event to add.
      MessageArgs [ ] array
(string)
read-writeAn array of message arguments for the event to add.
      MessageIdstringread-write requiredThe MessageId for the event to add.
      OriginOfConditionstringread-writeThe URL in the OriginOfCondition property of the event to add. It is not a reference object.
      Severity
}
stringread-writeThe severity for the event to add.

Property Details

EventFormatTypes:

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

stringDescription
EventThe subscription destination receives JSON bodies of the Resource of type Event.
MetricReportThe subscription destination receives JSON bodies of the Resource of type MetricReport.

EventType:

The type for the event to add.

stringDescription
AlertA condition requires attention.
MetricReportThe Telemetry Service is sending a metric report.
OtherBecause EventType is deprecated as of Redfish Specification v1.6, the event is based on a registry or Resource but not an EventType.
ResourceAddedA Resource has been added.
ResourceRemovedA Resource has been removed.
ResourceUpdatedA Resource has been updated.
StatusChangeThe status of a Resource has changed.

EventTypesForSubscription:

The types of events to which a client can subscribe.

stringDescription
AlertA condition requires attention.
MetricReportThe Telemetry Service is sending a metric report.
OtherBecause EventType is deprecated as of Redfish Specification v1.6, the event is based on a registry or Resource but not an EventType.
ResourceAddedA Resource has been added.
ResourceRemovedA Resource has been removed.
ResourceUpdatedA Resource has been updated.
StatusChangeThe status of a Resource has changed.

Example Response

{
    "@odata.type": "#EventService.v1_4_0.EventService",
    "Id": "EventService",
    "Name": "Event Service",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "ServiceEnabled": true,
    "DeliveryRetryAttempts": 3,
    "DeliveryRetryIntervalSeconds": 60,
    "EventTypesForSubscription": [
        "StatusChange",
        "ResourceUpdated",
        "ResourceAdded",
        "ResourceRemoved",
        "Alert"
    ],
    "ServerSentEventUri": "/redfish/v1/EventService/SSE",
    "SSEFilterPropertiesSupported": {
        "EventType": true,
        "MetricReportDefinition": false,
        "RegistryPrefix": true,
        "ResourceType": true,
        "EventFormatType": false,
        "MessageId": true,
        "OriginResource": true,
        "SubordinateResources": true
    },
    "Subscriptions": {
        "@odata.id": "/redfish/v1/EventService/Subscriptions"
    },
    "Actions": {
        "#EventService.SubmitTestEvent": {
            "target": "/redfish/v1/EventService/Actions/EventService.SubmitTestEvent",
            "@Redfish.ActionInfo": "/redfish/v1/EventService/SubmitTestEventActionInfo"
        },
        "Oem": {}
    },
    "Oem": {},
    "@odata.id": "/redfish/v1/EventService"
}

ExternalAccountProvider 1.1.2

v1.1v1.0
2018.32018.1

The remote service that provides accounts for this manager to use for authentication.

URIs:

AccountProviderTypestring
(enum)
read-only required on create (null)The type of external account provider to which this Service connects.
For the possible property values, see AccountProviderType in Property Details.
Authentication {objectThe authentication information for the external account provider.
      AuthenticationTypestring
(enum)
read-write (null)The type of authentication used to connect to the external account provider.
For the possible property values, see AuthenticationType in Property Details.
      KerberosKeytabstringread-write (null)The Base64-encoded version of the Kerberos keytab for this Service. A PATCH or PUT operation writes the keytab. This property is null in responses.
      Oem { }objectSee the Oem object definition in the Common properties section.
      Passwordstringread-write (null)The password for this Service. A PATCH or PUT request writes the password. This property is null in responses.
      Tokenstringread-write (null)The token for this Service. A PATCH or PUT operation writes the token. This property is null in responses.
      Username
}
stringread-writeThe user name for the Service.
Certificates (v1.1+) {objectThe link to a collection of certificates that the external account provider uses.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of Certificate. See the Certificate schema for details.
LDAPService {objectThe additional mapping information needed to parse a generic LDAP service.
      Oem { }objectSee the Oem object definition in the Common properties section.
      SearchSettings {objectThe required settings to search an external LDAP service.
            BaseDistinguishedNames [ ] array
(string, null)
read-writeThe base distinguished names to search an external LDAP service.
            GroupNameAttributestringread-write (null)The attribute name that contains the LDAP group name entry.
            GroupsAttributestringread-write (null)The attribute name that contains the groups for a user on the LDAP user entry.
            UsernameAttribute
      }
}
stringread-write (null)The attribute name that contains the LDAP user name entry.
Links {objectThe links to other Resources that are related to this Resource.
      Oem { }
}
objectSee the Oem object definition in the Common properties section.
RemoteRoleMapping [ {arrayThe mapping rules to convert the external account providers account information to the local Redfish Role.
      LocalRolestringread-write (null)The name of the local Redfish Role to which to map the remote user or group.
      Oem { }objectSee the Oem object definition in the Common properties section.
      RemoteGroupstringread-write (null)The name of the remote group, or the remote role in the case of a Redfish Service, that maps to the local Redfish Role to which this entity links.
      RemoteUser
} ]
stringread-write (null)The name of the remote user that maps to the local Redfish Role to which this entity links.
ServiceAddresses [ ] array
(string, null)
read-writeThe addresses of the user account providers to which this external account provider links. The format of this field depends on the type of external account provider.
ServiceEnabledbooleanread-write (null)An indication of whether this service is enabled.

Property Details

AccountProviderType:

The type of external account provider to which this Service connects.

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

AuthenticationType:

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.
UsernameAndPasswordA user name and password combination.

Example Response

{
    "@odata.type": "#ExternalAccountProvider.v1_1_2.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.id": "/redfish/v1/AccountService/ExternalAccountProviders/ExternalRedfishService"
}

Fabric 1.0.6

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 {objectThe collection of links to the endpoints that this fabric contains.
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.
For the possible property values, see FabricType in Property Details.
Links {objectThe links to other Resources that are related to this Resource.
      Oem { }
}
objectSee the Oem object definition in the Common properties section.
MaxZonesintegerread-only (null)The maximum number of zones the switch can currently configure.
Status { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
Switches {objectThe collection of links to the switches that this fabric contains.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of Switch. See the Switch schema for details.
Zones {objectThe collection of links to the zones that this fabric contains.
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 (AHCI).
FCFibre Channel.
FCoEFibre Channel over Ethernet (FCoE).
FCPFibre Channel Protocol for SCSI.
FICONFIbre CONnection (FICON).
FTPFile Transfer Protocol (FTP).
HTTPHypertext Transport Protocol (HTTP).
HTTPSHypertext Transfer Protocol Secure (HTTPS).
I2CInter-Integrated Circuit Bus.
iSCSIInternet SCSI.
iWARPInternet Wide Area RDMA Protocol (iWARP).
NFSv3Network File System (NFS) version 3.
NFSv4Network File System (NFS) version 4.
NVMeNon-Volatile Memory Express (NVMe).
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.
SFTPSSH File Transfer Protocol (SFTP).
SMBServer Message Block (SMB). Also known as the Common Internet File System (CIFS).
UHCIUniversal Host Controller Interface (UHCI).
USBUniversal Serial Bus (USB).

Example Response

{
    "@odata.type": "#Fabric.v1_0_6.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.id": "/redfish/v1/Fabrics/SAS"
}

HostInterface 1.2.2

v1.2v1.1v1.0
2018.22017.12016.3

The properties associated with a Host Interface. A Host Interface is a connection between host software and a Redfish Service.

URIs:

AuthenticationModes [ ] array (string
(enum))
read-writeThe authentication modes available on this interface.
For the possible property values, see AuthenticationModes in Property Details.
AuthNoneRoleId (v1.2+)stringread-writeThe role when no authentication on this interface is used.
ExternallyAccessiblebooleanread-only (null)An indication of whether external entities can access this interface. External entities are non-host entities. For example, if the host and manager are connected through a switch and the switch also exposes an external port on the system, external clients can also use the interface, and this property value is true.
FirmwareAuthEnabledbooleanread-write (null)An indication of whether this firmware authentication is enabled for this interface.
FirmwareAuthRoleIdstringread-writeThe Role used for firmware authentication on this interface.
HostEthernetInterfaces {objectA 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)The Host Interface type for this interface.
For the possible property values, see HostInterfaceType in Property Details.
InterfaceEnabledbooleanread-write (null)An indication of whether this interface is enabled.
KernelAuthEnabledbooleanread-write (null)An indication of whether this kernel authentication is enabled for this interface.
KernelAuthRoleIdstringread-writeThe Role used for kernel authentication on this interface.
Links {objectThe links to other Resources that are related to this Resource.
      AuthNoneRole (v1.2+) {objectThe link to the Redfish 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 links 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 {objectThe link to the Redfish 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 {objectThe link to the Redfish Role 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 {objectA 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 {objectA link to the network services and their settings that the manager controls. In this property, clients find configuration options for the network and 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 { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.

Property Details

AuthenticationModes:

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:

The Host Interface type for this interface.

stringDescription
NetworkHostInterfaceThis interface is a Network Host Interface.

Example Response

{
    "@odata.id": "/redfish/v1/Managers/BMC/HostInterfaces/1",
    "@odata.type": "#HostInterface.v1_2_2.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.3

v1.0
2018.2

The Job schema contains information about a job that a a Redfish Job Service schedules or executes. Clients create jobs to describe a series of operations that occur at periodic intervals.

URIs:

CreatedBystringread-onlyThe person or program that created this job entry.
EndTimestringread-onlyThe date and time when the job was completed.
HidePayloadbooleanread-onlyAn indication of whether the contents of the payload should be hidden from view after the job has been created. If true, responses do not return the payload. If false, responses return the payload. If this property is not present when the job is created, the default is false.
JobStatestring
(enum)
read-writeThe state of the job.
For the possible property values, see JobState in Property Details.
JobStatusstring
(enum)
read-onlyThe status of the job.
For the possible property values, see JobStatus in Property Details.
MaxExecutionTimestringread-write (null)The maximum amount of time the job is allowed to execute.
Messages [ { } ]array (object)An array of messages associated with the job. The message that the Redfish Service returns.
For property details, see Message.
Payload {objectThe HTTP and JSON payload details for this job.
      HttpHeaders [ ] array
(string)
read-onlyAn array of HTTP headers in this job.
      HttpOperationstringread-onlyThe HTTP operation that executes this job.
      JsonBodystringread-onlyThe JSON payload to use in the execution of this job.
      TargetUri
}
stringread-onlyThe link to the target for this job.
PercentCompleteinteger
(%)
read-only (null)The completion percentage of this job.
Schedule { }objectThe schedule settings for this job.
For property details, see Schedule.
StartTimestringread-onlyThe date and time when the job was started or is scheduled to start.
StepOrder [ ] array
(string)
read-onlyThe serialized execution order of the job Steps.
Steps {objectThe 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 was 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 requires immediate attention.
OKNormal.
WarningA condition requires attention.

Example Response

{
    "@odata.type": "#Job.v1_0_3.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.id": "/redfish/v1/JobService/Jobs/RebootRack"
}

JobService 1.0.2

v1.0
2018.2

The Redfish Job Service enables the scheduling and execution of operations, represents the properties for the Job Service itself, and has links to the actual Resource Collection of Jobs.

URIs:

DateTimestringread-only (null)The current date and time, with UTC offset, setting that the Job Service uses.
Jobs {objectThe links 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 {objectThe link to a Log Service that the Job Service uses. This service may be a dedicated Log Service or a pointer a Log Service under another entity, such as Manager.
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 {objectThe supported capabilities of this Job Service implementation.
      MaxJobsintegerread-only (null)The maximum number of jobs supported.
      MaxStepsintegerread-only (null)The maximum number of job steps supported.
      Scheduling
}
booleanread-only (null)An indication of whether scheduling of jobs is supported.
ServiceEnabledbooleanread-write (null)An indication of whether this service is enabled.
Status { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.

Example Response

{
    "@odata.type": "#JobService.v1_0_2.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.4

v1.1v1.0
2017.11.0

The JsonSchemaFile schema contains the properties that describe the locations, as URIs, of a Redfish Schema definition that a Redfish Service implements or references.

URIs:

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

Example Response

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

LogEntry 1.4.3

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

The LogEntry schema defines the record format for a log. It is designed for Redfish event logs, OEM-specific log formats, and the IPMI System Event Log (SEL). The EntryType field indicates the type of log and the Resource includes several additional properties dependent on the EntryType.

URIs:

Createdstringread-onlyThe date and time when the log entry was created.
EntryCodestring
(enum)
read-only (null)The entry code for the log entry if the entry type is SEL.
For the possible property values, see EntryCode in Property Details.
EntryTypestring
(enum)
read-only requiredThe type of log entry.
For the possible property values, see EntryType in Property Details.
EventGroupId (v1.4+)integerread-only (null)An identifier that correlates events with the same cause.
EventId (v1.1+)stringread-onlyThe unique instance identifier for an event.
EventTimestamp (v1.1+)stringread-onlyThe date and time when the event occurred.
EventType (v1.1+, deprecated v1.4)string
(enum)
read-onlyThe type of event recorded in this log.
For the possible property values, see EventType in Property Details. Deprecated in v1.4 and later. This property has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and ResourceType properties and not on the EventType property.
Links {objectThe links to other Resources that are related to this Resource.
      Oem { }objectSee the Oem object definition in the Common properties section.
      OriginOfCondition {objectThe URI of the Resource that caused the log entry.
            @odata.id
      }
}
stringread-onlyThe unique identifier for a resource.
Messagestringread-only (null)The message of the log entry. This property decodes from the entry type. If the entry type is Event, this property contains a message. If the entry type is SEL, this property contains an SEL-specific message. Otherwise, this property contains an OEM-specific log entry. In most cases, this property contains the actual log entry.
MessageArgs [ ] array
(string)
read-onlyThe arguments for the message.
MessageIdstringread-onlyThe MessageId, event data, or OEM-specific information. This property decodes from the entry type. If the entry type is Event, this property contains a Redfish Specification-defined MessageId. If the entry type is SEL, this property contains the Event Data. Otherwise, this property contains OEM-specific information.
OemLogEntryCode (v1.3+)stringread-only (null)The OEM-specific entry code, if the LogEntryCode type is OEM.
OemRecordFormatstringread-only (null)The OEM-specific format of the entry. If the entry type is Oem, this property contains more information about the record format from the OEM.
OemSensorType (v1.3+)stringread-only (null)The OEM-specific sensor type if the sensor type is OEM.
SensorNumberintegerread-only (null)The sensor number, the count of events, or OEM-specific information. This property value is decoded from the entry type. If the entry type is SEL, this property contains the sensor number. If the entry type is Event, this property contains the count of events. Otherwise, this property contains OEM-specific information.
SensorTypestring
(enum)
read-only (null)The sensor type to which the log entry pertains if the entry type is SEL.
For the possible property values, see SensorType in Property Details.
Severitystring
(enum)
read-only (null)The severity of the log entry.
For the possible property values, see Severity in Property Details.

Property Details

EntryCode:

The entry code for the log entry if the entry type is `SEL`.

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 present.
Device Removed / Device AbsentA device has been removed or is 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 resources to maintain normal operation.
Non-redundant:Sufficient Resources from Insufficient ResourcesUnit has regained 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:

The type of log entry.

stringDescription
EventA Redfish-defined message.
OemAn entry in an OEM-defined format.
SELA legacy IPMI System Event Log (SEL) entry.

EventType:

The type of event recorded in this log.

stringDescription
AlertA condition requires attention.
MetricReportThe Telemetry Service is sending a metric report.
OtherBecause EventType is deprecated as of Redfish Specification v1.6, the event is based on a registry or Resource but not an EventType.
ResourceAddedA Resource has been added.
ResourceRemovedA Resource has been removed.
ResourceUpdatedA Resource has been updated.
StatusChangeThe status of a Resource has changed.

SensorType:

The sensor type to which the log entry pertains if the entry type is `SEL`.

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 device type.
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 another 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:

The severity of the log entry.

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

Example Response

{
    "@odata.type": "#LogEntry.v1_4_3.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.id": "/redfish/v1/Systems/437XR1138R2/LogServices/Log1/Entries/1"
}

LogService 1.1.3

v1.1v1.0
2017.31.0

The LogService schema contains properties for monitoring and configuring a Log Service.

URIs:

DateTimestringread-write (null)The current date and time, with UTC offset, that the Log Service uses to set or read time.
DateTimeLocalOffsetstringread-write (null)The UTC offset that the current DateTime property value contains in the +HH:MM format.
Entries {objectThe link 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 log entries.
For the possible property values, see LogEntryType in Property Details.
MaxNumberOfRecordsintegerread-onlyThe maximum number of log entries that this service can have.
OverWritePolicystring
(enum)
read-onlyThe overwrite policy for this service that takes place when the log is full.
For the possible property values, see OverWritePolicy in Property Details.
ServiceEnabledbooleanread-write (null)An indication of whether this service is enabled.
Status { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.

Actions

ClearLog

The action to clear the log for this Log Service.

URIs:

(This action takes no parameters.)

Property Details

LogEntryType:

The format of the log entries.

stringDescription
EventThe log contains Redfish-defined messages.
MultipleThe log contains multiple log entry types and, therefore, the Log Service cannot guarantee a single entry type.
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 are discarded.
UnknownThe overwrite policy is not known or is undefined.
WrapsWhenFullWhen full, new entries to the log overwrite earlier entries.

Example Response

{
    "@odata.type": "#LogService.v1_1_3.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.id": "/redfish/v1/Managers/1/LogServices/Log1"
}

Manager 1.6.0

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

In Redfish, a manager is a systems management entity that may implement or provide access to a Redfish Service. Examples of managers are BMCs, enclosure managers, management controllers, and other subsystems that are assigned managability functions. An implementation may have multiple managers, which may or may not be directly accessible through a Redfish-defined interface.

URIs:

AutoDSTEnabled (v1.4+)booleanread-writeAn indication of whether the manager is configured for automatic Daylight Saving Time (DST) adjustment.
CommandShell {objectThe command shell service that this manager provides.
      ConnectTypesSupported [ ] array (string
(enum))
read-onlyThis property enumerates the command shell connection types that the implementation allows.
For the possible property values, see ConnectTypesSupported in Property Details.
      MaxConcurrentSessionsintegerread-onlyThe maximum number of service sessions, regardless of protocol, that this manager can support.
      ServiceEnabled
}
booleanread-writeAn indication of whether the service is enabled for this manager.
DateTimestringread-write (null)The current date and time with UTC offset that the manager uses to set or read time.
DateTimeLocalOffsetstringread-write (null)The time offset from UTC that the DateTime property is in +HH:MM format.
EthernetInterfaces {objectThe link to a collection of NICs that this manager uses for network communication.
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 information about the graphical console (KVM-IP) service of this manager.
      ConnectTypesSupported [ ] array (string
(enum))
read-onlyThis property enumerates the graphical console connection types that the implementation allows.
For the possible property values, see ConnectTypesSupported in Property Details.
      MaxConcurrentSessionsintegerread-onlyThe maximum number of service sessions, regardless of protocol, that this manager can support.
      ServiceEnabled
}
booleanread-writeAn indication of whether the service is enabled for this manager.
HostInterfaces (v1.3+) {objectThe link to a collection of Host Interfaces that this manager uses for local host communication. Clients can find Host Interface configuration options and settings in this navigation property.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of HostInterface. See the HostInterface schema for details.
Links {objectThe links to other Resources that are related to this Resource.
      ActiveSoftwareImage (v1.6+) {objectThe link to the SoftwareInventory Resource that represents the active firmware image for this manager.
See the SoftwareInventory schema for details on this property.
            @odata.id
      }
stringread-onlyLink to a SoftwareInventory resource. See the Links section and the SoftwareInventory schema for details.
      ManagerForChassis [ {arrayAn array of links to the chassis this manager controls.
            @odata.id
      } ]
stringread-onlyLink to a Chassis resource. See the Links section and the Chassis schema for details.
      ManagerForServers [ {arrayAn array of links to the systems that this manager controls.
            @odata.id
      } ]
stringread-onlyLink to a ComputerSystem resource. See the Links section and the ComputerSystem schema for details.
      ManagerForSwitches (v1.4+) [ {arrayAn array of links to the switches that this manager controls.
            @odata.id
      } ]
stringread-onlyLink to a Switch resource. See the Links section and the Switch schema for details.
      ManagerInChassis (v1.1+) {objectThe link to the chassis where this manager is located.
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.
      SoftwareImages (v1.6+) [ {arrayThe images that are associated with this manager.
            @odata.id
      } ]
}
stringread-onlyLink to a SoftwareInventory resource. See the Links section and the SoftwareInventory schema for details.
LogServices {objectThe link to a collection of logs that the manager uses.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of LogService. See the LogService schema for details.
ManagerTypestring
(enum)
read-onlyThe type of manager that this Resource represents.
For the possible property values, see ManagerType in Property Details.
Modelstringread-only (null)The model information of this manager, as defined by the manufacturer.
NetworkProtocol {objectThe link to the network services and their settings that the manager controls.
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.
PowerState (v1.2+)string
(enum)
read-only (null)The current power state of the manager.
For the possible property values, see PowerState in Property Details.
Redundancy [ {arrayThe redundancy information for the managers of this system.
      @odata.id
} ]
stringread-onlyThe unique identifier for a resource.
RemoteAccountService (v1.5+) {objectThe link to the AccountService Resource for the remote manager that this Resource represents.
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)The URI of the Redfish Service Root for the remote manager that this Resource represents.
SerialConsole {objectThe serial console service that this manager provides.
      ConnectTypesSupported [ ] array (string
(enum))
read-onlyThis property enumerates the serial console connection types that the implementation allows.
For the possible property values, see ConnectTypesSupported in Property Details.
      MaxConcurrentSessionsintegerread-onlyThe maximum number of service sessions, regardless of protocol, that this manager can support.
      ServiceEnabled
}
booleanread-writeAn indication of whether the service is enabled for this manager.
SerialInterfaces {objectThe link to a collection of serial interfaces that this manager uses for serial and console communication.
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 that is hosted by this manager.
Status { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
UUIDstringread-only (null)The UUID for this manager.
VirtualMedia {objectThe link 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 that are included in the POST body to the URI shown in the "target" property of the Action.

{
      NewManager {object requiredThe manager to which to fail over.
            @odata.id
      }
}
stringread-onlyLink to another Manager resource.

ModifyRedundancySet

The ModifyRedundancySet operation adds members to or removes members from a redundant group of managers.

URIs:

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

{
      Add [ {arrayAn array of managers to add to the redundancy set.
            @odata.id
      } ]
stringread-onlyLink to another Manager resource.
      Remove [ {arrayAn array of managers to remove from the redundancy set.
            @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 that 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.
For the possible property values, see ResetType in Property Details.

Property Details

ConnectTypesSupported:

This property enumerates the serial console connection types that the implementation allows.

stringDescription
IPMIThe controller supports a serial console connection through the IPMI Serial Over LAN (SOL) protocol.
OemThe controller supports a serial console connection through an OEM-specific protocol.
SSHThe controller supports a serial console connection through the SSH protocol.
TelnetThe controller supports a serial console connection through the Telnet protocol.

ManagerType:

The type of manager that this Resource represents.

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

PowerState:

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:

The type of reset.

stringDescription
ForceOffTurn off the unit immediately (non-graceful shutdown).
ForceOnTurn on the unit immediately.
ForceRestartShut down immediately and non-gracefully and restart the system.
GracefulRestartShut down gracefully and restart the system.
GracefulShutdownShut down gracefully and power off.
NmiGenerate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system.
OnTurn on the unit.
PowerCyclePower cycle the unit.
PushPowerButtonSimulate the pressing of the physical power button on this unit.

Example Response

{
    "@odata.type": "#Manager.v1_6_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.id": "/redfish/v1/Managers/BMC"
}

ManagerAccount 1.3.1

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+) {objectThe link 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-writeAn indication of whether an account is enabled. An administrator can disable it without deleting the user information. If true, the account is enabled and the user can log in. If false, the account is disabled and, in the future, the user cannot log in. This property overrides the Locked property.
Links {objectThe links to other Resources that are related to this Resource.
      Oem { }objectSee the Oem object definition in the Common properties section.
      Role {objectThe link to the Redfish Role that defines the privileges for this account.
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-writeAn indication of whether the Account Service automatically locked the account because the lockout threshold was exceeded. To manually unlock the account before the lockout duration period, an administrator can change the property to false to clear the lockout condition.
Passwordstringread-write required on create (null)The password. Use this property with a PATCH or PUT to write the password for the account. This property is null in responses.
PasswordChangeRequired (v1.3+)booleanread-write (null)An indication of whether the service requires that the password for this account be changed before further access to the account is allowed.
RoleIdstringread-write required on createThe Role for this account.
UserNamestringread-write required on createThe user name for the account.

Example Response

{
    "@odata.type": "#ManagerAccount.v1_3_1.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.id": "/redfish/v1/AccountService/Accounts/1"
}

ManagerNetworkProtocol 1.4.2

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

The network service settings for the manager.

URIs:

DHCP (v1.1+) {objectThe settings for this manager's DHCPv4 protocol support.
      Portintegerread-write (null)The protocol port.
      ProtocolEnabled
}
booleanread-write (null)An indication of whether the protocol is enabled.
DHCPv6 (v1.3+) {objectThe settings for this manager's DHCPv6 protocol support.
      Portintegerread-write (null)The protocol port.
      ProtocolEnabled
}
booleanread-write (null)An indication of whether the protocol is enabled.
FQDNstringread-only (null)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 {objectThe settings for this manager's HTTP protocol support.
      Portintegerread-write (null)The protocol port.
      ProtocolEnabled
}
booleanread-write (null)An indication of whether the protocol is enabled.
HTTPS {objectThe settings for this manager's HTTPS protocol support.
      Certificates (v1.4+) {objectThe link 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.
      Portintegerread-write (null)The protocol port.
      ProtocolEnabled
}
booleanread-write (null)An indication of whether the protocol is enabled.
IPMI {objectThe settings for this manager's IPMI-over-LAN protocol support.
      Portintegerread-write (null)The protocol port.
      ProtocolEnabled
}
booleanread-write (null)An indication of whether the protocol is enabled.
KVMIP {objectThe settings for this manager's KVM-IP protocol support.
      Portintegerread-write (null)The protocol port.
      ProtocolEnabled
}
booleanread-write (null)An indication of whether the protocol is enabled.
NTP (v1.2+) {objectThe settings for this manager's NTP protocol support.
      NTPServers [ ] array
(string, null)
read-writeIndicates to which NTP servers this manager is subscribed.
      Portintegerread-write (null)The protocol port.
      ProtocolEnabled
}
booleanread-write (null)An indication of whether the protocol is enabled.
RDP (v1.3+) {objectThe settings for this manager's Remote Desktop Protocol support.
      Portintegerread-write (null)The protocol port.
      ProtocolEnabled
}
booleanread-write (null)An indication of whether the protocol is enabled.
RFB (v1.3+) {objectThe settings for this manager's Remote Frame Buffer protocol support, which can support VNC.
      Portintegerread-write (null)The protocol port.
      ProtocolEnabled
}
booleanread-write (null)An indication of whether the protocol is enabled.
SNMP {objectThe settings for this manager's SNMP support.
      Portintegerread-write (null)The protocol port.
      ProtocolEnabled
}
booleanread-write (null)An indication of whether the protocol is enabled.
SSDP {objectThe settings for this manager's SSDP support.
      NotifyIPv6Scopestring
(enum)
read-write (null)The IPv6 scope for multicast NOTIFY messages for SSDP.
For the possible property values, see NotifyIPv6Scope in Property Details.
      NotifyMulticastIntervalSecondsinteger
(seconds)
read-write (null)The time interval, in seconds, between transmissions of the multicast NOTIFY ALIVE message from this service for SSDP.
      NotifyTTLintegerread-write (null)The time-to-live hop count for SSDP multicast NOTIFY messages.
      Portintegerread-write (null)The protocol port.
      ProtocolEnabled
}
booleanread-write (null)An indication of whether the protocol is enabled.
SSH {objectThe settings for this manager's Secure Shell (SSH) protocol support.
      Portintegerread-write (null)The protocol port.
      ProtocolEnabled
}
booleanread-write (null)An indication of whether the protocol is enabled.
Status { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
Telnet {objectThe settings for this manager's Telnet protocol support.
      Portintegerread-write (null)The protocol port.
      ProtocolEnabled
}
booleanread-write (null)An indication of whether the protocol is enabled.
VirtualMedia {objectThe settings for this manager's virtual media support.
      Portintegerread-write (null)The protocol port.
      ProtocolEnabled
}
booleanread-write (null)An indication of whether the protocol is enabled.

Property Details

NotifyIPv6Scope:

The IPv6 scope for multicast 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_4_2.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.id": "/redfish/v1/Managers/BMC/NetworkProtocol"
}

Memory 1.8.0

v1.8v1.7v1.6v1.5v1.4v1.3v1.2v1.1v1.0
2019.22018.32018.22018.12017.32017.22017.12016.32016.1

The schema for definition of a memory and its configuration.

URIs:

AllocationAlignmentMiB (v1.2+)integer
(mebibytes)
read-only (null)The boundary that 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-onlySpeeds supported by this memory.
Assembly (v1.4+) {objectThe link 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 the memory.
For the possible property values, see BaseModuleType in Property Details.
BusWidthBitsintegerread-only (null)The 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)An indication of whether the configuration of this memory is locked and cannot be altered.
DataWidthBitsintegerread-only (null)Data width in bits.
DeviceID (deprecated v1.3)stringread-only (null)Device ID. Deprecated in v1.3 and later. This property has been deprecated in favor of ModuleProductID.
DeviceLocatorstringread-only (null)Location of the memory in the platform.
ErrorCorrectionstring
(enum)
read-only (null)Error correction scheme supported for this memory.
For the possible property values, see ErrorCorrection in Property Details.
FirmwareApiVersionstringread-only (null)Version of API supported by the firmware.
FirmwareRevisionstringread-only (null)Revision of firmware on the memory controller.
FunctionClasses (deprecated v1.3) [ ] array
(string)
read-onlyFunction classes by the memory. Deprecated in v1.3 and later. This property has been deprecated in favor of OperatingMemoryModes at the root of the Resource, or MemoryClassification found within RegionSet.
IsRankSpareEnabledbooleanread-only (null)An indication of whether rank spare is enabled for this memory.
IsSpareDeviceEnabledbooleanread-only (null)An indication of whether a spare device is enabled for this memory.
Links (v1.2+) {objectThe links to other Resources that are related to this Resource.
      Chassis {objectThe link to the chassis that 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.
For property details, see Location.
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-onlySet of maximum power budgets supported by the memory in milliwatts.
MemoryDeviceTypestring
(enum)
read-only (null)Type details of the memory.
For the possible property values, see MemoryDeviceType in Property Details.
MemoryLocation {objectMemory connection information to sockets and memory controllers.
      Channelintegerread-only (null)The channel number to which the memory is connected.
      MemoryControllerintegerread-only (null)The memory controller number to which the memory is connected.
      Slotintegerread-only (null)The slot number to which the memory is connected.
      Socket
}
integerread-only (null)The socket number to which the memory is connected.
MemoryMedia [ ] array (string
(enum))
read-onlyMedia of this memory.
For the possible property values, see MemoryMedia in Property Details.
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.
For the possible property values, see MemoryType in Property Details.
Metrics {objectThe link 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.
For the possible property values, see OperatingMemoryModes in Property Details.
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 milliwatts.
      MaxTDPMilliWattsinteger
(milliWatts)
read-only (null)Maximum TDP in milliwatts.
      PeakPowerBudgetMilliWattsinteger
(milliWatts)
read-only (null)Peak power budget, in milliwatts.
      PolicyEnabled
}
booleanread-only (null)An indication of whether the power management policy is enabled.
RankCountintegerread-only (null)Number of ranks available in the memory.
Regions [ {arrayMemory regions information within the memory.
      MemoryClassificationstring
(enum)
read-only (null)The classification of memory that the memory region occupies.
For the possible property values, see MemoryClassification in Property Details.
      OffsetMiBinteger
(mebibytes)
read-only (null)Offset within the memory that corresponds to the start of this memory region in mebibytes (MiB).
      PassphraseEnabled (v1.5+)booleanread-only (null)An indication of whether the passphrase is enabled for this region.
      PassphraseState (deprecated v1.5)booleanread-only (null)An indication of whether the state of the passphrase for this region is enabled. Deprecated in v1.5 and later. This property has been deprecated in favor of PassphraseEnabled found within RegionSet.
      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 {objectSecurity capabilities of the memory.
      ConfigurationLockCapable (v1.7+)booleanread-only (null)An indication of whether this memory supports the locking, or freezing, of the configuration.
      DataLockCapable (v1.7+)booleanread-only (null)An indication of whether this memory supports data locking.
      MaxPassphraseCountintegerread-only (null)Maximum number of passphrases supported for this memory.
      PassphraseCapablebooleanread-only (null)An indication of whether the memory is passphrase capable.
      PassphraseLockLimit (v1.7+)integerread-only (null)The maximum number of incorrect passphrase attempts allowed before memory is locked.
      SecurityStates (deprecated v1.7) [ ]
}
array (string
(enum))
read-onlySecurity states supported by the memory.
For the possible property values, see SecurityStates in Property Details. Deprecated in v1.7 and later. This property has been deprecated in favor of using the individual PassphraseCapable, DataLockCapable and ConfigurationLockCapable properties.
SecurityState (v1.7+)string
(enum)
read-write (null)The current security state of this memory.
For the possible property values, see SecurityState in Property Details.
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+) { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
SubsystemDeviceID (deprecated v1.3)stringread-only (null)Subsystem device ID. Deprecated in v1.3 and later. This property has been deprecated in favor of MemorySubsystemControllerProductID.
SubsystemVendorID (deprecated v1.3)stringread-only (null)SubSystem vendor ID. Deprecated in v1.3 and later. This property has been deprecated in favor of MemorySubsystemControllerManufacturerID.
VendorID (deprecated v1.3)stringread-only (null)Vendor ID. Deprecated in v1.3 and later. This property has been deprecated in favor of 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 that 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 requiredThe memory region ID to which to apply this action.

OverwriteUnit

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

URIs:

The following table shows the parameters for the action that 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 requiredThe memory region ID to which to apply this action.

Reset

This action resets this memory.

URIs:

The following table shows the parameters for the action that 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.
For the possible property values, see ResetType in Property Details.

SecureEraseUnit

This contains 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 that 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 requiredThe memory region ID to which to apply this action.

SetPassphrase

Set passphrase for the given regions.

URIs:

The following table shows the parameters for the action that 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 requiredThe memory region ID to which to apply this action.

UnlockUnit

This contains the action for unlocking given regions.

URIs:

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

{
      Passphrasestringread-write requiredThe passphrase required to complete the operation.
      RegionId
}
stringread-write requiredThe memory region ID to which to apply this action.

Property Details

BaseModuleType:

The base module type of the 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.
MultiBitECCMultibit data errors can be corrected by ECC.
NoECCNo ECC available.
SingleBitECCSingle bit data errors can be corrected by ECC.

MemoryClassification:

The classification of memory that the memory region occupies.

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.
Intel3DXPointIntel 3D XPoint media.
NANDNAND media.
ProprietaryProprietary media.

MemoryType:

The type of memory.

stringDescription
DRAMThe memory module is comprised of volatile memory.
IntelOptane (v1.6+)The memory module is an Intel Optane DC Persistent Memory Module.
NVDIMM_FThe memory module is comprised of non-volatile memory.
NVDIMM_NThe memory module is comprised of volatile memory backed by non-volatile memory.
NVDIMM_PThe memory module is comprised 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.

ResetType:

The type of reset.

stringDescription
ForceOffTurn off the unit immediately (non-graceful shutdown).
ForceOnTurn on the unit immediately.
ForceRestartShut down immediately and non-gracefully and restart the system.
GracefulRestartShut down gracefully and restart the system.
GracefulShutdownShut down gracefully and power off.
NmiGenerate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system.
OnTurn on the unit.
PowerCyclePower cycle the unit.
PushPowerButtonSimulate the pressing of the physical power button on this unit.

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 cannot be modified until reset. 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. 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.
FrozenSecure state is frozen and cannot be modified until reset.
LockedSecure mode is enabled and access to the data is locked.
PassphraselimitNumber of attempts to unlock the memory exceeded limit.
UnlockedSecure mode is enabled and access to the data is unlocked.

Example Response

{
    "@odata.type": "#Memory.v1_8_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.id": "/redfish/v1/Systems/437XR1138R2/Memory/DIMM1"
}

MemoryChunks 1.2.4

v1.2v1.1v1.0
2017.32017.12016.2

The schema definition of a memory chunk and its configuration.

URIs:

AddressRangeTypestring
(enum)
read-only (null)Memory type of this memory chunk.
For the possible property values, see AddressRangeType in Property Details.
InterleaveSets [ {arrayThe 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)An indication of whether memory mirroring is enabled for this memory chunk.
IsSparebooleanread-only (null)An indication of whether sparing is enabled for this memory chunk.
MemoryChunkSizeMiBinteger
(mebibytes)
read-only (null)Size of the memory chunk measured in mebibytes (MiB).
Status (v1.2+) { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.

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_2_4.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_2_2.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.id": "/redfish/v1/Systems/2/MemoryDomains/1/MemoryChunks/1"
}

MemoryDomain 1.2.3

v1.2v1.1v1.0
2017.12016.32016.2

The MemoryDomain schema describes a memory domain and its configuration. Memory domains indicate to the client which memory, or DIMMs, can be grouped together in memory chunks to represent addressable memory.

URIs:

AllowsBlockProvisioningbooleanread-only (null)An indication of whether this memory domain supports the provisioning of blocks of memory.
AllowsMemoryChunkCreationbooleanread-only (null)An indication of whether this memory domain supports the creation of memory chunks.
AllowsMirroring (v1.1+)booleanread-only (null)An indication of whether this memory domain supports the creation of memory chunks with mirroring enabled.
AllowsSparing (v1.1+)booleanread-only (null)An indication of whether this memory domain supports the creation of memory chunks with sparing enabled.
InterleavableMemorySets [ {arrayThe interleave sets for the memory chunk.
      MemorySet [ {arrayThe set 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 {objectThe link 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_3.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.id": "/redfish/v1/Systems/2/MemoryDomains/1"
}

MemoryMetrics 1.2.0

v1.2v1.1v1.0
2019.22016.22016.1

The usage and health statistics for a memory device or system memory summary.

URIs:

BandwidthPercent (v1.2+)number
(%)
read-only (null)The memory bandwidth utilization as a percentage.
BlockSizeBytesinteger
(bytes)
read-only (null)The block size, in bytes.
CurrentPeriod {objectThe memory metrics since the last reset or ClearCurrentPeriod action.
      BlocksReadintegerread-only (null)The number of blocks read since reset.
      BlocksWritten
}
integerread-only (null)The number of blocks written since reset.
HealthData {objectThe health information of the memory.
      AlarmTrips {objectAlarm trip information about the memory.
            AddressParityErrorbooleanread-only (null)An indication of whether an address parity error was detected that a retry could not correct.
            CorrectableECCErrorbooleanread-only (null)An indication of whether the correctable error threshold crossing alarm trip was detected.
            SpareBlockbooleanread-only (null)An indication of whether the spare block capacity crossing alarm trip was detected.
            Temperaturebooleanread-only (null)An indication of whether a temperature threshold alarm trip was detected.
            UncorrectableECCError
      }
booleanread-only (null)An indication of whether the uncorrectable error threshold alarm trip was detected.
      DataLossDetectedbooleanread-only (null)An indication of whether data loss was detected.
      LastShutdownSuccessbooleanread-only (null)An indication of whether the last shutdown succeeded.
      PerformanceDegradedbooleanread-only (null)An indication of whether performance has degraded.
      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)The remaining spare blocks, as a percentage.
LifeTime {objectThe memory metrics for the lifetime of the memory.
      BlocksReadintegerread-only (null)The number of blocks read for the lifetime of the memory.
      BlocksWritten
}
integerread-only (null)The number of blocks written for the lifetime of the memory.

Actions

ClearCurrentPeriod

This action sets the CurrentPeriod property's values to 0.

URIs:

(This action takes no parameters.)

Example Response

{
    "@odata.type": "#MemoryMetrics.v1_2_0.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.id": "/redfish/v1/Systems/1/Memory/1/MemoryMetrics"
}

MessageRegistry 1.3.1

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

The MessageRegistry schema describes all Message Registries. It represents the properties for the Message Registries themselves.

Languagestringread-only requiredThe RFC5646-conformant language code for the Message Registry.
Messages {object requiredThe message keys contained in the Message 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)An indication of whether all prior conditions and messages are cleared, provided the ClearsIf condition is met.
                  ClearsIfstring
(enum)
read-only (null)The condition when the event is cleared.
For the possible property values, see ClearsIf in Property Details.
                  ClearsMessage [ ]
            }
array
(string, null)
read-onlyThe array of MessageIds that this message clears when the other conditions are met.
            Descriptionstringread-only requiredA short description of how and when to use this message.
            LongDescription (v1.3+)stringread-only (null)The normative language that describes this message's usage.
            Messagestringread-only requiredThe actual message.
            NumberOfArgsintegerread-only requiredThe number of arguments in the 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.
For the possible property values, see ParamTypes in Property Details.
            Resolutionstringread-only requiredUsed to provide suggestions on how to resolve the situation that caused the error.
            Severity
      }
stringread-only requiredThe 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 requiredThe organization or company that publishes this Message Registry.
RegistryPrefixstringread-only requiredThe single-word prefix that is used in forming and decoding MessageIds.
RegistryVersionstringread-only requiredThe Message Registry version in the middle portion of a MessageId.

Property Details

ClearsIf:

The condition when the event is cleared.

stringDescription
SameOriginOfConditionThis enumeration shall describe when the message for an event is cleared by the other messages in the ClearingLogic property, 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_3_1.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.3

v1.1v1.0
2017.12016.1

The MessageRegistryFile schema describes the Message Registry file locator Resource.

URIs:

Languages [ ] array
(string)
read-only requiredThe RFC5646-conformant language codes for the available Message Registries.
Location [ {array requiredThe location information for this Message Registry file.
      ArchiveFilestringread-onlyIf the service hosts the Message Registry in an archive file, the name of the file within the archive.
      ArchiveUristringread-onlyIf the Message Registry is hosted on the service in an archive file, the link to the archive file.
      Languagestringread-onlyThe language code for the Message Registry file.
      PublicationUristringread-onlyThe link to publicly available (canonical) URI for the Message Registry.
      Uri
} ]
stringread-onlyThe link to locally available URI for the Message Registry.
Registrystringread-only requiredThe registry name and its major and minor versions. This registry can be 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_1_3.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.3

v1.0
2018.2

The MetricDefinition schema describes the metadata information for a metric.

URIs:

Accuracynumberread-only (null)The estimated percent error of measured versus actual values.
Calculablestring
(enum)
read-write (null)An indication of whether the metric can be used in a calculation.
For the possible property values, see Calculable in Property Details.
CalculationAlgorithmstring
(enum)
read-only (null)The calculation that is performed on a source metric to obtain the metric being defined.
For the possible property values, see CalculationAlgorithm in Property Details.
CalculationParameters [ {arrayThe metric properties that are part of the synthesis calculation. This property is present when the MetricType property is Synthesized.
      ResultMetricstringread-only (null)The link to a metric property that stores the result 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)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.
For the possible property values, see Implementation in Property Details.
IsLinearbooleanread-write (null)An indication of whether the metric values are linear versus non-linear.
MaxReadingRangenumberread-only (null)Maximum value for metric reading.
MetricDataTypestring
(enum)
read-write (null)The data type of the metric.
For the possible property values, see MetricDataType in Property Details.
MetricProperties [ ] array
(string, null)
read-writeThe list of URIs with wildcards and property identifiers that this metric definition defines. 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.
For the possible property values, see MetricType in Property Details.
MinReadingRangenumberread-only (null)Minimum value for metric reading.
PhysicalContextstring
(enum)
read-only (null)The physical context of the metric.
For the possible property values, see PhysicalContext in Property Details.
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)The accuracy of the timestamp.
Unitsstringread-write (null)The units of measure for this metric.
Wildcards [ {arrayThe wildcards and their substitution values for 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:

An indication of 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 that is performed on a source metric to obtain the metric being defined.

stringDescription
AverageThe metric is calculated as the average metric reading over a sliding time interval.
MaximumThe metric is calculated as the maximum metric reading over during a time interval.
MinimumThe metric is calculated as the minimum 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 provided.

MetricDataType:

The data type of the metric.

stringDescription
BooleanThe JSON boolean definition.
DateTimeThe JSON string definition with the 'date-time' format.
DecimalThe JSON decimal definition.
EnumerationThe JSON string definition with a set of defined enumerations.
IntegerThe JSON integer definition.
StringThe JSON string definition.

MetricType:

The type of metric.

stringDescription
CountdownThe metric is a countdown metric. The metric reading is a non-negative integer that 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 that 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:

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 a networking chip or chipset component.
BackThe back of the chassis.
BackplaneA backplane within the chassis.
ChassisThe entire chassis.
ComputeBayWithin a compute bay.
CoolingSubsystemThe entire cooling, or air and liquid, subsystem.
CPUA processor (CPU).
CPUSubsystemThe entire processor (CPU) subsystem.
DCBusA DC bus.
ExhaustThe air exhaust point or points or region of the chassis.
ExpansionBayWithin an expansion bay.
FanA fan.
FPGAAn FPGA.
FrontThe front of the chassis.
GPUA graphics processor (GPU).
GPUSubsystemThe entire graphics processor (GPU) subsystem.
IntakeThe air intake point or points 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_3.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.id": "/redfish/v1/TelemetryService/MetricDefinitions/PowerConsumedWatts"
}

MetricReport 1.2.0

v1.2v1.1v1.0
2019.22018.32018.2

The metric definitions that create a metric report.

URIs:

MetricReportDefinition {objectThe definitions in the 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 {objectThe link to the metric.
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 metric value, as a string.
      Oem (v1.2+) { }objectSee the Oem object definition in the Common properties section.
      Timestamp
} ]
stringread-only (null)The time when 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_2_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.id": "/redfish/v1/TelemetryService/MetricReports/AvgPlatformPowerUsage"
}

MetricReportDefinition 1.3.0

v1.3v1.2v1.1v1.0
2019.22019.12018.32018.2

The MetricReportDefinition schema describes set of metrics that are collected into a metric report.

URIs:

AppendLimitintegerread-onlyThe 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+) {objectThe links to other Resources that are related to this Resource.
      Oem { }objectSee the Oem object definition in the Common properties section.
      Triggers [ {arrayThe triggers that cause this metric report definition to generate a new metric report upon a trigger occurrence when the TriggerActions property contains RedfishMetricReport.
            @odata.id
      } ]
}
stringread-onlyLink to a Triggers resource. See the Links section and the Triggers schema for details.
MetricProperties [ ] array
(string, null)
read-writeThe 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 property.
MetricReport {objectThe 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)An indication of whether the generation of new metric reports is enabled.
MetricReportDefinitionTypestring
(enum)
read-write (null)Specifies when the metric report is generated.
For the possible property values, see MetricReportDefinitionType in Property Details.
MetricReportHeartbeatInterval (v1.2+)stringread-write (null)The interval at which to send the complete metric report because the Redfish client wants refreshed metric data even when the data has not changed. This property value is always greater than the recurrence interval of a metric report, and it only applies when the SuppressRepeatedMetricValue property is true.
Metrics [ {arrayThe 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)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.
For the possible property values, see CollectionFunction in Property Details.
      CollectionTimeScopestring
(enum)
read-write (null)The scope of time scope over which the function is applied.
For the possible property values, see CollectionTimeScope in Property Details.
      MetricIdstringread-only (null)The label for the metric definition that is derived by applying the collectionFunction to the metric property. It matches the Id property of the corresponding metric definition.
      MetricProperties [ ]
} ]
array
(string, null)
read-writeThe set of URIs for the properties on which this metric is collected.
ReportActions [ ] array (string
(enum))
read-onlyThe set of actions to perform when a metric report is generated. Actions to perform when a metric report is generated.
For the possible property values, see ReportActions in Property Details.
ReportTimespan (v1.3+)stringread-write (null)Specifies the timespan duration of the metric report.
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 a report Resource.
For the possible property values, see ReportUpdates in Property Details.
Schedule { }objectThe schedule for generating the metric report.
For property details, see Schedule.
Status { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
SuppressRepeatedMetricValue (v1.2+)booleanread-write (null)An indication of whether any metrics are suppressed from the generated metric report. If true, any metric that equals the same metric in the previously generated metric report is suppressed from the current report. Also, duplicate metrics are suppressed. If false, no metrics are suppressed from the current report. The current report may contain no metrics if all metrics equal the values of the same metrics in the previously generated metric report.
Wildcards [ {arrayThe set of wildcards and their substitution values for the entries in the MetricProperties property.
      Keys (deprecated v1.1) [ ] array
(string, null)
read-onlyAn array of values to substitute for the wildcard. Deprecated in v1.1 and later. 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 metric reading over a duration.
MaximumThe metric is calculated as the maximum metric reading over a duration.
MinimumThe metric is calculated as the minimum metric reading over a duration.
SummationThe metric is calculated as the sum of the values over a duration.

CollectionTimeScope:

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 Timestamp property value 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 Timestamp property value shall specify the point in time.
StartupIntervalThe corresponding metric values apply to a time interval that began at the startup of the measured Resource, such as the Resources that Links.MetricDefinitionForResources associates. On the corresponding metric value instances, the Timestamp value shall specify the end of the time interval. The Duration value shall specify the duration between the startup of 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:

The set of 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 the MetricReport type.

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 a 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, new information is appended to the report. 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 metric report.

Example Response

{
    "@odata.type": "#MetricReportDefinition.v1_3_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.id": "/redfish/v1/TelemetryService/MetricReportDefinitions/PlatformPowerUsage"
}

NetworkAdapter 1.3.0

v1.3v1.2v1.1v1.0
2019.22018.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+) {objectThe link 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)An indication of 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)An indication of whether the controller supports NIC function partitioning.
                  NparEnabled
            }
booleanread-write (null)An indication of whether 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)An indication of 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 supported by this controller.
                        MinAssignmentGroupSizeintegerread-only (null)The minimum number of virtual functions that can be allocated or moved between physical functions for this controller.
                        NetworkPortMaxCount
                  }
            }
      }
integerread-only (null)The maximum number of virtual functions supported per network port for this controller.
      FirmwarePackageVersionstringread-only (null)The version of the user-facing firmware package.
      Identifiers (v1.3+) [ { } ]array (object)The Durable names for the network adapter. Any additional identifiers for a Resource.
For property details, see Identifier.
      Links {objectThe links.
            NetworkDeviceFunctions [ {arrayAn array of links 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 links 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 links 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.
For property details, see Location.
      PCIeInterface (v1.2+) { }
} ]
objectThe PCIe interface details for this controller.
For property details, see PCIeInterface (v1.3.1).
Manufacturerstringread-only (null)The manufacturer or OEM of this network adapter.
Modelstringread-only (null)The model string for this network adapter.
NetworkDeviceFunctions {objectThe link 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 {objectThe link 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 { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.

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_3_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.3

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

The NetworkDeviceFunction schema represents a logical interface that a network adapter exposes.

URIs:

AssignablePhysicalPorts [ {arrayAn array of physical ports to which this network device function may be assigned.
      @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.
For the possible property values, see BootMode in Property Details.
DeviceEnabledbooleanread-write (null)An indication of whether the network device function is enabled.
Ethernet {objectThe Ethernet capabilities, status, and configuration values for this network device function.
      MACAddressstringread-write (null)The currently configured MAC address.
      MTUSizeintegerread-write (null)The maximum transmission unit (MTU) configured for this network device function.
      PermanentMACAddressstringread-only (null)The permanent MAC address assigned to this 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+) {objectThe link to a collection of VLANs. This property is used only if the interface supports more than one VLAN.
Contains a link to a resource.
            @odata.id
      }
}
stringread-onlyLink to Collection of VLanNetworkInterface. See the VLanNetworkInterface schema for details.
FibreChannel {objectThe Fibre Channel capabilities, status, and configuration values for this network device function.
      AllowFIPVLANDiscoverybooleanread-write (null)An indication of whether the FCoE Initialization Protocol (FIP) populates 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 from which to boot on the device to which the corresponding WWPN refers.
            WWPN
      } ]
stringread-write (null)The World Wide Port Name (WWPN) from which to boot.
      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 that the switch assigns for this interface.
      PermanentWWNNstringread-only (null)The permanent World Wide Node Name (WWNN) address assigned to this function.
      PermanentWWPNstringread-only (null)The permanent World Wide Port Name (WWPN) address assigned to this function.
      WWNNstringread-write (null)The currently configured World Wide Node Name (WWNN) address of this function.
      WWNSourcestring
(enum)
read-write (null)The configuration source of the World Wide Names (WWN) for this World Wide Node Name (WWNN) and World Wide Port Name (WWPN) connection.
For the possible property values, see WWNSource in Property Details.
      WWPN
}
stringread-write (null)The currently configured World Wide Port Name (WWPN) address of this function.
iSCSIBoot {objectThe iSCSI boot capabilities, status, and configuration values for this network device function.
      AuthenticationMethodstring
(enum)
read-write (null)The iSCSI boot authentication method for this network device function.
For the possible property values, see AuthenticationMethod in Property Details.
      CHAPSecretstringread-write (null)The shared secret for CHAP authentication.
      CHAPUsernamestringread-write (null)The user name 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 being populated in the iSCSIBoot IP address fields.
For the possible property values, see IPAddressType in Property Details.
      IPMaskDNSViaDHCPbooleanread-write (null)An indication of whether the iSCSI boot initiator uses DHCP to obtain the initiator name, IP address, and netmask.
      MutualCHAPSecretstringread-write (null)The CHAP secret for two-way CHAP authentication.
      MutualCHAPUsernamestringread-write (null)The CHAP user name for two-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 IPv4 or IPv6 address 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)An indication of whether 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)An indication of 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 IPv4 or IPv6 address 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)An indication of whether 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)An indication of whether the iSCSI boot target name, LUN, IP address, and netmask should be obtained from DHCP.
Links {objectThe links for this network device function.
      Endpoints (v1.2+) [ {arrayAn array of links 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 {objectThe link to the PCIe function 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 to which this network device function is currently assigned.
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 that are available for this network device function.
NetDevFuncCapabilities [ ] array (string
(enum))
read-only (null)An array of capabilities for this network device function.
For the possible property values, see NetDevFuncCapabilities in Property Details.
NetDevFuncTypestring
(enum)
read-write (null)The configured capability of this network device function.
For the possible property values, see NetDevFuncType in Property Details.
PhysicalPortAssignment (deprecated v1.3) {objectThe physical port to which this network device function is currently assigned.
See the NetworkPort schema for details on this property. Deprecated in v1.3 and later. 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 { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
VirtualFunctionsEnabledbooleanread-only (null)An indication of whether single root input/output virtualization (SR-IOV) virtual functions 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 by using the embedded Fibre Channel support and configuration. Only applicable if the NetworkDeviceFunctionType is `FibreChannel`.
FibreChannelOverEthernetBoot this device by using the embedded Fibre Channel over Ethernet (FCoE) boot support and configuration. Only applicable if the NetworkDeviceFunctionType is `FibreChannelOverEthernet`.
iSCSIBoot this device by using the embedded iSCSI boot support and configuration. Only applicable if the NetworkDeviceFunctionType is `iSCSI`.
PXEBoot this device by using the embedded PXE support. Only applicable if the NetworkDeviceFunctionType is `Ethernet`.

IPAddressType:

The type of IP address 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:

An array of capabilities for 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 World Wide Names (WWN) for this World Wide Node Name (WWNN) and World Wide Port Name (WWPN) connection.

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_3.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.3

v1.1v1.0
2017.12016.3

The NetworkInterface schema describes links to the NetworkAdapter, NetworkPort, and NetworkDeviceFunction Resources and represents the functionality available to the containing system.

URIs:

Links {objectThe links.
      NetworkAdapter {objectThe link to the network adapter that contains this network interface.
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 {objectThe link to the network device functions associated with this network interface.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of NetworkDeviceFunction. See the NetworkDeviceFunction schema for details.
NetworkPorts {objectThe link to the network ports associated with this network interface.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of NetworkPort. See the NetworkPort schema for details.
Status { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.

Example Response

{
    "@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces/9fd725a1",
    "@odata.type": "#NetworkInterface.v1_1_3.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.3

v1.2v1.1v1.0
2018.22017.12016.3

A network port, which is a discrete physical port that can connect to a network.

URIs:

ActiveLinkTechnologystring
(enum)
read-write (null)Network port active link technology.
For the possible property values, see ActiveLinkTechnology in Property Details.
AssociatedNetworkAddresses [ ] array
(string, null)
read-onlyAn array of configured MAC or WWN network addresses 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)An indication of 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)The connection type of this port.
For the possible property values, see FCPortConnectionType in Property Details.
FlowControlConfigurationstring
(enum)
read-write (null)The locally configured 802.3x flow control setting for this network port.
For the possible property values, see FlowControlConfiguration in Property Details.
FlowControlStatusstring
(enum)
read-only (null)The 802.3x flow control behavior negotiated with the link partner for this network port (Ethernet-only).
For the possible property values, see FlowControlStatus in Property Details.
LinkStatusstring
(enum)
read-only (null)The status of the link between this port and its link partner.
For the possible property values, see LinkStatus in Property Details.
MaxFrameSize (v1.2+)integer
(bytes)
read-only (null)The maximum frame size supported by the port.
NetDevFuncMaxBWAlloc [ {arrayAn 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 {objectThe link 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 [ {arrayAn 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 {objectThe link 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)An indication of whether the port has detected enough signal on enough lanes to establish a link.
Status { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
SupportedEthernetCapabilities [ ] array (string
(enum))
read-only (null)The set of Ethernet capabilities that this port supports.
For the possible property values, see SupportedEthernetCapabilities in Property Details.
SupportedLinkCapabilities [ {arrayThe link capabilities of this port.
      AutoSpeedNegotiation (v1.2+)booleanread-only (null)An indication of whether the port is capable of auto-negotiating speed.
      CapableLinkSpeedMbps (v1.2+) [ ] array
(integer, null)
read-onlyThe set of link speed capabilities of this port.
      LinkNetworkTechnologystring
(enum)
read-only (null)The link network technology capabilities of this port.
For the possible property values, see LinkNetworkTechnology in Property Details.
      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 in v1.2 and later. This property has been deprecated in favor of the CapableLinkSpeedMbps.
VendorId (v1.2+)stringread-only (null)The vendor Identification for this port.
WakeOnLANEnabledbooleanread-write (null)An indication of 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:

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 through 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 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.4.0

v1.4v1.3v1.2v1.1v1.0
2019.22018.22017.32017.12016.2

The PCIeDevice schema describes the properties of a PCIe device that is attached to a system.

URIs:

Assembly (v1.2+) {objectThe link 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.
For the possible property values, see DeviceType in Property Details.
FirmwareVersionstringread-only (null)The version of firmware for this PCIe device.
Links {objectThe links to other Resources that are related to this Resource.
      Chassis [ {arrayAn array of links 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 (deprecated v1.4) [ {arrayAn array of links to PCIeFunctions exposed by this device. Deprecated in v1.4 and later. This property has been deprecated in favor of the PCIeFunctions property in the root that provides a link to a Resource Collection.
            @odata.id
      } ]
}
stringread-onlyLink to a PCIeFunction resource. See the Links section and the PCIeFunction schema for details.
Manufacturerstringread-only (null)The manufacturer of this PCIe device.
Modelstringread-only (null)The model number for the PCIe device.
PartNumberstringread-only (null)The part number for this PCIe device.
PCIeFunctions (v1.4+) {objectThe link to the collection of PCIe functions associated with this PCIe device.
Contains a link to a resource.
      @odata.id
}
stringread-onlyLink to Collection of PCIeFunction. See the PCIeFunction schema for details.
PCIeInterface (v1.3+) {objectThe PCIe interface details for this PCIe device.
      LanesInUseintegerread-only (null)The number of PCIe lanes in use by this device.
      MaxLanesintegerread-only (null)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.
For the possible property values, see MaxPCIeType in Property Details.
      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.
For the possible property values, see PCIeType in Property Details.
SerialNumberstringread-only (null)The serial number for this PCIe device.
SKUstringread-only (null)The SKU for this PCIe device.
Status { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.

Property Details

DeviceType:

The device type for this PCIe device.

stringDescription
MultiFunctionA multi-function PCIe device.
SimulatedA PCIe device that 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_4_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.3

v1.2v1.1v1.0
2018.12017.12016.2

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.
For the possible property values, see DeviceClass in Property Details.
DeviceIdstringread-only (null)The Device ID of this PCIe function.
FunctionIdintegerread-only (null)The PCIe Function Number.
FunctionTypestring
(enum)
read-onlyThe type of the PCIe function.
For the possible property values, see FunctionType in Property Details.
Links {objectThe links to other Resources that are related to this Resource.
      Drives [ {arrayAn array of links to the drives that 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 links to the Ethernet interfaces that 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 links to the network device functions that 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 {objectThe link to the PCIe device 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 links to the storage controllers that 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 { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
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/PCIeFunctions/2",
    "@odata.type": "#PCIeFunction.v1_2_3.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.1

v1.1v1.0
2019.12018.2

The PCIeSlots schema describes PCIe slot properties.

URIs:

Slots [ {arrayAn array of PCI Slot information.
      HotPluggable (v1.1+)booleanread-only (null)An indication of whether this PCIe slot supports hotplug.
      Lanesintegerread-only (null)The number of PCIe lanes supported by this slot.
      Links {objectThe links to other Resources that are related to this Resource.
            Oem { }objectSee the Oem object definition in the Common properties section.
            PCIeDevice [ {arrayAn array of links 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.
For property details, see Location.
      Oem { }objectSee the Oem object definition in the Common properties section.
      PCIeTypestring
(enum)
read-only (null)The PCIe specification supported by this slot.
For the possible property values, see PCIeType in Property Details.
      SlotTypestring
(enum)
read-only (null)The PCIe slot type for this slot.
For the possible property values, see SlotType in Property Details.
      Status { }
} ]
objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.

Property Details

PCIeType:

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:

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_1_1.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.id": "/redfish/v1/Chassis/1/PCIeSlots"
}

Port 1.1.3

v1.1v1.0
2017.32016.2

The Port schema contains properties that describe 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 {objectThe links to other Resources that are related to this Resource.
      AssociatedEndpoints [ {arrayAn array of links 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 links 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 links 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.
For property details, see Location.
MaxSpeedGbpsnumber
(Gbit/s)
read-only (null)The maximum speed of this port as currently configured.
PortIdstringread-only (null)The label of this port on the physical package for this port.
PortProtocolstring
(enum)
read-only (null)The protocol being sent over this port.
For the possible property values, see PortProtocol in Property Details.
PortTypestring
(enum)
read-only (null)The type of this port.
For the possible property values, see PortType in Property Details.
Status { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
Widthintegerread-only (null)The number of lanes, phys, or other physical transport links that this port contains.

Actions

Reset

This action resets this port.

URIs:

The following table shows the parameters for the action that 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.
For the possible property values, see ResetType in Property Details.

Property Details

PortProtocol:

The protocol being sent over this port.

stringDescription
AHCIAdvanced Host Controller Interface (AHCI).
FCFibre Channel.
FCoEFibre Channel over Ethernet (FCoE).
FCPFibre Channel Protocol for SCSI.
FICONFIbre CONnection (FICON).
FTPFile Transfer Protocol (FTP).
HTTPHypertext Transport Protocol (HTTP).
HTTPSHypertext Transfer Protocol Secure (HTTPS).
I2CInter-Integrated Circuit Bus.
iSCSIInternet SCSI.
iWARPInternet Wide Area RDMA Protocol (iWARP).
NFSv3Network File System (NFS) version 3.
NFSv4Network File System (NFS) version 4.
NVMeNon-Volatile Memory Express (NVMe).
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.
SFTPSSH File Transfer Protocol (SFTP).
SMBServer Message Block (SMB). Also known as the Common Internet File System (CIFS).
UHCIUniversal Host Controller Interface (UHCI).
USBUniversal Serial Bus (USB).

PortType:

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.

stringDescription
ForceOffTurn off the unit immediately (non-graceful shutdown).
ForceOnTurn on the unit immediately.
ForceRestartShut down immediately and non-gracefully and restart the system.
GracefulRestartShut down gracefully and restart the system.
GracefulShutdownShut down gracefully and power off.
NmiGenerate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system.
OnTurn on the unit.
PowerCyclePower cycle the unit.
PushPowerButtonSimulate the pressing of the physical power button on this unit.

Example Response

{
    "@odata.type": "#Port.v1_1_3.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.id": "/redfish/v1/Fabrics/SAS/Switches/Switch1/Ports/1"
}

Power 1.5.4

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

The Power schema describes power metrics and represents the properties for power consumption and power limiting.

URIs:

PowerControl [ {arrayThe set of power control functions, including power reading and limiting.
      @odata.idstringread-only requiredThe unique identifier for a resource.
      Actions (v1.3+) { }objectThe available actions for this Resource.
      MemberIdstringread-only requiredThe identifier for the member within the collection.
      Namestringread-only (null)The power control function name.
      Oem { }objectSee the Oem object definition in the Common properties section.
      PhysicalContext (v1.4+)string
(enum)
read-onlyThe area, device, or set of devices to which this power control applies.
For the possible property values, see PhysicalContext in Property Details.
      PowerAllocatedWattsnumber
(Watts)
read-only (null)The total amount of power that has been allocated or budgeted to chassis.
      PowerAvailableWattsnumber
(Watts)
read-only (null)The amount of reserve power capacity, in watts, that remains. This value is the PowerCapacity value minus the PowerAllocated value.
      PowerCapacityWattsnumber
(Watts)
read-only (null)The total amount of power that can be allocated to the chassis. This value can be either the power supply capacity or the power budget that an upstream chassis assigns to this chassis.
      PowerConsumedWattsnumber
(Watts)
read-only (null)The actual power that the chassis consumes, in watts.
      PowerLimit {objectThe power 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.
For the possible property values, see LimitException in Property Details.
            LimitInWatts
      }
number
(Watts)
read-write (null)The power limit, in watts. If null, power capping is disabled.
      PowerMetrics {objectThe power readings for this chassis.
            AverageConsumedWattsnumber
(Watts)
read-only (null)The average power level over the measurement window over the last IntervalInMin minutes.
            IntervalInMininteger
(min)
read-only (null)The time interval, or window, over which the power metrics are measured.
            MaxConsumedWattsnumber
(Watts)
read-only (null)The highest power consumption level, in watts, that has occurred over the measurement window within the last IntervalInMin minutes.
            MinConsumedWatts
      }
number
(Watts)
read-only (null)The lowest power consumption level, in watts, over the measurement window that occurred within the last IntervalInMin minutes.
      PowerRequestedWattsnumber
(Watts)
read-only (null)The potential power, in watts, that the chassis requests, which may be higher than the current level being consumed because the requested power includes a budget that the chassis wants for future use.
      RelatedItem [ {arrayAn array of one or more IDs of the Resources associated with this power limit.
            @odata.id
      } ]
stringread-onlyThe unique identifier for a resource.
      Status { }
} ]
objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
PowerSupplies [ {arrayThe set of 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+) {objectThe link 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)An indication of whether 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, which identifies the power supply.
For the possible property values, see IndicatorLED in Property Details.
      InputRanges (v1.1+) [ {arrayThe input ranges that the power supply can use.
            InputTypestring
(enum)
read-only (null)The Input type (AC or DC).
For the possible property values, see InputType in Property Details.
            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.
For the possible property values, see LineInputVoltageType in Property Details.
      Location (v1.5+) { }objectThe location of the power supply.
For property details, see Location.
      Manufacturer (v1.1+)stringread-only (null)The manufacturer of this power supply.
      MemberIdstringread-only requiredThe 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).
For the possible property values, see PowerSupplyType in Property Details.
      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 { }
} ]
objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
Redundancy [ {arrayThe redundancy information for the set of power supplies in this chassis.
      @odata.id
} ]
stringread-onlyThe unique identifier for a resource.
Voltages [ {arrayThe set of voltage sensors for this chassis.
      @odata.idstringread-only requiredThe unique identifier for a resource.
      Actions (v1.3+) { }objectThe available actions for this Resource.
      LowerThresholdCriticalnumber
(Volts)
read-only (null)The value at which the reading is below normal range but not yet fatal.
      LowerThresholdFatalnumber
(Volts)
read-only (null)The value at which the reading is below normal range and fatal.
      LowerThresholdNonCriticalnumber
(Volts)
read-only (null)The value at which the reading is below normal range.
      MaxReadingRangenumber
(Volts)
read-only (null)Maximum value for this sensor.
      MemberIdstringread-only requiredThe identifier for the member within the collection.
      MinReadingRangenumber
(Volts)
read-only (null)Minimum value for this sensor.
      Namestringread-only (null)Voltage sensor name.
      Oem { }objectSee the Oem object definition in the Common properties section.
      PhysicalContextstring
(enum)
read-onlyThe area or device to which this voltage measurement applies.
For the possible property values, see PhysicalContext in Property Details.
      ReadingVoltsnumber
(Volts)
read-only (null)The reading of the voltage sensor.
      RelatedItem [ {arrayThe 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 { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
      UpperThresholdCriticalnumber
(Volts)
read-only (null)The value at which the reading is above normal range but not yet fatal.
      UpperThresholdFatalnumber
(Volts)
read-only (null)The value at which the reading is above normal range and fatal.
      UpperThresholdNonCritical
} ]
number
(Volts)
read-only (null)The value at which the reading is above normal range.

Property Details

IndicatorLED:

The state of The indicator LED, which identifies 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
AC120V (v1.1+)AC 120V nominal input.
AC240V (v1.1+)AC 240V nominal input.
AC277V (v1.1+)AC 277V nominal input.
ACandDCWideRange (v1.1+)Wide range AC or DC input.
ACHighLine (deprecated v1.1)277V AC input. This value has been deprecated in favor of AC277V.
ACLowLine (deprecated v1.1)100-127V AC input. This value has been deprecated in favor of AC120V.
ACMidLine (deprecated v1.1)200-240V AC input. This value has been deprecated in favor of AC240V.
ACWideRange (v1.1+)Wide range AC input.
DC240V (v1.1+)DC 240V nominal input.
DC380VHigh Voltage DC input (380V).
DCNeg48V-48V DC input.
UnknownThe power supply line input voltage type cannot be determined.

PhysicalContext:

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 a networking chip or chipset component.
BackThe back of the chassis.
BackplaneA backplane within the chassis.
ChassisThe entire chassis.
ComputeBayWithin a compute bay.
CoolingSubsystemThe entire cooling, or air and liquid, subsystem.
CPUA processor (CPU).
CPUSubsystemThe entire processor (CPU) subsystem.
DCBusA DC bus.
ExhaustThe air exhaust point or points or region of the chassis.
ExpansionBayWithin an expansion bay.
FanA fan.
FPGAAn FPGA.
FrontThe front of the chassis.
GPUA graphics processor (GPU).
GPUSubsystemThe entire graphics processor (GPU) subsystem.
IntakeThe air intake point or points 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.
ACorDCThe power 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_4.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.id": "/redfish/v1/Chassis/1U/Power"
}

PrivilegeRegistry 1.1.4

v1.1v1.0
2017.12016.3

The PrivilegeRegistry schema describes the operation-to-privilege mappings.

Mappings [ {arrayThe mappings between entities and the relevant privileges that access those entities.
      Entitystringread-onlyThe Resource name, such as Manager.
      OperationMap {objectList mapping between HTTP methods and privilege required for the Resource.
            DELETE [ {arrayThe privilege required to complete an HTTP DELETE operation.
                  Privilege [ ]
            } ]
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
            GET [ {arrayThe privilege required to complete an HTTP GET operation.
                  Privilege [ ]
            } ]
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
            HEAD [ {arrayThe privilege required to complete an HTTP HEAD operation.
                  Privilege [ ]
            } ]
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
            PATCH [ {arrayThe privilege required to complete an HTTP PATCH operation.
                  Privilege [ ]
            } ]
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
            POST [ {arrayThe privilege required to complete an HTTP POST operation.
                  Privilege [ ]
            } ]
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
            PUT [ {arrayThe privilege required to complete an HTTP PUT operation.
                  Privilege [ ]
            } ]
      }
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
      PropertyOverrides [ {arrayThe privilege overrides of properties within a Resource.
            OperationMap {objectThe mapping between the HTTP operation and the privilege required to complete the operation.
                  DELETE [ {arrayThe privilege required to complete an HTTP DELETE operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
                  GET [ {arrayThe privilege required to complete an HTTP GET operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
                  HEAD [ {arrayThe privilege required to complete an HTTP HEAD operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
                  PATCH [ {arrayThe privilege required to complete an HTTP PATCH operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
                  POST [ {arrayThe privilege required to complete an HTTP POST operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
                  PUT [ {arrayThe privilege required to complete an HTTP PUT operation.
                        Privilege [ ]
                  } ]
            }
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
            Targets [ ]
      } ]
array
(string, null)
read-onlyThe set of URIs, Resource types, or properties.
      ResourceURIOverrides [ {arrayThe privilege overrides of Resource URIs.
            OperationMap {objectThe mapping between the HTTP operation and the privilege required to complete the operation.
                  DELETE [ {arrayThe privilege required to complete an HTTP DELETE operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
                  GET [ {arrayThe privilege required to complete an HTTP GET operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
                  HEAD [ {arrayThe privilege required to complete an HTTP HEAD operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
                  PATCH [ {arrayThe privilege required to complete an HTTP PATCH operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
                  POST [ {arrayThe privilege required to complete an HTTP POST operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
                  PUT [ {arrayThe privilege required to complete an HTTP PUT operation.
                        Privilege [ ]
                  } ]
            }
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
            Targets [ ]
      } ]
array
(string, null)
read-onlyThe set of URIs, Resource types, or properties.
      SubordinateOverrides [ {arrayThe privilege overrides of the subordinate Resource.
            OperationMap {objectThe mapping between the HTTP operation and the privilege required to complete the operation.
                  DELETE [ {arrayThe privilege required to complete an HTTP DELETE operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
                  GET [ {arrayThe privilege required to complete an HTTP GET operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
                  HEAD [ {arrayThe privilege required to complete an HTTP HEAD operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
                  PATCH [ {arrayThe privilege required to complete an HTTP PATCH operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
                  POST [ {arrayThe privilege required to complete an HTTP POST operation.
                        Privilege [ ]
                  } ]
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
                  PUT [ {arrayThe privilege required to complete an HTTP PUT operation.
                        Privilege [ ]
                  } ]
            }
array
(string)
read-onlyAn array of privileges that are required to complete a specific HTTP operation on a Resource.
            Targets [ ]
      } ]
} ]
array
(string, null)
read-onlyThe set of URIs, Resource types, or properties.
OEMPrivilegesUsed [ ] array
(string)
read-onlyThe set of OEM privileges used in this mapping.
PrivilegesUsed [ ] array (string
(enum))
read-onlyThe set of Redfish standard privileges used in this mapping.
For the possible property values, see PrivilegesUsed in Property Details.

Property Details

PrivilegesUsed:

The set of Redfish standard privileges used in this mapping.

stringDescription
ConfigureComponentsCan configure components that this service manages.
ConfigureManagerCan configure managers.
ConfigureSelfCan change the password for the current user account.
ConfigureUsersCan configure users and their accounts.
LoginCan log in to the service and read Resources.

Example Response

{
    "@odata.type": "#PrivilegeRegistry.v1_1_4.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.1

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

The Processor schema describes the information about a single processor that a system contains. A processor includes both performance characteristics, clock speed, architecture, core count, and so on, and compatibility, such as the CPU ID instruction results.

URIs:

AccelerationFunctions (v1.4+) {objectThe link 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+) {objectThe link to an assembly 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 for processors of the FPGA type.
      ExternalInterfaces [ {arrayAn array of the FPGA external interfaces.
            Ethernet {objectThe Ethernet-related information for this FPGA interface.
                  MaxLanesintegerread-only (null)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.
For the possible property values, see InterfaceType in Property Details.
            PCIe { }
      } ]
objectThe PCI-e related information about this FPGA interface.
For property details, see PCIeInterface (v1.3.1).
      FirmwareIdstringread-onlyThe FPGA firmware identifier.
      FirmwareManufacturerstringread-onlyThe FPGA firmware manufacturer.
      FirmwareVersionstringread-onlyThe FPGA firmware version.
      FpgaTypestring
(enum)
read-onlyThe FPGA type.
For the possible property values, see FpgaType in Property Details.
      HostInterface {objectThe FPGA interface to the host.
            Ethernet {objectThe Ethernet-related information for this FPGA interface.
                  MaxLanesintegerread-only (null)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.
For the possible property values, see InterfaceType in Property Details.
            PCIe { }
      }
objectThe PCI-e related information about this FPGA interface.
For property details, see PCIeInterface (v1.3.1).
      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)An indication of whether the FPGA firmware can be reprogrammed from the host by using system software.
      ReconfigurationSlots [ {arrayAn array of the FPGA reconfiguration slots. An FPGA uses a reconfiguration slot to contain an acceleration function that can change as the FPGA is provisioned.
            AccelerationFunction {objectThe link to the acceleration function that the code programmed into a reconfiguration slot provides.
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)An indication of whether the reconfiguration slot can be reprogrammed from the host by using system software.
            SlotIdstringread-only (null)The FPGA reconfiguration slot identifier.
            UUID
      } ]
}
stringread-only (null)The UUID for this reconfiguration slot.
InstructionSetstring
(enum)
read-only (null)The instruction set of the processor.
For the possible property values, see InstructionSet in Property Details.
Links (v1.1+) {objectThe links to other Resources that are related to this Resource.
      Chassis {objectThe link to the chassis that 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 links to the processors directly connected to this processor.
            @odata.id
      } ]
stringread-onlyLink to another Processor resource.
      Endpoints (v1.4+) [ {arrayAn array of links 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+) {objectThe link to the PCIe device 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 links 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.
For property details, see Location.
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+) {objectThe link 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.
For the possible property values, see ProcessorArchitecture in Property Details.
ProcessorId {objectThe identification 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 raw manufacturer-provided CPUID instruction output 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)An indication of whether this memory is integrated within the processor.
      MemoryTypestring
(enum)
read-only (null)The type of memory used by this processor.
For the possible property values, see MemoryType in Property Details.
      SpeedMHz
} ]
integerread-only (null)The operating speed of the memory in MHz.
ProcessorTypestring
(enum)
read-only (null)The type of processor.
For the possible property values, see ProcessorType in Property Details.
Socketstringread-only (null)The socket or location of the processor.
Status { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
SubProcessors (v1.3+) {objectThe link to the collection of subprocessors 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 that this processor contains.
TotalEnabledCores (v1.5+)integerread-only (null)The total number of enabled cores that this processor contains.
TotalThreadsintegerread-only (null)The total number of execution threads that this processor supports.
UUID (v1.4+)stringread-only (null)The UUID for this processor.

Property Details

FpgaType:

The FPGA type.

stringDescription
DiscreteThe discrete FPGA device.
IntegratedThe FPGA device integrasted with other processor 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 CPU.
DSPA DSP.
FPGAAn FPGA.
GPUA GPU.
OEMAn OEM-defined processing unit.
Thread (v1.3+)A thread in a processor.

Example Response

{
    "@odata.type": "#Processor.v1_5_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.id": "/redfish/v1/Systems/437XR1138R2/Processors/CPU1"
}

ProcessorMetrics 1.0.2

v1.0
2018.3

The ProcessorMetrics schema contains usage and health statistics for a processor.

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, in watts, that the processor has consumed.
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 C-state level, such as C0, C1, or 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_2.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.2

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

The schema definition of the Resource Block, its components, and affinity to composed devices.

URIs:

CompositionStatus {object requiredThe composition status details for this Resource Block.
      CompositionStatestring
(enum)
read-only required (null)The current state of the Resource Block from a composition perspective.
For the possible property values, see CompositionState in Property Details.
      MaxCompositions (v1.1+)integerread-only (null)The maximum number of compositions in which this Resource Block can participate simultaneously.
      NumberOfCompositions (v1.1+)integerread-only (null)The number of compositions in which this Resource Block is currently participating.
      Reservedbooleanread-write (null)An indication of whether any client has reserved the Resource Block.
      SharingCapable (v1.1+)booleanread-only (null)An indication of whether this Resource Block can participate in multiple compositions simultaneously.
      SharingEnabled (v1.1+)
}
booleanread-write (null)An indication of whether this Resource Block is allowed to participate in multiple compositions simultaneously.
ComputerSystems [ {arrayAn array of links 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 links 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 links 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 {objectThe links to other Resources that are related to this Resource.
      Chassis [ {arrayAn array of links 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 links 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 links 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 links 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 links 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 links 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-onlyThe types of Resources available on this Resource Block.
For the possible property values, see ResourceBlockType in Property Details.
SimpleStorage [ {arrayAn array of links 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 { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
Storage [ {arrayAn array of links 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:

The current state of the Resource Block from a composition perspective.

stringDescription
ComposedFinal successful state of a Resource Block that has participated in composition.
ComposedAndAvailable (v1.1+)The Resource Block is currently participating in one or more compositions, and is available to use 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+)The Resource Block has been made unavailable by the service, such as due to maintenance being performed on the Resource Block.
UnusedThe Resource Block is free and can participate in composition.

ResourceBlockType:

The types of Resources available on this Resource Block.

stringDescription
ComputeThis Resource Block contains Resources of the Processor type and Memory type in a manner that creates a compute complex.
ComputerSystemThis Resource Block contains Resources of the ComputerSystem type.
ExpansionThis 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 Resources of the Memory type.
NetworkThis Resource Block contains network Resources, such as the EthernetInterface and NetworkInterface types.
ProcessorThis Resource Block contains Resources of the Processor type.
StorageThis Resource Block contains storage Resources, such as the Storage and SimpleStorage types.

Example Response

{
    "@odata.type": "#ResourceBlock.v1_3_2.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.id": "/redfish/v1/CompositionService/ResourceBlocks/ComputeBlock1"
}

Role 1.2.4

v1.2v1.1v1.0
2017.22017.11.0

The Role schema contains a Redfish Role to use in conjunction with a manager account.

URIs:

AssignedPrivileges [ ] array (string
(enum))
read-writeThe Redfish privileges for this Role.
For the possible property values, see AssignedPrivileges in Property Details.
IsPredefinedbooleanread-onlyAn indication of whether the Role is a Redfish-predefined Role rather than a custom Redfish Role.
OemPrivileges [ ] array
(string)
read-writeThe OEM privileges for this Role.
RoleId (v1.2+)stringread-only required on createThe name of the Role.

Property Details

AssignedPrivileges:

The Redfish privileges for this Role.

stringDescription
ConfigureComponentsCan configure components that this service manages.
ConfigureManagerCan configure managers.
ConfigureSelfCan change the password for the current user account.
ConfigureUsersCan configure users and their accounts.
LoginCan log in to the service and read Resources.

Example Response

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

SecureBoot 1.0.6

v1.0
2016.1

The SecureBoot schema contains UEFI Secure Boot information and 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.
For the possible property values, see SecureBootCurrentBoot in Property Details.
SecureBootEnablebooleanread-write (null)An indication of whether UEFI Secure Boot is enabled.
SecureBootModestring
(enum)
read-only (null)Current Secure Boot Mode.
For the possible property values, see SecureBootMode in Property Details.

Actions

ResetKeys

This action resets the Secure Boot keys.

URIs:

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

{
      ResetKeysType
}
string
(enum)
read-write requiredThe type of keys to reset or delete.
For the possible property values, see ResetKeysType in Property Details.

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.type": "#SecureBoot.v1_0_6.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": {},
    "@odata.id": "/redfish/v1/Systems/1/SecureBoot"
}

Sensor 1.0.2

v1.0
2018.3

The Sensor schema describes a sensor and its properties.

URIs:

Accuracynumber
(%)
read-only (null)The estimated percent error of measured versus actual values.
AdjustedMaxAllowableOperatingValuenumberread-only (null)The adjusted maximum allowable operating value for this equipment based on the environmental conditions.
AdjustedMinAllowableOperatingValuenumberread-only (null)The adjusted minimum allowable operating value for this equipment based on the environmental conditions.
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.
For the possible property values, see ElectricalContext in Property Details.
LoadPercentnumber
(%)
read-only (null)The power load utilization for this sensor.
Location { }objectThe location information for this sensor.
For property details, see Location.
MaxAllowableOperatingValuenumberread-only (null)The maximum allowable operating value for this equipment.
MinAllowableOperatingValuenumberread-only (null)The minimum allowable operating value for this equipment.
PeakReadingnumberread-only (null)The peak sensor value.
PeakReadingTimestringread-only (null)The time when the peak sensor value occurred.
PhysicalContextstring
(enum)
read-only (null)The area or device to which this sensor measurement applies.
For the possible property values, see PhysicalContext in Property Details.
PhysicalSubContextstring
(enum)
read-only (null)The usage or location within a device to which this sensor measurement applies.
For the possible property values, see PhysicalSubContext in Property Details.
PowerFactornumberread-only (null)The power factor for this sensor.
Precisionnumberread-only (null)The 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, in VAR units.
Readingnumberread-only (null)The sensor value.
ReadingRangeMaxnumberread-only (null)The maximum possible value for this sensor.
ReadingRangeMinnumberread-only (null)The minimum possible value for this sensor.
ReadingTypestring
(enum)
read-only (null)The type of sensor.
For the possible property values, see ReadingType in Property Details.
ReadingUnitsstringread-only (null)The units of the reading and thresholds.
SensingFrequencynumberread-only (null)The time interval between readings of the physical sensor.
SensorResetTimestringread-only (null)The date and time when the time-based properties were last reset.
Status { }objectThe status and health of the Resource and its subordinate or dependent Resources.
For property details, see Status.
Thresholds {objectThe set of thresholds defined for this sensor.
      LowerCaution {objectThe value at which the reading is below normal range.
            Activationstring
(enum)
read-write (null)The direction of crossing that activates this threshold.
For the possible property values, see Activation in Property Details.
            DwellTimestringread-write (null)The duration the sensor value must violate the threshold before the threshold is activated.
            Reading
      }
numberread-write (null)The threshold value.
      LowerCritical {objectThe value at which the reading is below normal range but not yet fatal.
            Activationstring
(enum)
read-write (null)The direction of crossing that activates this threshold.
For the possible property values, see Activation in Property Details.
            DwellTimestringread-write (null)The duration the sensor value must violate the threshold before the threshold is activated.
            Reading
      }
numberread-write (null)The threshold value.
      LowerFatal {objectThe value at which the reading is below normal range and fatal.
            Activationstring
(enum)
read-write (null)The direction of crossing that activates this threshold.
For the possible property values, see Activation in Property Details.
            DwellTimestringread-write (null)The duration the sensor value must violate the threshold before the threshold is activated.
            Reading
      }
numberread-write (null)The threshold value.
      UpperCaution {objectThe value at which the reading is above normal range.
            Activationstring
(enum)
read-write (null)The direction of crossing that activates this threshold.
For the possible property values, see Activation in Property Details.
            DwellTimestringread-write (null)The duration the sensor value must violate the threshold before the threshold is activated.
            Reading
      }
numberread-write (null)The threshold value.
      UpperCritical {objectThe value at which the reading is above normal range but not yet fatal.
            Activationstring
(enum)
read-write (null)The direction of crossing that activates this threshold.
For the possible property values, see Activation in Property Details.
            DwellTimestringread-write (null)The duration the sensor value must violate the threshold before the threshold is activated.
            Reading
      }
numberread-write (null)The threshold value.
      UpperFatal {objectThe value at which the reading is above normal range and fatal.
            Activationstring
(enum)
read-write (null)The direction of crossing that activates this threshold.
For the possible property values, see Activation in Property Details.
            DwellTimestringread-write (null)The duration the sensor value must violate the threshold before the threshold is activated.
            Reading
      }
}
numberread-write (null)The threshold value.
VoltageTypestring
(enum)
read-only (null)The voltage type for this sensor.
For the possible property values, see VoltageType in Property Details.

Actions

ResetStatistics

Resets 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 that share the 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 that share the 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 that share the 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:

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 a networking chip or chipset component.
BackThe back of the chassis.
BackplaneA backplane within the chassis.
ChassisThe entire chassis.
ComputeBayWithin a compute bay.
CoolingSubsystemThe entire cooling, or air and liquid, subsystem.
CPUA processor (CPU).
CPUSubsystemThe entire processor (CPU) subsystem.
DCBusA DC bus.
ExhaustThe air exhaust point or points or region of the chassis.
ExpansionBayWithin an expansion bay.
FanA fan.
FPGAAn FPGA.
FrontThe front of the chassis.
GPUA graphics processor (GPU).
GPUSubsystemThe entire graphics processor (GPU) subsystem.
IntakeThe air intake point or points 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:

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

stringDescription
InputThe input.
OutputThe output.

ReadingType:

The type of sensor.

stringDescription
AirFlowAirflow.
AltitudeAltitude.
BarometricBarometric pressure.
CurrentCurrent.
EnergyJoulesEnergy (Joules).
EnergykWhEnergy (kWh).
FrequencyFrequency.
HumidityRelative Humidity.
LiquidFlowLiquid flow.
LiquidLevelLiquid level.
PowerPower.
PressurePressure.
RotationalRotational.
TemperatureTemperature.
VoltageVoltage (AC or DC).

VoltageType:

The voltage type for this sensor.

stringDescription
ACAlternating current.
DCDirect durrent.

Example Response

{
    "@odata.type": "#Sensor.v1_0_2.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.5

v1.1v1.0
2017.11.0

The SerialInterface schema describes an asynchronous serial interface, such as an RS-232 interface, available to a system or device.

URIs:

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

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 follow the start bit ove