Redfish User Guide 5.

USER'S MANUAL
Revision 5.0
 Legal Disclaimer
The information in this USER’S GUIDE has been carefully reviewed and is believed to be
accurate. The vendor assumes no responsibility for any inaccuracies that may be contained in this
document, does not commit to update or to keep current the information in this manual, or to notify
any person or organization of the updates. Please Note: For the most up-to-date version of this
manual, please see our website at www.supermicro.com. Super Micro Computer, Inc.
(“Supermicro”) reserves the right to make changes to the product described in this manual at any
time and without notice. This product, including software, if any, and documentation may not, in
whole or in part, be copied, photocopied, reproduced, translated, or reduced to any medium or
machine without prior written consent. DISCLAIMER OF WARRANTY ON SOFTWARE AND
MATERIALS. You expressly acknowledge and agree that use of the Software and Materials is at
your sole risk. FURTHERMORE, SUPER MICRO COMPUTER INC. DOES NOT WARRANT OR
MAKE ANY REPRESENTATIONS REGARDING THE USE OR THE RESULTS OF THE USE OF
THE SOFTWARE OR MATERIALS IN TERMS OF THEIR CORRECTNESS, ACCURACY,
RELIABILITY, OR OTHERWISE. NO ORAL OR WRITTEN INFORMATION OR ADVICE GIVEN
BY SUPER MICRO COMPUTER INC. OR SUPER MICRO COMPUTER INC. AUTHORIZED
REPRESENTATIVE SHALL CREATE A WARRANTY OR IN ANY WAY INCREASE THE SCOPE
OF THIS WARRANTY. SHOULD THE SOFTWARE AND/OR MATERIALS PROVE DEFECTIVE,
YOU (AND NOT SUPER MICRO COMPUTER INC. OR A SUPER MICRO COMPUTER INC.
AUTHORIZED REPRESENTATIVE) ASSUME THE ENTIRE COST OF ALL NECESSARY
SERVICE, REPAIR, OR CORRECTION. LIMITATION OF LIABILITY. UNDER NO
CIRCUMSTANCES INCLUDING NEGLIGENCE, SHALL SUPER MICRO COMPUTER INC. BE
LIABLE FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES THAT RESULT
FROM THE USE OR INABILITY TO USE THE SOFTWARE OR MATERIALS, EVEN IF SUPER
MICRO COMPUTER INC. OR A SUPER MICRO COMPUTER INC. AUTHORIZED
REPRESENTATIVE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Any
disputes arising between manufacturer and customer shall be governed by the laws of Santa
Clara County in the State of California, USA. The State of California, County of Santa Clara shall
be the exclusive venue for the resolution of any such disputes. Super Micro's total liability for all
claims will not exceed the price paid for the hardware product.
 Revision History

Revision History
Revision Date Description
Added Redfish 2024.3 (1.21.0 version)
Added CPLD APIs URL Changes
Added StartTLS section
Added Boot Certificates section
Added ClearCMOS section (Support since X14/H14)
Added iHDT section (Support since H14)
Added S5 standby fan mode section (Support since X14/H14)
Added Remotely Standby Power Cycle section (Support since
X14/H14)
Added NodeManager section (Support since X14)
Modified Creating Logical Volume
Modified SecureBootMode
5.0 4/22/2025 Modified Updating BIOS Firmware
Modified Clearing Logs
Added NTP disable/enable section
Added NTP Auto Daylight saving section
Added LeakDetection section (Support in liquid cooling systems)
Added License Service section
Added Privilege Changes section
Added UBB CPLD section
Added CPU Power Capping section (Support since X14/H14)
Added ComponentIntegrity section
Added Assembly section
Added note in Event Service
Modified Deprecated APIs Section

3
 Revision History

Revision Date Description

Added Redfish 2021.2 (1.14.0 version)
Modified Configuring BIOS over Redfish
Modified FixedBootOrder
Added Create ScreenCapture, Download ScreenCapture,
Download VideoCapture, Download CrashScreenCapture, and
Download SDOReport
4.0 7/25/2024 Modified KCS Channel Control
Modified LLDP Section
Added Boot Certificate Section
Added Power and Thermal Resource Tree Section Modified
available APIs
Added APIs URL Changes Section
Added Deprecated APIs Section
Modified Event API's example payload
Added note that Simple Update API only supports BMC & BIOS
3.5 1/11/2024
Added POST example of certificate for Securebootdatabase
Added AuthFailureLoggingThreshold back to example payload
Fix URI to /redfish/v1/Registries/Base
Added 10.1.1 Check Task State
First HTML version
Added DNS setting
3.4 10/27/2023
Modified Available APIs
Modified RAID Configuration
Added support platform with Fixed Boot Order
Added support for Redfish version 1.11
Added the FixedBootOrder section
Modified the VirtualMedia section
3.3 09/04/2023 Updated the API URI list
Updated the NIC Firmware section
Added support for activating via the Redfish API

4
 Revision History

Revision Date Description

Fix URI to /redfish/v1/Registries/Base
Added 10.1.1 Check Task State
Deleted Section 6: AuthFailureLoggingThreshold:
Modified Section 8.3: Replacing a Certificate
Modified Section 9.4: SendTestEvent-> SubmitTestEvent
Modified Section 17,18: Method, Response of Jsonschema
3.2 04/06/2023 Deleted SMTP section (deprecated in RF 1.9)
Modified SNMP 19.2.1 Section
Modified Section: Available APIs

l /redfish/v1/Registries/BiosAttributeRegistry.v1_0_0

l /redfish/v1/UpdateService/FirmwareInventory/Backup_BIOS

l /redfish/v1/UpdateService/FirmwareInventory/Backup_BMC

5
 Applicable or Supported Platforms

Applicable or Supported Platforms

The Redfish Reference Guide applies since X12 and H12 platforms.

6
 Introduction

Introduction
The Redfish Scalable Platforms Management API ("Redfish") uses RESTful interface
semantics to access data defined in a model format to perform systems management. It is
suitable for a wide range of servers, from stand-alone to rack mount, blade, and even cloud
environments.

As a management standard, Redfish uses data model representation inside of a hypermedia

RESTful interface. Being based on REST makes it easier to use and implement than many
other solutions. Since it is model-oriented, it is capable of expressing the relationships between
components in modern systems as well as the semantics of the services and components
within them. It is also easily extensible. By using a hypermedia approach to REST, Redfish can
express a large variety of systems from multiple vendors. Utilizing JSON (JavaScript Object
Notation) data format, which is in plain text, allows many types of parameters to be available
such that it enables scalability, human readability, and flexibility for most programming
environments by easily interpreting payload.

The model is displayed in terms of an interoperable OData Schema with the payload of the
messages being expressed in JSON following OData JSON conventions. The schema
(available in both XML and JSON formats) includes annotations to facilitate the automatic
translation of the schema to JSON Schema. The ability to externally host the schema definition
of the resources in a machine-readable format allows the metadata to be associated with the
data without encumbering Redfish services with the metadata, thus enabling more advanced
client scenarios as found in many data centers and cloud environments.

Supermicro enables Redfish feature sets on Intel-based X10 and AMD-based H11 and later-
generation platforms. These features are covered under SFT- OOB- LIC and SFT- DCMS-
SINGLE licenses.

This document provides you with an overview of Restful API services and describes how to
receive Redfish API responses directly from a Supermicro BMC (Baseboard Management
Controller).

7
 HTTP Request Methods

HTTP Request Methods

Method Action Description
Read The method requests a representation of a specified resource. The
GET
Requests representation can be either a single resource or a collection.
PATCH Update The method applies partial modifications to a resource.
The method completely replaces a resource. Any properties omitted
PUT Replace
from the body of the request are reset to their default value.
The method creates a new resource. This request is submitted to the
POST Create
resource collection in which the new resource is meant to belong.
The method initiates operations on the object (Actions). The POST
POST Actions
operation may not be idempotent.
DELETE Delete The method removes a resource.

Responses
There are four types of responses:

Response Description
Metadata Resources and types are exposed by the service to generic clients.
Resource Responses An individual resource is displayed in JSON format.
Resource Collection JSON representation of a collection of resources.
Top-level JSON response providing additional information in the case of
Error
an HTTP error.

HTTP Status Code Description

Status Code Description
200 OK
201 Created
202 Accepted
204 No Content
301 Moved Permanently
302 Found
304 Not Modified

8
 HTTP Request Methods

Status Code Description

400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
405 Method Not Allowed
406 Not Acceptable
409 Conflict
410 Gone
411 Length Required
412 Precondition Failed
415 Unsupported Media Type
500 Internal Server Error
501 Not Implemented
503 Service Unavailable

9
 Using Restful APIs

Using Restful APIs

To receive API responses through programming, install Postman or any other Rest API client
application(s).

Authentication
You are required to have authentication to access certain resources. Redfish offers two
methods for users to access Redfish URLs: “basic authentication” and “Redfish session login
authentication.” The Service does not require you to create a session when Basic
Authentication is used.

Basic Authentication
HTTP basic authentication uses compliant TLS connections to transport the data between any
third-party authentication service and clients. Use local BMC credentials or remote protocols
like LDAP, Active Directory, or RADIUS to log in with basic authentication.

Session Management
You can use session management to implement authentication. This includes orphaned
session timeouts and several simultaneous open sessions. You can create up to 16 sessions.

Step 1: You can post the following username/password information in the payload field, which
will create a new session.

"UserName": "<username>",

"Password": "<password>"

The user will receive the “201” message code with the X-AUTH token created.

Session lifetime: For Redfish sessions, as long as you send requests for the session within the
session timeout period, the session will remain open and the session authentication token will
remain valid. If the session times out, the session will be automatically terminated.

According to Redfish specification, a user can define session time from 30 to 86400 seconds. If
you are not active in the defined time frame, the token will be rendered invalid. You can always
patch the “SessionTimeout” value if needed.

Example: [PATCH] https://BMC_ IP/redfish/v1/SessionService Payload: {"SessionTimeout":

50}

10
 Using Restful APIs

Session termination or logout: A Redfish session is terminated when you log out. This is
accomplished by performing the DELETE method on the session resource identified by the link
returned in the location header either when the session is created or if the Session ID is
returned in the response data. Using the DELETE method on a session by specifying the
session resource ID allows an administrator with sufficient privilege to terminate other users’
sessions from a different session.

Example: [DELETE] https://BMC_IP/redfish/v1/SessionService/Sessions/[num]

->Send->Status Code: 200 OK

11
 Firmware Inventory and Update Service

Firmware Inventory and Update Service

Firmware Inventory
FirmwareInventory represents firmware version information for each component on the server.

URI: /redfish/v1/UpdateService/FirmwareInventory

Method: GET

Response: 200

"@odata.type":
"#SoftwareInventoryCollection.SoftwareInventoryCollection",

"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory",

"Id": "UpdateService",

"Name": "Firmware Inventory Collection",

"[email protected]": 19,

"Members": [

"@odata.id":
"/redfish/v1/UpdateService/FirmwareInventory/BMC"

},

"@odata.id":
"/redfish/v1/UpdateService/FirmwareInventory/Backup_BMC"

},

"@odata.id":
"/redfish/v1/UpdateService/FirmwareInventory/Golden_BMC"

},

12
 Firmware Inventory and Update Service

"@odata.id":
"/redfish/v1/UpdateService/FirmwareInventory/Staging_BMC"

},

"@odata.id":
"/redfish/v1/UpdateService/FirmwareInventory/BIOS"

},

"@odata.id":
"/redfish/v1/UpdateService/FirmwareInventory/Backup_BIOS"

},

"@odata.id":
"/redfish/v1/UpdateService/FirmwareInventory/Golden_BIOS"

},

"@odata.id":
"/redfish/v1/UpdateService/FirmwareInventory/Staging_BIOS"

},

"@odata.id":
"/redfish/v1/UpdateService/FirmwareInventory/Capsule_BIOS"

},

"@odata.id":
"/redfish/v1/UpdateService/FirmwareInventory/Capsule_ME"

},

"@odata.id":
"/redfish/v1/UpdateService/FirmwareInventory/Capsule_MCU"

},

13
 Firmware Inventory and Update Service

"@odata.id":
"/redfish/v1/UpdateService/FirmwareInventory/Golden_CPLD_Motherboard"

},

"@odata.id":
"/redfish/v1/UpdateService/FirmwareInventory/CPLD_Motherboard"

},

"@odata.id":
"/redfish/v1/UpdateService/FirmwareInventory/CPLD_Backplane_1"

},

"@odata.id":
"/redfish/v1/UpdateService/FirmwareInventory/BIOS_ME"

},

"@odata.id":
"/redfish/v1/UpdateService/FirmwareInventory/NIC1"

},

"@odata.id":
"/redfish/v1/UpdateService/FirmwareInventory/NVMeController1"

},

"@odata.id":
"/redfish/v1/UpdateService/FirmwareInventory/PowerSupply1"

},

"@odata.id":
"/redfish/v1/UpdateService/FirmwareInventory/PowerSupply2"

14
 Firmware Inventory and Update Service

],

"Oem": {}

Firmware Resiliency Actions

Set the current active image as the golden template. If the current image is used as the golden
image by the golden template under Supermicro’s recommendation or the administrator’s
preference, then use this option to update the golden firmware image with the active firmware
image.

Allowable values for Targets:

BMC: Use "/redfish/v1/Managers/1" to update golden firmware image for BMC.

BIOS: Use "/redfish/v1/Systems/1" to update golden firmware image for BIOS.

URI: /redfish/v1/UpdateService/Actions/Oem/SmcUpdateService.Install

Method: POST

Payload:

"Targets":[ "/redfish/v1/Managers/1"],

"InstallOptions":["UpdateGolden"]

Response: 200

Updating BIOS Firmware

To perform BIOS firmware update, use the image file available on the local system:

Allowable values for @Redfish.OperationApplyTime:

l Immediate: Start BIOS firmware update immediately after POST action to

/redfish/v1/UpdateService/upload
l OnStartUpdateRequest: upload firmware with POST action upload API and then BIOS
firmware update will only start after POST action to

/redfish/v1/UpdateService/Actions/UpdateService.StartUpdate

StartUpdat API doesn’t require any parameter in the payload.

15
 Firmware Inventory and Update Service

URI: /redfish/v1/UpdateService/upload

Method: POST

Response: 202

UpdateParameters:

{"Targets": ["/redfish/v1/Systems/1/Bios"],

"@Redfish.OperationApplyTime": "Immediate",

"Oem": {"Supermicro": { "BIOS": { "PreserveME": true, "PreserveNVRAM": true,

"PreserveSMBIOS": true, "BackupBIOS": false }}}}

UpdateFile: <File>

Notes:
l Initiating a BIOS upgrade will first perform a system power off.

l On X12 (Whitley and Tatlow series), X13, and later platforms, only these commands
are available for use when using this method: PreserveOA, PreserveSETUPCONF,
PreserveSETUPPWD, PreserveSECBOOTKEY, PreserveBOOTCONF, and
UpdateRollbackID (note that this only works for RoT).
l With RoT, only these commands are available for use when using this method:
PreserveME, PreserveNVRAM, PreserveSMBIOS, and BackupBIOS.

Check BIOS update status in TaskService API.

URI: /redfish/v1/TaskService

Method: GET

Response: 200

When the update completes, check the BIOS version in UpdateService/FirmwareInventory.

Updating BMC Firmware

Use the image file available on the local system to update BMC firmware:

Allowable values for @Redfish.OperationApplyTime:

l Immediate: Start BMC firmware update immediately after POST action to
/redfish/v1/UpdateService/upload

16
 Firmware Inventory and Update Service

l OnStartUpdateRequest: upload firmware with POST action upload API and then BMC
firmware update will only start after POST action to
/redfish/v1/UpdateService/Actions/UpdateService.StartUpdate.

StartUpdate API doesn’t require any parameter in the URI: /redfish/v1/UpdateService/upload

Method: POST

Response: 202

UpdateParameters:

{"Targets": ["/redfish/v1/Managers/1"],

"@Redfish.OperationApplyTime": "Immediate",

"Oem": {"Supermicro": { "BMC": {"PreserveCfg":true, "PreserveSdr":true, "PreserveSsl":true,

"BackupBMC": true}}}

UpdateFile: <File>

Check BMC update status in TaskService API

URI: /redfish/v1/TaskService

Method: GET

Response: 200

When the the update completes, check the BMC version in UpdateService/FirmwareInventory

Updating CPLD Firmware

There are two types of CPLD firmware to be updated:

Use the image file available on the local system to update CPLD motherboard firmware:

URI: /redfish/v1/UpdateService/upload

Method: POST

Response: 202

UpdateParameters:

{"Targets":[ “/redfish/v1/UpdateService/FirmwareInventory/CPLD_Motherb

oard"], "@Redfish.OperationApplyTime":"Immediate"}

UpdateFile: <File>

17
 Firmware Inventory and Update Service

Note: After Motherboard CPLD update, it will trigger a BMC reset.

Use the image file available on the local system to update CPLD backplane firmware:

URI: /redfish/v1/UpdateService/FirmwareInventory

Method: POST

Response: 202

UpdateParameters:

{"Targets":[ /redfish/v1/UpdateService/FirmwareInventory/CPLD_Backplan

e_[id]"],"@Redfish.OperationApplyTime":"Immediate"}

UpdateFile: <File>

Simple Update
Simple Update only supports BMC and BIOS. You can update the installed software
component(s) as contained within a software image file located at a URI referenced by the
ImageURI parameter, and preserve BMC config, SSL, SDR, and SMBIOS, BIOS BootConfg by
default.

You are required to prepare the FTP, HTTP, or HTTPS file server to put BMC or BIOS firmware
image file.

It is advised to power off on the host side before conducting a BIOS FW update.

URI: /redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate

Method: POST

Response: 202

Payload:

"ImageURI": "<file ip>/<path and image file name>",

"TransferProtocol": "FTP",

"Targets": ["/redfish/v1/Managers/1"]

Target value:

For BIOS Update, use "/redfish/v1/Systems/1".

18
 Firmware Inventory and Update Service

For BMC Update, use "/redfish/v1/Managers/1".

Updating Broadcom Storage Controller Firmware

You can check if the controller firmware update is supported or not under
/redfish/v1/UpdateService/FirmwareInventory/Broadcom[num].

To update Broadcom firmware using the image file available on the local system:

URI: /redfish/v1/UpdateService/upload

Method: POST

Response: 202

UpdateParameters:

{"Targets":[ "/redfish/v1/Systems/1/Storage/HARAID#/StorageControllers/[num]"],"

@Redfish.OperationApplyTime":"OnStartUpdateRequest"}

UpdateFile: <File>

Note: Currently, this is supported to update HA-RAID 3108, 38xxIR, 39xx ,and BCOM
3916. After the update, it needs a system reboot for the new firmware to take effect.

Updating Marvell Storage Controller Firmware

You can check if the controller firmware update is supported or not under
/redfish/v1/UpdateService/FirmwareInventory/Marvell[num].

To update Marvell firmware using the image file on the local system:

URI: /redfish/v1/UpdateService/upload

Method: POST

Response: 202

UpdateParameters:

{"Targets":[ "/redfish/v1/Systems/1/Storage/MRVL.HARAID#/StorageControllers/[num]"],

"@Redfish.OperationApplyTime":"OnStartUpdateRequest"}

UpdateFile: <File>

19
 Firmware Inventory and Update Service

Updating AOC NIC Firmware

“NIC [num]” exists under the Redfish/v1 directory when your AOC NIC controller is supported.
To ensure that you can update the AOC NIC controller firmware, check if “NIC [num]” exists in
the URI /redfish/v1/UpdateService/FirmwareInventory/NIC[num].

To update AOC NIC firmware, use the image file on the local system:

URI: /redfish/v1/UpdateService/upload

Method: POST

Response: 202

UpdateParameters:

{"Targets":[ "//redfish/v1/UpdateService/FirmwareInventory/NIC[num]"],

"@Redfish.OperationApplyTime":"OnStartUpdateRequest"}

UpdateFile: <File>

Updating UBB CPLD Firmware

URI: /redfish/v1/UpdateService/upload

Method: POST

Response: 202

UpdateParameters:

{"Targets": [ “/redfish/v1/UpdateService/FirmwareInventory/UBB_ 1_ CPLD_ 1"],

"@Redfish.OperationApplyTime":"Immediate"}

UpdateFile: <File>

Updating UBB Retimer Firmware

URI: /redfish/v1/UpdateService/upload

Method: POST

Response: 202

UpdateParameters:

{"Targets": [ “/redfish/v1/UpdateService/FirmwareInventory/UBB_ 1_ Retimer_

1"],"@Redfish.OperationApplyTime":"Immediate""}

UpdateFile: <File>

20
 Firmware Inventory and Update Service

Updating SSL Certificate and Key

Update the SSL certificate and key for a secure web server connection.

URI: /redfish/v1/UpdateService/Oem/Supermicro/SSLCert/Actions/SmcSSLCert.Upload

Payload:

1. Change the type to “form-data”.

2. Select cert_file and key_file as keys, browse and select the respective files to upload.

21
 Account Service

Account Service
You can perform the following operations under /redfish/v1/AccountService.

Available Methods: Get,Patch

Creating a User
You can use the API and payload to create a new account and delete the respective accounts.

URI: /redfish/v1/AccountService/Accounts

Method: POST

Payload:

"UserName": "User_Name",

"Password": "User_Password",

"RoleId": "Administrator",

"Enabled": true

Note that the allowed values for “RoleId” are “Administrator”, “Operator”, and “ReadOnly”. You
can also verify the assigned privileges for different roles (“Administrator”, “Operator", and
“ReadOnly”) under /redfish/v1/AccountService/Roles.

Configuring User Lockout

URI: /redfish/v1/AccountService

Method: PATCH

Payload:

"AccountLockoutThreshold": 2,

"AccountLockoutDuration": 300,

"AccountLockoutCounterResetAfter": 300

22
 Account Service

Active Directory
URI: /redfish/v1/AccountService

Method: PATCH

Payload:

"ActiveDirectory": {"ServiceEnabled": true,

"ServiceAddresses": ["ldap://<IP>:389"],

"RemoteRoleMapping": [{"RemoteGroup": "cn=ipmiswqa,dc=satc,dc=com",

"LocalRole": "Administrator"}]}

LDAP
URI: /redfish/v1/AccountService

Method: PATCH

Payload:

"LDAP": {"ServiceEnabled": true,

"ServiceAddresses": ["ldap://<IP>:389"],

"Authentication": {"Username": "cn=Manager, dc=satc, dc=com",

"Password": "secret"},

"RemoteRoleMapping": [{"RemoteUser": "tester001", "LocalRole":

"Administrator"}],

"LDAPService": {"SearchSettings": {"BaseDistinguishedNames":

["dc=satc, dc=com"], "UsernameAttribute": "cn"}}

23
 BIOS Configuration

BIOS Configuration
Use BIOS APIs to configure properties related to BIOS. The Attribute Registry contains
system-specific BIOS attributes and their dependent attributes.

Note: Changes in BIOS attributes require a system reboot to take effect.

Changing a Password
URI: /redfish/v1/Systems/1/Bios/Actions/Bios.ChangePassword

Method: POST

Payload:

"PasswordName":"AdministratorPassword" or "UserPassword",

"OldPassword":"",

"NewPassword":"Password"

Configuring BIOS over Redfish

URI: /registries/BiosAttributeRegistry.1.0.0.json

Method: GET

Response:

"@odata.type": "#AttributeRegistry.v1_3_0.AttributeRegistry",

"Description": "This registry defines a representation of BIOS

Attribute instances",

"Id": "BiosAttributeRegistry.1_0_0",

"Language": "en",

"Name": "BIOS Attribute Registry",

"OwningEntity": "Supermicro",

"RegistryEntries": {

24
 BIOS Configuration

"Attributes": [

"AttributeName": "QuietBoot_0027",

"CurrentValue": true,

"DefaultValue": true,

"DisplayName": "Quiet Boot",

"GrayOut": false,

"HelpText": "Enables or disables Quiet Boot

option",

"Hidden": false,

"MenuPath": ".\/Advanced\/Boot Feature",

"ReadOnly": false,

"Type": "Boolean"

},

Attributes: Contains the attributes and their possible values

"AttributeName": "OptionROMMessages_0028",

"CurrentValue": "Force BIOS",

"DefaultValue": "Force BIOS",

"DisplayName": "Option ROM Messages",

"GrayOut": false,

"HelpText": "Set display mode for Option ROM",

"Hidden": false,

"MenuPath": ".\/Advanced\/Boot Feature",

"ReadOnly": false,

"Type": "Enumeration",

"Value": [

"ValueDisplayName": "Force BIOS",

25
 BIOS Configuration

"ValueName": "1"

},

"ValueDisplayName": "Keep Current",

"ValueName": "0"

},

Menu: Contains the attributes menus and their hierarchy

"Menus": [

"DisplayName": "Main",

"DisplayOrder": 1,

"Hidden": false,

"MenuName": "Main",

"MenuPath": ".\/Main",

"ReadOnly": false

},

"DisplayName": "Advanced",

"DisplayOrder": 2,

"Hidden": false,

"MenuName": "Advanced",

"MenuPath": ".\/Advanced",

"ReadOnly": false

},

Dependencies: Lists dependencies of attributes on each component

"Dependencies": [

26
 BIOS Configuration

"Dependency": {

"MapFrom": [

"MapFromAttribute":
"WatchDogFunction_002E",

"MapFromCondition": "EQU",

"MapFromProperty": "CurrentValue",

"MapFromValue": "Disabled"

],

"MapToAttribute": "WatchDogAction_0030",

"MapToProperty": "Hidden",

"MapToValue": true

},

"DependencyFor": "WatchDogAction_0030",

"Type": "Map"

},

Modifying BIOS Attributes

You can GET the current setting and PATCH desired settings.

URI: /redfish/v1/Systems/1/Bios

Method: PATCH

Response: 202

Payload:

"Attributes": {

"QuietBoot":false,

"PowerButtonFunction": "4 Seconds Override"}

27
 BIOS Configuration

Note: After PATCH, you need to reset the system to apply the values to BIOS.

Viewing Pending Settings

You can view any pending settings after PATCH.

URI: /redfish/v1/Systems/1/Bios/SD

Method: GET

Response: 200

"@odata.type": "#Bios.v1_1_1.Bios",

"@odata.id": "/redfish/v1/Systems/1/Bios/SD",

"Id": "SD",

"Name": "BIOS Configuration Pending Settings",

"AttributeRegistry": "BiosAttributeRegistry.v1_0_0",

"Description": "BIOS Configuration Pending Settings. These

settings will be applied on <Font color=blue size=3>the</font> next
system reboot.",

"Attributes": {

"PowerButtonFunction": "4 Seconds Override",

"QuietBoot": false

},

"@odata.etag": "\"6a07297d92419e04dfbec096920288b5\""

Resetting BIOS
POST a reset of the BIOS attributes to default values. After POST, you need to reset the
system to apply values to BIOS.

URI: /redfish/v1/Systems/1/Bios/Actions/Bios.ResetBios

Method: POST

Response: 200

28
 BIOS Configuration

Boot Options
Use Redfish to change system boot order.

Configuring the Boot Order in System BIOS

l BootSourceOverrideEnabled: Describes the state of the Boot Source Override feature.
l Disabled: The system will boot normally.
l Once: The system will boot (one time) to the Boot Source OverrideTarget.
l Continuous: The system will boot to the target specified in the Boot
SourceOverrideTarget until this property is set to Disabled.
l BootSourceOverrideMode: The BIOS Boot Mode (either Legacy or UEFI) to be used
when BootSourceOverrideTarget boot source is booted from.
l Legacy: The system will boot in non-UEFI boot mode to the Boot Source Override
Target.
l UEFI: The system will boot in UEFI boot mode to the Boot Source Override Target.
l BootSourceOverrideTarget: The current boot source to be used at the next boot
instead of the normal boot device if BootSourceOverrideEnabled is true.

The values are allowed to set BootSourceOverrideTarget.

l BootSourceOVerRideMode: UEFI
l Pxe
l Cd
l Usb
l Hdd
l BootSourceOVerRideMode: Legacy
l None
l Pxe
l Cd
l Floppy
l Usb
l Hdd

29
 BIOS Configuration

l BiosSetup
l UsbCd
l UefiBootNext

Example: Change BootSourceOverrideTarget to boot off virtual ISO.

URI: /redfish/v1/Systems/1

Method: PATCH

Payload:

Boot":{

"BootSourceOverrideEnabled":"Once",

"BootSourceOverrideMode":"Legacy",

"BootSourceOverrideTarget": "UsbCd" }

Configuring UefiBootNext
URI: /redfish/v1/Systems/1

Method: PATCH

Payload:

"Boot": {

"BootSourceOverrideTarget": "UefiBootNext",

"BootNext": "Hdd"}

FixedBootOrder
You can check and change the current boot order.

Support after Redfish 1.11 (2020.3), X13/H13, and future platform support.

30
 BIOS Configuration

Changing the Boot Order

Getting the Current Boot Order
URI: /redfish/v1/Systems/1/Oem/Supermicro/FixedBootOrder

Method: GET

Response: 200

"@odata.type": "#SmcFixedBootOrder.v1_0_0.SmcFixedBootOrder",

"@odata.id":
"/redfish/v1/Systems/1/Oem/Supermicro/FixedBootOrder",

"Id": "FixedBootOrder",

"Name": "Fixed Boot Order",

"BootModeSelected": "UEFI",

"FixedBootOrder": [

"UEFI USB CD/DVD:UEFI: ATEN Virtual CDROM YS0J",

"UEFI Hard Disk",

"UEFI AP:UEFI: Built-in EFI Shell",

"UEFI Network",

"UEFI USB Floppy",

"UEFI CD/DVD",

"UEFI USB Hard Disk",

"UEFI USB Key",

"UEFI USB Lan"

],

"FixedBootOrderDisabledItem": [

"Disabled"

],

"UEFIAP": [

"UEFI: Built-in EFI Shell"

],

31
 BIOS Configuration

"UEFIAPDisabledItem": [

"Disabled"

],

"UEFIUSBCD/DVD": [

"UEFI: ATEN Virtual CDROM YS0J"

],

"UEFIUSBCD/DVDDisabledItem": [

"Disabled"

],

"@odata.etag": "\"506cd4cf4c3409c7c1a8e90a53825cb6\""

Changing the Current Boot Order

For the property “FixedBootOrder,” the boot order arrangement is decided by the group.

URI: /redfish/v1/Systems/1/Oem/Supermicro/FixedBootOrder

Method: PATCH

Step 1. Set the boot order of device groups.

Payload:

"FixedBootOrder":["UEFI Hard Disk", "UEFI CD/DVD", "UEFI USB Hard

Disk",

"UEFI USB Key:UEFI OS (USB,Port:9)", "UEFI USB Floppy",

"UEFI USB Lan", "UEFI Network:(B3/D0/F0) UEFI PXE IPv4 Intel(R) I210
Gigabit Network Connection(MAC:7cc255144d22)",

"UEFI AP:UEFI: Built-in EFI Shell"]

Step 2. Set the boot order of devices in each device group.

Payload:

"UEFIUSBKey”:["UEFI OS (USB,Port:9)”, "UEFI OS (USB,Port:6)”]

32
 BIOS Configuration

It is the same group setting as that in the Supermicro BIOS Setup Menu.

URI: /redfish/v1/Systems/1/Oem/Supermicro/FixedBootOrder

Method: PATCH

Payload: Please refer to the notes below.

33
 BIOS Configuration

Notes:
l The amount of Device Group of PATCH payload should be equal to that of the

current fixed boot order setting.

l The fixed boot order cannot interlace different Device Groups.
l The amount of specific Device Group of PATCH payload should be equal to that of
the current specific Device Group.
l For each Device Group, the first boot device in the order cannot be disabled. The
disabled boot device must be after another enabled device.
l The Device Group and boot order of each Device Group should be changed if a user
prefers to change both the Device Group and the specific Device Group boot order in
the fix boot order setting.
l The new setting changes take effect after the system is reset.

Response: 202

Secure Boot
UEFI Secure Boot was created to enhance security in the pre-boot environment. Secure Boot
helps firmware, operating system and hardware providers cooperate to thwart the efforts of
malware developers.

Note: Please use the supported BIOS to use this function.

Enabling Redfish Secure Boot by GET

URI: /redfish/v1/Systems/1/SecureBoot

Method: GET

Response: 200

"@odata.type": "#SecureBoot.v1_0_5.SecureBoot",

"@odata.id": "/redfish/v1/Systems/1/SecureBoot",

"Id": "Security Boot",

"Name": "SecureBoot",

"SecureBootCurrentBoot": "Disabled",

34
 BIOS Configuration

"SecureBootEnable": false,

"SecureBootMode": "SetupMode",

"Actions": {

"Oem": {},

"#SecureBoot.ResetKeys": {

"target":
"/redfish/v1/Systems/1/SecureBoot/Actions/SecureBoot.ResetKeys",

"@Redfish.ActionInfo":
"/redfish/v1/Systems/1/SecureBoot/ResetKeysActionInfo"

Enabling Redfish Secure Boot by PATCH

URI: /redfish/v1/Systems/1/SecureBoot

Method: PATCH

Payload:

"SecureBootEnable" : true

Response: 202

Confirming in Pending Settings

URI: /redfish/v1/Systems/1/Bios/SD

Method: GET

Response: 200

"@odata.type": "#Bios.v1_1_1.Bios",

"@odata.id": "/redfish/v1/Systems/1/Bios/SD",

"Id": "SD",

"Name": "BIOS Configuration Pending Settings",

35
 BIOS Configuration

"AttributeRegistry": "BiosAttributeRegistry.v1_0_0",

"Description": "BIOS Configuration Pending Settings. These

settings will be applied on <Font color=blue size=3>the</font> next
system reboot.",

"Attributes": {

"PowerButtonFunction": "4 Seconds Override",

"QuietBoot": false

},

"@odata.etag": "\"6a07297d92419e04dfbec096920288b5\""

ResetKeyTypes URI: /redfish/v1/Systems/1/SecureBoot/Actions/SecureBoot.ResetKeys

Method: POST

Payload:

"ResetKeysType": "DeleteAllKeys"

ResetKeysType allowable values:

l "ResetAllKeysToDefault"
l "DeleteAllKeys"
l "DeletePK"

Enabling Secureboot in BIOS

Set the three attributes below to BIOS to enable secureboot.

URI: /redfish/v1/Systems/1/Bios

Method: PATCH

Payload:

"Attributes": {

"SecureBoot" : "Enabled",

"SecureBootMode": "User",

36
 BIOS Configuration

"ResetKeysType":"Delete PK Key"}

SecureBoot allowable values:

l "Enabled"
l "Disabled"

SecureBootMode allowable values:

l "Setup"
l "User"
l "Audit"
l "Deployed"

ResetKeyType allowable values:

l "Disabled"
l "Reset all keys to default"
l "Delete all keys"
l "Delete PK key"

Creating a Secure Boot Database

URI: /redfish/v1/Systems/1/SecureBoot/SecureBootDatabases/dbt/Certificates

Method: POST

Payload:

"CertificateString" : "-----BEGIN CERTIFICATE-----\[Standard PEM

Format]-----END CERTIFICATE-----", "CertificateType": "PEM"

Response: 201

"@odata.type": "#Certificate.v1_0_0.Certificate",

"@odata.id":
"redfish/v1/Systems/SecureBoot/SecureBootDatabases/dbt/Certificates/2",

"Id": 2,

37
 BIOS Configuration

"Name": "Authorized TimeStamps(dbt)",

"CerificateString": "- - - - - BEGIN CERTIFICATE-- - - - [Standard PEM Format]- - - - - END

CERTIFICATE-----",

"CeritificateType": "PEM",

"Issuer": {

"CommonName": "Microsoft Root Certificate Authority 2010",

"Subject": {

"CommonName": "Microsoft Root Certificate Authority 2010",

"ValidNotBefore": "Mar 21 13:42:24 2022 GMT",

"ValidNotAfter": "Mar 18 13:42:24 2022 GMT",

"OEM": {}

38
 Certificate Service

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

URI: /redfish/v1/CertificateService

Method: GET

Response: 200

"@odata.type": "#CertificateService.v1_0_1.CertificateService",

"@odata.id": "/redfish/v1/CertificateService",

"Id": "CertificateService",

"Name": "Certificate Service",

"CertificateLocations": {

"@odata.id":
"/redfish/v1/CertificateService/CertificateLocations"

},

"Actions": {

"Oem": {

},

"#CertificateService.GenerateCSR": {

"target":
"/redfish/v1/CertificateService/Actions/CertificateService.GenerateC
SR",

"@Redfish.ActionInfo":
"/redfish/v1/CertificateService/GenerateCSRActionInfo"

},

"#CertificateService.ReplaceCertificate": {

"target":
"/redfish/v1/CertificateService/Actions/CertificateService.ReplaceCe
rtificate",

39
 Certificate Service

"@Redfish.ActionInfo":
"/redfish/v1/CertificateService/ReplaceCertificateActionInfo"

Generating CSR
Generate a certificate signing request (CSR) for the SSL certificate.

Generating CSR Action Info

View the list of supported and required parameters to generate CSR.

URI: /redfish/v1/CertificateService/GenerateCSRActionInfo

Method: GET

Response: 200

"@odata.type": "#ActionInfo.v1_1_2.ActionInfo",

"@odata.id":
"/redfish/v1/CertificateService/GenerateCSRActionInfo",

"Id": "GenerateCSRActionInfo",

"Name": "Generate CSR Action Info",

"Parameters": [

"Name": "CommonName",

"Required": true,

"DataType": "String"

},

"Name": "AlternativeNames",

"Required": false,

"DataType": "StringArray"

40
 Certificate Service

},

"Name": "Organization",

"Required": true,

"DataType": "String"

},

"Name": "OrganizationalUnit",

"Required": true,

"DataType": "String"

},

"Name": "City",

"Required": true,

"DataType": "String"

},

"Name": "State",

"Required": true,

"DataType": "String"

},

"Name": "Country",

"Required": true,

"DataType": "String"

},

"Name": "Email",

"Required": false,

41
 Certificate Service

"DataType": "String"

},

"Name": "KeyPairAlgorithm",

"Required": false,

"DataType": "String",

"AllowableValues": [

"TPM_ALG_RSA"

},

"Name": "KeyBitLength",

"Required": false,

"DataType": "Number",

"MinimumValue": 1024,

"MaximumValue": 4096

},

"Name": "CertificateCollection",

"Required": true,

"DataType": "Object"

},

"Name": "KeyUsage",

"Required": false,

"DataType": "StringArray",

"AllowableValues": [

"ServerAuthentication"

42
 Certificate Service

],

"Oem": {}

Generating a CSR Request

This action is used to perform a certificate signing request.

URI: /redfish/v1/CertificateService/Actions/CertificateService.GenerateCSR

Method: POST

Payload:

"Country": "US"

"State": "California",

"City": "San Jose",

"Organization": "Supermicro Computer",

"OrganizationalUnit": "PM",

"CommonName": "Supermicro.com",

"KeyPairAlgorithm": "TPM_ALG_RSA",

"CertificateCollection": {"@odata.id":
"/redfish/v1/Managers/1/NetworkProtocol/HTTPS/Certificates"}

Response: 200

Viewing Certificate Details

URI: /redfish/v1/Managers/1/NetworkProtocol/HTTPS/Certificates/1

Method: GET

Response: 200

"@odata.type": "#Certificate.v1_1_0.Certificate",

43
 Certificate Service

"@odata.id":
"/redfish/v1/Managers/1/NetworkProtocol/HTTPS/Certificates/1",

"Id": "1",

"Name": "HTTPS Certificate",

"CertificateString": "-----BEGIN CERTIFICATE-----

\nMIIE3TCCA8WgAwIBAgIUcdkJIAr/gSwrinFL4k+XbWBnlR0wDQYJKoZIhvcNA

QEL\nBQAwgZ0xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMREwDw

YDVQQH\nEwhTYW4gSm9zZTEdMBsGA1UEChMUU3VwZXIgTWljcm8gQ29tcHV0ZXI

xETAPBgNV\nBAsTCFNvZnR3YXJlMQ0wCwYDVQQDEwRJUE1JMSUwIwYJKoZIhvcN

AQkBFhZzdXBw\nb3J0QHN1cGVybWljcm8uY29tMB4XDTIzMDUyMzAwMDAwMFoXD

TMzMDUyMzAwMDAw\nMFowgZ0xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm

9ybmlhMREwDwYDVQQH\nEwhTYW4gSm9zZTEdMBsGA1UEChMUU3VwZXIgTWljcm8

gQ29tcHV0ZXIxETAPBgNV\nBAsTCFNvZnR3YXJlMQ0wCwYDVQQDEwRJUE1JMSUw

IwYJKoZIhvcNAQkBFhZzdXBw\nb3J0QHN1cGVybWljcm8uY29tMIIBIjANBgkqh

kiG9w0BAQEFAAOCAQ8AMIIBCgKC\nAQEA3VUR7jUFM9R28bo4iXdTxxIsGgyNS5

0PMWud1LTIYN/U07ClLvkpOtHdFcDX\nak7Rr6SyDfcoBTA8pxVbnxJarwKLE0X

6IWYTAl5GGGydUL3RlZXqcVItx1GeXdTQ\ngQkbjGcHAHXDNnpPpIGp0YSZhAaH

XW8i6gGsU8kTKDLgiOVmF1+Ni6yOaxkJCNOa\nAVYH1Vi1UEwBdvmVF7FDdIVoY

rL/3lXKWijEFy/cy9WrloP0+kErf1TW9VB++gkH\nYhn7OLfVY9ao4ZugF3jOv3

bnymF8Kf5UYXmvVkEwYo3qeUWk2/i+hw/FTYEGAWyn\nqRkR7T8+M5+KCB6C/nF

4ei8XRwIDAQABo4IBETCCAQ0wHQYDVR0OBBYEFDNyIpBy\nqt3xgWWPYIzmTMMR

ue0xMIHdBgNVHSMEgdUwgdKAFDNyIpByqt3xgWWPYIzmTMMR\nue0xoYGjpIGgM

IGdMQswCQYDVQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTER\nMA8GA1UEBx

MIU2FuIEpvc2UxHTAbBgNVBAoTFFN1cGVyIE1pY3JvIENvbXB1dGVy\nMREwDwY

DVQQLEwhTb2Z0d2FyZTENMAsGA1UEAxMESVBNSTElMCMGCSqGSIb3DQEJ\nARYW

c3VwcG9ydEBzdXBlcm1pY3JvLmNvbYIUcdkJIAr/gSwrinFL4k+XbWBnlR0w\nD

AYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAWgZ7y++TsCziQnbMq/PB

\nKdD+fqT5vqYCBuW8oKrlTdLwq7JHd0KjXI3CXy1g+AY454qxEwRC9dltaxaXl

yTH\neF6WRQ/7fwpfkDE6II++yY1LCwGtmgw2pqbMepxlCEkSh2Ievlh2fGz3lB

44
 Certificate Service

MfKZLl\n/yIGKfyrslITUr3DdOQGoTU0/rh2rEcGHgkc7SOC2bKoi3S01pAl/zn

hzGTqObar\n4OZiOYSJWhMRJCqJsuJ9BClfL7leCGqNx2u9YyWtveNMb6bdsYOq

A3Vczuke6uIK\nysWtfiALcDr6RbZ1kE9HZ3BTTDJVX8TV3nlvc6KCh6KFNVYRK

liMTWS9fZdIg5FR\nsQ==\n-----END CERTIFICATE-----",

"CertificateType": "PEM",

"Issuer": {

"Country": "US",

"State": "California",

"City": "San Jose",

"Organization": "Super Micro Computer",

"OrganizationalUnit": "Software",

"CommonName": "IPMI",

"Email": "[email protected]"

},

"Subject": {

"Country": "US",

"State": "California",

"City": "San Jose",

"Organization": "Super Micro Computer",

"OrganizationalUnit": "Software",

"CommonName": "IPMI",

"Email": "[email protected]"

},

"ValidNotBefore": "2023-05-23T00:00:00+00:00",

"ValidNotAfter": "2033-05-23T00:00:00+00:00",

"KeyUsage": [

"ServerAuthentication"

],

"Actions": {

45
 Certificate Service

"Oem": {},

"#Certificate.Rekey": {

"target":
"/redfish/v1/Managers/1/NetworkProtocol/HTTPS/Certificates/1/Actions
/Certificate.Rekey",

"@Redfish.ActionInfo":
"/redfish/v1/Managers/1/NetworkProtocol/HTTPS/Certificates/1/RekeyAc
tionInfo"

},

"#Certificate.Renew": {

"target":
"/redfish/v1/Managers/1/NetworkProtocol/HTTPS/Certificates/1/Actions
/Certificate.Renew"

Replacing a Certificate
You can replace an existing certificate. Note that the new file must be a signed certificate.

Replacing Certificate Action Info

View the list of supported and required parameters to generate CSR.

URI: /redfish/v1/CertificateService/ReplaceCertificateActionInfo

Method: GET

Payload:

Response:

"@odata.type": "#ActionInfo.v1_1_2.ActionInfo",

46
 Certificate Service

"@odata.id":
"/redfish/v1/CertificateService/ReplaceCertificateActionInfo",

"Id": "ReplaceCertificateActionInfo",

"Name": "Replace Certificate Action Info",

"Parameters": [

"Name": "CertificateString",

"Required": true,

"DataType": "String"

},

"Name": "CertificateType",

"Required": true,

"DataType": "String",

"AllowableValues": [

"PEM"

},

"Name": "CertificateUri",

"Required": true,

"DataType": "Object"

],

"Oem": {}

Renewing a Certificate
URI: /redfish/v1/Managers/1/NetworkProtocol/HTTPS/Certificates/1/Actions/Certificate.Renew

Method: POST

47
 Certificate Service

Payload:

"CertificateString": "-----BEGIN CERTIFICATE REQUEST-----

\nMIICvjCCAaYCAQAweTELMAkGA1UEBhMCVVMxEzARBgNVBAgTCkNhbGlmb3JuaWEx\n

ETAPBgNVBAcTCFNhbiBKb3NlMRwwGgYDVQQKExNTdXBlcm1pY3JvIENvbXB1dGVy\nMQ

swCQYDVQQLEwJQTTEXMBUGA1UEAxMOU3VwZXJtaWNyby5jb20wggEiMA0GCSqG\nSIb3

DQEBAQUAA4IBDwAwggEKAoIBAQDHzmkX9rnVBenRS4OCAAbBN1JPXLSy5lUO\n8AYVzD

AyBKsivNZSD9PTXRFYHketUwzihQk8Km3/DbFd2sF9ZIPCc8tiBlS+5dkb\np9g6qilv

1FjvvVD0SYpYQl3km0JK1kh14AxEZARYfAI+j+RH/SA6+T6Nxzl2uB5K\nQQcMSdxjMJ

VF4Q7zMWVFP0NTN6oQkaXXATxh4o9G+SkdDCqVSXD47aYz+2Vfu8gR\nHCXptNYTElCD

N62iDoHAcPQjEuvloJqcKwXczFLgefUgsEQ9YzxYqx3lmpJrJYz/\nuUUbL1Flj7Tq91

FfPNtmRhIAMY8fGBrpqjJr9CsL7zMUV1R7DlWVAgMBAAGgADAN\nBgkqhkiG9w0BAQUF

AAOCAQEAsnEznugI2+IZpjXiI7l+I3yDDQlv0jwtgx7hYCu4\n6F5qlDRzzAlZNvBOop

ynEzkmmMq3vvpl2zdblEsYbLWcja+T1a+0UFgjILi1IIOM\nnJDk1pz34uzMAMQncAtJ

1wtE3NWI6n6+Ni0lvwSqPv5svQ+7zHITfwWbHR4KLyMF\nPM2+XA/47UIq4+SPDPSxSj

aWkFRXGrQKzy+aVH28X/SCVXEArU8UFDFfuILAHYKa\noFDM3n3tbWcWVRyZdSPZVXYE

9uWcZehlwIKh7t69gB6+WxjuONGCwviwNdX0x7A0\nLL8OdA5PISzKTGFESiEnGP914q

yovQ3QgtsZZNtFMAz66B==\n-----END CERTIFICATE REQUEST-----\n",

"CertificateType": "PEM",

"@odata.id":
"/redfish/v1/Managers/1/NetworkProtocol/HTTPS/Certificates/1"

Response: 200

Replacing the Key Certificate

This action shall generate a new key pair for an existing certificate using the existing certificate
data. The response shall contain a signing request that is to be signed by a certificate authority
(CA). The service should retain the private key used for the generation of this request when the
certificate is installed. The private key should not be part of the response.

URI: /redfish/v1/Managers/1/NetworkProtocol/HTTPS/Certificates/1/Actions/Certificate.Rekey

48
 Certificate Service

Method: POST

Payload:

KeyPairAlgorithm": "TPM_ALG_RSA"

Response: 200

49
 Certificate Service

License Service

Creating a New License

URI: /redfish/LicenseService/Licenses

Method: POST

Response: 201

Payload:

"LicenseString": "eyJQcm9kdWN0S2V5Ijp7Ik5vZG......(skip)"

Replacing a New License

URI: /redfish/LicenseService/Licenses

Method: POST

Response: 200

Payload:

"LicenseString": "eyJQcm9kdWN0S2V5Ijp7Ik5vZG......(skip)"

50
 Event Service

Event Service
The event service is an alert mechanism for Redfish. This alert will be sent out through HTTP or
HTTPS to a web service that is subscribed to the service.

Adding a Subscription
Edit a subscription to configure alerts/events.

URI: /redfish/v1/EventService/Subscriptions/[id]

Method: PATCH

Payload:

"Destination": "[email protected]",

"Context": "user1_test",

"EventTypes":["Alert","StatusChange"],

"Protocol": "SMTP",

"Oem":{"Supermicro":{

"Severity": "Information",

"EnableSubscription": true}}

Response: 200

Destination: Value shall contain a URI or email to the destination where the events will be
sent.

Context: Value is a client-supplied string that is stored with the event destination subscription.

EnableSubscription: Enable or Disable subscription by setting the value to be true or false.

Protocol: This property shall contain the protocol type that the event will use for sending the
event to the destination. A value of Redfish shall be used to indicate that the event type shall
adhere to that defined in the Redfish specification.

Allowable values:
l SNMPv1
l SMTP

51
 Event Service

l Redfish
l SNMPv3

EventTypes: This property shall contain the types of events you want to receive.

Allowable values:
l StatusChange
l ResourceUpdated
l ResourceAdded
l ResourceRemoved
l Alert

Severity: This property shall contain the severity of the event that you want to configure.

Allowable values:
l Information
l Warning
l Critical

Note: MI300X now supports event subscription with Redfish and SMTP.

Viewing All Subscriptions

To view all subscriptions, follow these steps.

URI: /redfish/v1/EventService/Subscriptions

Method: GET

"@odata.type":
"#EventDestinationCollection.EventDestinationCollection",

"@odata.id": "/redfish/v1/EventService/Subscriptions",

"Name": "Event Subscriptions Collection",

"Members": [

"@odata.id":
"/redfish/v1/EventService/Subscriptions/1"

},

52
 Event Service

"@odata.id":
"/redfish/v1/EventService/Subscriptions/2"

},

"@odata.id":
"/redfish/v1/EventService/Subscriptions/3"

},

"@odata.id":
"/redfish/v1/EventService/Subscriptions/4"

},

"@odata.id":
"/redfish/v1/EventService/Subscriptions/5"

},

"@odata.id":
"/redfish/v1/EventService/Subscriptions/6"

},

"@odata.id":
"/redfish/v1/EventService/Subscriptions/7"

},

"@odata.id":
"/redfish/v1/EventService/Subscriptions/8"

},

"@odata.id":
"/redfish/v1/EventService/Subscriptions/9"

53
 Event Service

},

"@odata.id":
"/redfish/v1/EventService/Subscriptions/10"

},

"@odata.id":
"/redfish/v1/EventService/Subscriptions/11"

},

"@odata.id":
"/redfish/v1/EventService/Subscriptions/12"

},

"@odata.id":
"/redfish/v1/EventService/Subscriptions/13"

},

"@odata.id":
"/redfish/v1/EventService/Subscriptions/14"

},

"@odata.id":
"/redfish/v1/EventService/Subscriptions/15"

},

"@odata.id":
"/redfish/v1/EventService/Subscriptions/16"

],

"[email protected]": 16

54
 Event Service

Deleting a Subscription
You can delete or erase a subscription.

URI: /redfish/v1/EventService/Subscriptions/[num]

Method: DELETE

Testing an Event Subscription

You can send a test event with “SendTestEvent” or generate an event in the BMC, Redfish will
then automatically send event alerts to the subscriber(s).

URI: /redfish/v1/EventService/Actions/EventService.SubmitTestEvent

Payload: <be>

"MessageId": "SMC.v1.0 TestAlert"

You need to implement a RESTful event listener that can receive HTTP or HTTPS POST data
that describes the Redfish event format. It can also subscribe to multiple services.

Refer to the Redfish-Event-Listener project page at GitHub to test Event Subscriptions or setup
a Redfish Event Listener.

Example of data from Redfish Event Listener:

Time:Tue Feb 12 16:49:28 2019 Count:1

Host IP:('BMC_IP', 38486)

Event Details:{'@odata.context':

'/redfish/v1/$metadata#EventService/Members/Events/58', '@odata.id':

'/redfish/v1/EventService/Events/58', '@odata.type':

'#EventService.v1_0_0.Event', 'Id': '58', 'Name': 'Event Array',

'Events': [{'EventType': 'Alert', 'Severity': 'OK', 'EventTimestamp':

'2019/02/13 00:49:04', 'Message': 'Submit Test Event', 'MessageArgs':

['/redfish/v1/EventService/Actions'], 'MessageId': '0',

'OriginOfCondition': {'@odata.id': '/redfish/v1/EventService'},

55
 Event Service

'Context': 'Public'}]}

Time:Tue Feb 12 16:52:24 2019 Count:2

Host IP:('BMC_IP', 38500)

Event Details:{'@odata.context':

'/redfish/v1/$metadata#EventService/Members/Events/59', '@odata.id':

'/redfish/v1/EventService/Events/59', '@odata.type':

'#EventService.v1_0_0.Event', 'Id': '59', 'Name': 'Event Array',

'Events': [{'EventType': 'Alert', 'Severity': 'Info',

'EventTimestamp': '2019/02/13 00:52:00', 'Message': 'Web login was

successful.', 'MessageArgs': [], 'MessageId': 'Alert.1.0.LoginWeb',

'OriginOfCondition': {}, 'Context': 'Public'}]}

56
 Virtual Media Management

Virtual Media Management

Mounting and Configuring the Virtual Media Settings

URI: /redfish/v1/Managers/1/VirtualMedia/VirtualMedia [mounted dev
num]/Actions/VirtualMedia.InsertMedia

Method: POST

Payload:

"Image": "<host>/<path>",

"UserName": "some_username",

"Password": "some_password"

Response: 202

Checking the Task State

URI: /redfish/v1/TaskService/Tasks/[TASK_NUM]

Method: Get

Verifying the ISO was Mounted by the Redfish Command

URI: /redfish/v1/Managers/1/VirtualMedia/VirtualMedia[mounted_dev_num]

Method: GET

Payload:

Unmounting the ISO

URI: /redfish/v1/Managers/1/VirtualMedia/VirtualMedia [mounted_ dev_
num]/Actions/VirtualMedia.EjectMedia

Method: POST

Payload:

57
 Virtual Media Management

Verifying the ISO was Unmounted by the Redfish Command

Verify whether the ISO was unmounted using the Redfish command; the node should be
removed.

URI: /redfish/v1/Managers/1/VirtualMedia/VirtualMedia[mounted_dev_num]

Method: GET

Response: 200

58
 Device Management

Device Management
You can find details about all available network devices at /redfish/v1/Chassis/1/PCIeDevices

NIC Device
URI: /redfish/v1/Chassis/1/PCIeDevices/NIC1

Method: GET

Response: 200

"@odata.type": "#PCIeDevice.v1_4_0.PCIeDevice",

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/NIC1",

"Id": "NIC1",

"Name": "PCIeDevices",

"Description": "NIC device (riser: RSC-D-6G5)",

"Manufacturer": "Supermicro",

"Model": "",

"SerialNumber": "",

"PartNumber": "",

"DeviceType": "MultiFunction",

"FirmwareVersion": "",

"Status": {

"State": "Disabled",

"Health": "OK",

"HealthRollup": "OK"

},

"PCIeInterface": {

"PCIeType": "Gen1",

"MaxPCIeType": "Gen5",

"LanesInUse": 8,

59
 Device Management

"MaxLanes": 8

},

"PCIeFunctions": {

"@odata.id":
"/redfish/v1/Chassis/1/PCIeDevices/NIC1/PCIeFunctions"

},

"Links": {

"Chassis": [

"@odata.id": "/redfish/v1/Chassis/1"

},

"Oem": {}

GPU
URI: /redfish/v1/Chassis/1/PCIeDevices/GPU1

Method: GET

Response: 200

NVMeSSD
URI: /redfish/v1/Chassis/1/PCIeDevices/NVMeSSD1

Method: GET

Response: 200

PCIe Functions
URI: /redfish/v1/Chassis/1/PCIeDevices/GPU1/PCIeFunctions/1

Method: GET

Response: 200

60
 RAID Management

RAID Management
You can manage RAID using storage subsystem schema and its properties. Storage APIs
represent a set of controllers and its resources like volumes, drives, etc. For details about
storage controller firmware updates, see "Updating Broadcom Storage Controller Firmware" on
page 19 or "Updating Marvell Storage Controller Firmware" on page 19.

URI: /redfish/v1/Systems/1/Storage

Method: GET

Response: 200

Viewing Details of HA-RAID Controller, Drive, and Volume

URI: /redfish/v1/Systems/1/Storage/HA-RAID

Method: GET

Response: 200

"@odata.type": "#Storage.v1_9_0.Storage",

"@odata.id": "/redfish/v1/Systems/1/Storage/HA-RAID",

"Id": "HA-RAID",

"Name": "HA Storage System",

"StorageControllers": [

"@odata.id": "/redfish/v1/Systems/1/Storage/HA-
RAID#/StorageControllers/0",

"MemberId": "0",

"Manufacturer": "Broadcom",

"Model": "SAS 3908",

"SerialNumber": "FW-00000000",

"FirmwareVersion": "5.240.02-3768",

"Status": {

"State": "Enabled",

61
 RAID Management

"Health": "OK"

},

"Identifiers": [

"DurableName": null

],

"SupportedControllerProtocols": [

"I2C",

"PCIe"

],

"SupportedDeviceProtocols": [

"SATA",

"SAS"

],

"Oem": {

"Supermicro": {

"@odata.type": "#SmcStorageExtensions.v1_
0_0.StorageController",

"BIOSBootMode": "PauseOnError",

"JBODMode": "Disable",

"BBU": {

"Status": {

"State": "Enabled",

"Health": "OK"

},

"BBUStatus": "Not Install"

62
 RAID Management

],

"Controllers": {

"@odata.id": "/redfish/v1/Systems/1/Storage/HA-
RAID/Controllers"

},

"Drives": [

"@odata.id": "/redfish/v1/Chassis/HA-
RAID.0.StorageEnclosure.0/Drives/Disk.Bay.1"

},

"@odata.id": "/redfish/v1/Chassis/HA-
RAID.0.StorageEnclosure.0/Drives/Disk.Bay.5"

],

"Volumes": {

"@odata.id": "/redfish/v1/Systems/1/Storage/HA-
RAID/Volumes"

},

"Links": {

"Enclosures": [

"@odata.id": "/redfish/v1/Chassis/HA-
RAID.0.StorageEnclosure.0"

],

"SimpleStorage": {

"@odata.id": "/redfish/v1/Systems/1/SimpleStorage/1"

63
 RAID Management

},

"Actions": {

"Oem": {

"#SmcHARAIDController.Save": {

"target": "/redfish/v1/Systems/1/Storage/HA-
RAID/Actions/Oem/SmcHARAIDController.Save",

"@Redfish.ActionInfo":
"/redfish/v1/Systems/1/Storage/HA-RAID/Oem/Supermicro/SaveActionInfo"

},

"#SmcStorage.CreateVolume": {

"target": "/redfish/v1/Systems/1/Storage/HA-
RAID/Actions/Oem/SmcStorage.CreateVolume",

"@Redfish.ActionInfo":
"/redfish/v1/Systems/1/Storage/HA-
RAID/Oem/Supermicro/CreateVolumeActionInfo"

},

"#SmcStorage.ClearVolumes": {

"target": "/redfish/v1/Systems/1/Storage/HA-
RAID/Actions/Oem/SmcStorage.ClearVolumes",

"@Redfish.ActionInfo":
"/redfish/v1/Systems/1/Storage/HA-
RAID/Oem/Supermicro/ClearVolumesActionInfo"

},

"Oem": {

},

"Description": "External RAID",

"Status": {

"State": "Enabled",

64
 RAID Management

"Health": "OK"

},

"@odata.etag": "\"55ae4cf460abfdb1c5fc50d7e434f83f\""

Viewing Details of HBA Controller, Drive and Volume

URI: /redfish/v1/Systems/1/Storage/HBA

Method: GET

Response: 200

"@odata.type": "#Storage.v1_9_0.Storage",

"@odata.id": "/redfish/v1/Systems/1/Storage/HBA",

"Id": "HBA",

"Name": "HBA Storage System",

"StorageControllers": [

"@odata.id":
"/redfish/v1/Systems/1/Storage/HBA#/StorageControllers/0",

"MemberId": "0",

"Manufacturer": "Broadcom",

"Model": "SAS3808",

"SerialNumber": "UA20CS003047R101",

"FirmwareVersion": "23.00.00.00",

"Status": {

"State": "Enabled",

"Health": "OK"

},

"Identifiers": [

65
 RAID Management

"DurableName": null

],

"SupportedControllerProtocols": [

"PCIe"

],

"SupportedDeviceProtocols": [

"SATA",

"SAS"

],

"Oem": {

],

"Controllers": {

"@odata.id":
"/redfish/v1/Systems/1/Storage/HBA/Controllers"

},

"Drives": [

],

"Volumes": {

"@odata.id": "/redfish/v1/Systems/1/Storage/HBA/Volumes"

},

"Links": {

"Enclosures": [

],

"SimpleStorage": {

"@odata.id": "/redfish/v1/Systems/1/SimpleStorage/1"

66
 RAID Management

},

"Oem": {

},

"Description": "External HBA",

"Status": {

"State": "Enabled",

"Health": "OK"

},

"@odata.etag": "\"a1ff5f1e00a725b15fb667521d51b022\""

Creating LSI31XX/38XXIR/39XX/4116 Logical Volume

URI: /redfish/v1/Systems/1/Storage/HA-RAID/Actions/Oem/SmcStorage.CreateVolume

Method: POST

Payload:

"ControllerId":0,

"Raid": "RAID0",

"Span": 1,

"PhysicalDrives":["HA-RAID.0.Disk.0", "HA-RAID.0.Disk.1"],

"UsePercentage":100,

"LogicalDriveCount":1,

"StripSizePerDDF":"256K",

"LdReadPolicy": "NoReadAhead",

"LdWritePolicy": "WriteBack",

"LdIOPolicy": "DirectIO",

"AccessPolicy": "ReadWrite",

"DiskCachePolicy": "Unchanged",

"InitState": "NoInit",

67
 RAID Management

"VdName": "VD"

Response: 200

Locating Physical HDD

URI: /redfish/v1/Chassis/HA- RAID. [controller_ num].StorageEnclosure. [enclosure_
num]/Drives/Disk.Bay .[disk_num]/Actions/Oem/SmcDrive.Indicate

Method: POST

Payload:

"Active": true

Response: 200

Locating Logical Volume

URI: /redfish/v1/Systems/1/Storage/HA- RAID/Volumes/Controller. [controller_ num].Volume.
[volume_num]/Actions/Oem/SmcVolume.Indicate

Method: POST

Payload:

"Active": true

Response: 200

Deleting a Logical Volume

URI: /redfish/v1/Systems/1/Storage/HA- RAID/Volumes/Controller. [controller_ num].Volume.
[volume_num]/Actions/Oem/SmcVolume.Delete

Method: POST

Payload:

68
 RAID Management

Response: 200

Clearing All Logical Volumes

URI: /redfish/v1/Systems/1/Storage/HA-RAID/Actions/Oem/SmcStorage.ClearVolumes

Method: POST

Payload:

"ControllerId":0

Response: 200

Saving HA-Raid Controller Configuration

URI: /v1/Systems/1/Storage/HA-RAID/Actions/Oem/SmcHARAIDController.Save

Method: PATCH

Payload:

"ControllerId":0,

"BIOSBootMode":"PauseOnError",

"JBODMode": "Enable"

Response: 200

Viewing Details of Marvell Controller, Drive, and Volume

URI: /redfish/v1/Systems/1/Storage/MRVL.HA-RAID

Method: GET

Response: 200

Creating a Virtual Drive for Marvell

URI: /redfish/v1/Systems/1/Storage/MRVL.HA-RAID/Actions/Oem/SmcStorage.CreateVD

69
 RAID Management

Method: POST

Payload:

"PD":["MRVL.HA-RAID.0.StorageModule/Drives/Disk.Bay.0","MRVL.HA-
RAID.0.StorageModule/Drives/Disk.Bay.1"],

"RaidLevel": "RAID1",

"StripeBlock": "64K",

"VDName": "SuperDrive"

Deleting a Virtual Drive for Marvell

URI: /redfish/v1/Systems/1/Storage/MRVL.HA- RAID/Volumes/Controller. [controller_
num].Volume.[volume_num]/Actions/Oem/SmcVolume.DeleteVD/

Method: POST

Payload:

Rebuilding a Virtual Drive for Marvell

URI: /redfish/v1/Systems/1/Storage/MRVL.HA- RAID/Volumes/Controller. [controller_
num].Volume.[volume_num]/Actions/Oem/SmcVo lume.RebuildVD

Method: POST

Payload:

Importing a Virtual Drive for Marvell

Insert or import a VD and register its UUID to Marvell FW. Wait for the next system power-on,
and this UUID will be registered at Marvell FW.

URI: /redfish/v1/Systems/1/Storage/MRVL.HA- RAID/Volumes/Controller. [controller_

num].Volume.[volume_num]/Actions/Oem/SmcVolume.ImportVD

70
 RAID Management

Method: POST

Payload:

NVME SSD
View NVME storage details.

URI: /redfish/v1/Systems/1/Storage/NVMeSSD

Method: GET

Response: 200

71
 Network Management

Network Management
EthernetInterfaces resources are used to manage BMC network configuration.

Viewing Network Settings

URI: /redfish/v1/Managers/1/EthernetInterfaces/1

Method: GET

Response: 200

"@odata.type": "#EthernetInterface.v1_6_3.EthernetInterface",

"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/1",

"Id": "1",

"Name": "Manager Ethernet Interface",

"Description": "Management Network Interface",

"Status": {

"State": "Enabled",

"Health": "OK"

},

"InterfaceEnabled": true,

"LinkStatus": "LinkUp",

"MACAddress": "3C:EC:EF:3B:FF:FF",

"SpeedMbps": 1000,

"[email protected]": [

"100",

"1000"

],

"AutoNeg": true,

"FullDuplex": true,

"MTUSize": 1500,

72
 Network Management

"HostName": "local",

"FQDN": "local.supermicro.com",

"MaxIPv6StaticAddresses": 5,

"VLAN": {

"VLANEnable": false,

"VLANId": 0

},

"DHCPv4": {

"DHCPEnabled": true,

"UseDNSServers": false,

"UseGateway": true,

"UseNTPServers": false,

"UseStaticRoutes": false,

"UseDomainName": false,

"FallbackAddress": "None"

},

"DHCPv6": {

"OperatingMode": "Stateless",

"UseDNSServers": false,

"UseDomainName": false,

"UseNTPServers": false,

"UseRapidCommit": false

},

"IPv4Addresses": [

"Address": "10.10.10.221",

"SubnetMask": "255.255.255.0",

"AddressOrigin": "DHCP",

"Gateway": "10.10.10.1"

73
 Network Management

],

"StatelessAddressAutoConfig": {

"IPv4AutoConfigEnabled": false,

"IPv6AutoConfigEnabled": true

},

"IPv4StaticAddresses": [

"Address": null,

"SubnetMask": null,

"Gateway": null

],

"IPv6StaticAddresses": [

"Address": "::",

"PrefixLength": 64

},

"Address": "::",

"PrefixLength": 64

},

"Address": "::",

"PrefixLength": 64

},

"Address": "::",

"PrefixLength": 64

74
 Network Management

},

"Address": "::",

"PrefixLength": 64

],

"IPv6StaticDefaultGateways": [

],

"IPv6DefaultGateway": "fe80::37a8:5e61:4a0b:c0c7",

"IPv6Addresses": [

"Address": "2111:1111::3eec:efff:fe3b:e02f",

"PrefixLength": 64,

"AddressOrigin": "SLAAC",

"AddressState": "Preferred"

},

"Address": "fe80::3eec:efff:fe3b:e02f",

"PrefixLength": 64,

"AddressOrigin": "LinkLocal",

"AddressState": "Preferred"

],

"NameServers": [

"2111:1111::fd",

"10.10.10.205"

],

"StaticNameServers": [

"10.10.10.205",

75
 Network Management

"10.10.10.226",

"2001:db8::fd"

],

"Oem": {

"Supermicro": {

"@odata.type": "#SmcEthernetInterfaceExtensions.v1_
0_1.EthernetInterface",

"IPProtocolStatus": "Dual",

"UDID":
"0E:00:00:01:00:01:2C:4A:A1:C3:3C:EC:EF:3B:E0:2F",

"LANInterface": "Failover",

"[email protected]": [

"Dedicated",

"Shared",

"Failover"

],

"ActiveInterface": "Dedicated"

},

"@odata.etag": "\"5667f8ea43ffd014901700ad70073bb2\""

IPv6 Configuration
URI: /redfish/v1/Managers/1/EthernetInterfaces/1

Method: PATCH

Payload:

"IPv6StaticAddresses":[{"Address": "<IP>", "PrefixLength": 64}]

76
 Network Management

Host Interface
Enabling Host Interface
URI: /redfish/v1/Managers/1/HostInterfaces/1

Method: PATCH

Payload:

"InterfaceEnabled": true

Response:

"@odata.type": "#HostInterface.v1_2_2.HostInterface",

"@odata.id": "/redfish/v1/Managers/1/HostInterfaces/1",

"Id": "1",

"Name": "Host Interface",

"Description": "Management Host Interface",

"HostInterfaceType": "NetworkHostInterface",

"Status": {

"State": "Enabled",

"Health": "OK"

},

"InterfaceEnabled": true,

"ExternallyAccessible": false,

"AuthenticationModes": [

"BasicAuth",

"RedfishSessionAuth"

],

"HostEthernetInterfaces": {

77
 Network Management

"@odata.id":
"/redfish/v1/Managers/1/HostInterfaces/1/HostEthernetInterfaces"

},

"ManagerEthernetInterface": {

"@odata.id":
"/redfish/v1/Managers/1/EthernetInterfaces/ToHost"

},

"NetworkProtocol": {

"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol"

},

"Links": {

"ComputerSystems": [

"@odata.id": "/redfish/v1/Systems/1"

},

"Oem": {}

Editing a Host IP Address

URI: /redfish/v1/Systems/1/EthernetInterfaces/ToManager

Method: PATCH

Payload:

"IPv4StaticAddresses":[{"Address": "169.254.3.<num>"}]

78
 Telemetry Service

Telemetry Service
TelemetryService represents metrics collection and data logs for power consumption on the
server. TelemetryService contains the below-collected resources.

URI: /redfish/v1/TelemetryService

Method: GET

Response: 200

"@odata.type": "#TelemetryService.v1_2_0.TelemetryService",

"@odata.id": "/redfish/v1/TelemetryService",

"Id": "TelemetryService",

"Name": "Telemetry Service",

"Status": {

"State": "Enabled",

"Health": "OK"

},

"SupportedCollectionFuntions": [

"Average",

"Minimum",

"Maximum"

],

"MetricDefinitions": {

"@odata.id":
"/redfish/v1/TelemetryService/MetricDefinitions"

},

"MetricReportDefinitions": {

"@odata.id":
"/redfish/v1/TelemetryService/MetricReportDefinitions"

},

"MetricReports": {

79
 Telemetry Service

"@odata.id": "/redfish/v1/TelemetryService/MetricReports"

Metric Definitions
Metric Definitions contain the definition, metadata, or characteristics of a metric.

URI: /redfish/v1/TelemetryService/MetricDefinitions

Method: GET

Response: 200

"@odata.type":
"#MetricDefinitionCollection.MetricDefinitionCollection",

"@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions",

"Id": "MetricDefinitions",

"Name": "Metric Definitions",

"Description": "Metric Definitions view",

"[email protected]": 9,

"Members": [

"@odata.id":
"/redfish/v1/TelemetryService/MetricDefinitions/AvgPowerConsumedHour"

},

"@odata.id":
"/redfish/v1/TelemetryService/MetricDefinitions/MinPowerConsumedHour"

},

"@odata.id":
"/redfish/v1/TelemetryService/MetricDefinitions/MaxPowerConsumedHour"

},

80
 Telemetry Service

"@odata.id":
"/redfish/v1/TelemetryService/MetricDefinitions/AvgPowerConsumedDay"

},

"@odata.id":
"/redfish/v1/TelemetryService/MetricDefinitions/MinPowerConsumedDay"

},

"@odata.id":
"/redfish/v1/TelemetryService/MetricDefinitions/MaxPowerConsumedDay"

},

"@odata.id":
"/redfish/v1/TelemetryService/MetricDefinitions/AvgPowerConsumedWeek"

},

"@odata.id":
"/redfish/v1/TelemetryService/MetricDefinitions/MinPowerConsumedWeek"

},

"@odata.id":
"/redfish/v1/TelemetryService/MetricDefinitions/MaxPowerConsumedWeek"

Metric Report Definitions

These definitions contain a descriptor of the metric report to be generated.

URI: /redfish/v1/TelemetryService/MetricReportDefinitions

Method: GET

81
 Telemetry Service

Response: 200

"@odata.type":
"#MetricReportDefinitionCollection.MetricReportDefinitionCollection",

"@odata.id":
"/redfish/v1/TelemetryService/MetricReportDefinitions",

"Id": "MetricReportDefinitions",

"Name": "Metric Report Definitions",

"Description": "Metric Report Definitions view",

"[email protected]": 9,

"Members": [

"@odata.id":
"/redfish/v1/TelemetryService/MetricReportDefinitions/AvgPowerConsum
ptionHour"

},

"@odata.id":
"/redfish/v1/TelemetryService/MetricReportDefinitions/MinPowerConsum
ptionHour"

},

"@odata.id":
"/redfish/v1/TelemetryService/MetricReportDefinitions/MaxPowerConsum
ptionHour"

},

"@odata.id":
"/redfish/v1/TelemetryService/MetricReportDefinitions/AvgPowerConsum
ptionDay"

},

82
 Telemetry Service

"@odata.id":
"/redfish/v1/TelemetryService/MetricReportDefinitions/MinPowerConsum
ptionDay"

},

"@odata.id":
"/redfish/v1/TelemetryService/MetricReportDefinitions/MaxPowerConsum
ptionDay"

},

"@odata.id":
"/redfish/v1/TelemetryService/MetricReportDefinitions/AvgPowerConsum
ptionWeek"

},

"@odata.id":
"/redfish/v1/TelemetryService/MetricReportDefinitions/MinPowerConsum
ptionWeek"

},

"@odata.id":
"/redfish/v1/TelemetryService/MetricReportDefinitions/MaxPowerConsum
ptionWeek"

Metric Reports
Metric Reports contain the location for the report generated from a metric report definition.

URI: /redfish/v1/TelemetryService/MetricReports

Method: GET

Response: 200

83
 Telemetry Service

"@odata.type":
"#MetricReportCollection.MetricReportCollection",

"@odata.id": "/redfish/v1/TelemetryService/MetricReports",

"Id": "MetricReports",

"Name": "Metric Reports",

"Description": "Metric Reports view",

"[email protected]": 9,

"Members": [

"@odata.id":
"/redfish/v1/TelemetryService/MetricReports/AvgPowerConsumptionHour"

},

"@odata.id":
"/redfish/v1/TelemetryService/MetricReports/MinPowerConsumptionHour"

},

"@odata.id":
"/redfish/v1/TelemetryService/MetricReports/MaxPowerConsumptionHour"

},

"@odata.id":
"/redfish/v1/TelemetryService/MetricReports/AvgPowerConsumptionDay"

},

"@odata.id":
"/redfish/v1/TelemetryService/MetricReports/MinPowerConsumptionDay"

},

84
 Telemetry Service

"@odata.id":
"/redfish/v1/TelemetryService/MetricReports/MaxPowerConsumptionDay"

},

"@odata.id":
"/redfish/v1/TelemetryService/MetricReports/AvgPowerConsumptionWeek"

},

"@odata.id":
"/redfish/v1/TelemetryService/MetricReports/MinPowerConsumptionWeek"

},

"@odata.id":
"/redfish/v1/TelemetryService/MetricReports/MaxPowerConsumptionWeek"

85
 Dump Service

Dump Service
DumpService

DumpService APIs are used to dump and download debug information.

URI: /redfish/v1/Oem/Supermicro/DumpService

Method: GET

Response: 200

"@odata.type": "#DumpService.v1_0_0.DumpService",

"@odata.id": "/redfish/v1/Oem/Supermicro/DumpService",

"Id": "DumpService",

"Name": "Dump Service",

"Description": "Dump Service",

"Dumps": {

"@odata.id":
"/redfish/v1/Oem/Supermicro/DumpService/Dumps"

},

"VideoCapture": {

"CaptureVideoEnabled": false,

"RecordPeriod": "POSTEnd"

},

"CrashScreenCapture": {

"OSCrashDetectionEnabled": false

},

"Actions": {

"Oem": {},

"#OemDumpService.Collect": {

"target":"/redfish/v1/Oem/Supermicro/DumpService/Act
ions/OemDumpService.Collect",

86
 Dump Service

"@Redfish.ActionInfo":"/redfish/v1/Oem/Supermicro/Du
mpService/CollectActionInfo"

},

"@odata.etag": "\"f225dfabefafd7ab551b9635e9308968\""

HostCrashDumps
When the host crash dump is created, you can download it from HostCrashDumpURI.

URI: /redfish/v1/Oem/Supermicro/DumpService/Dumps/HostCrashDump

Method: GET

Response: 200

"@odata.type": "#Dump.v1_1_0.Dump",

"@odata.id":
"/redfish/v1/Oem/Supermicro/DumpService/Dumps/HostCrashDump",

"Id": "HostCrashDump",

"Description": "Host dump",

"Size": 49139,

"Reason": "Host failure",

"Actions": {

"Oem": {

},

"#SmcDump.Download": {

"target":
"/redfish/v1/Oem/Supermicro/DumpService/Dumps/HostCrashDump/Actions/
SmcDump.Download"

},

"@odata.etag": "\"ae12d4647e32eb925f33eac0c038604b\""

87
 Dump Service

Enable/Disable AMD iHDT Service

Note: this function is supported beginning with X14/H14 motherboards.

URI: /redfish/v1/Oem/Supermicro/DumpService

Method: PATCH

Response: 200

License Required: SFT-DCMS-SINGLE

Payload:

"AMD_IHDTEnabled": true // Enable or Disable AMD iHDT service (YAAPD

daemon)

Downloading Crash Dump

URI:
/redfish/v1/Oem/Supermicro/DumpService/Dumps/HostCrashDump/Actions/SmcDump.Down
load

Method: POST

Response: 200

Filename: CDump.txt

Payload:

Create ScreenCapture
URI: /redfish/v1/Oem/Supermicro/DumpService/Actions/OemDumpService.Collect

Method: POST

Response: 200

Payload:

88
 Dump Service

{ "DumpType": "ScreenCapture", "ActionType": "Create" }

Download ScreenCapture
URI: /redfish/v1/Oem/Supermicro/DumpService/Actions/OemDumpService.Collect

Method: POST

Response: 200

Payload:

{ "DumpType": "ScreenCapture", "ActionType": "Download" }

Download VideoCapture
URI: /redfish/v1/Oem/Supermicro/DumpService/Actions/OemDumpService.Collect

Method: POST

Response: 200

Payload:

{ "DumpType": "VideoCapture", "ActionType": "Download" }

Download CrashScreenCapture
URI: /redfish/v1/Oem/Supermicro/DumpService/Actions/OemDumpService.Collect

Method: POST

Response: 200

Payload:

{ "DumpType": "CrashScreenCapture", "ActionType": "Download" }

Download SDOReport
Step 1:

URI: /redfish/v1/Systems/1

Method: PATCH

Response: 200

Payload:

89
 Dump Service

"Boot" :

"BootSourceOverrideEnabled": "Once",

"BootSourceOverrideMode": "UEFI",

"BootSourceOverrideTarget" : "Diags"

To trigger SDO test in next system boot

Step 2:

URI: /redfish/v1/Systems/1/Actions/ComputerSystem.Reset

Method: POST

Response: 200

Payload:

{ "ResetType" : "PowerCycle" }

Reboot the system. It automatically goes into SDO. The time of the generated report depends
on the system. After SDO generates the report, system will automatically reboot.

Step 3:

URI:/redfish/v1/Oem/Supermicro/DumpService/Actions/OemDumpService.Collect

Method: POST

Response: 200

Payload:

{ "DumpType": "SDOReport", "ActionType": "Download" }

90
 Log Service

Log Service
This resource represents system health event logs and maintenance event logs.

System Health Event Log

URI: /redfish/v1/Systems/1/LogServices/[logservice id]

Method: GET

Response: 200

"@odata.type": "#LogService.v1_1_0.LogService",

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1",

"Id": "Log1",

"Name": "Health Event Log Service",

"MaxNumberOfRecords": 4096,

"OverWritePolicy": "WrapsWhenFull",

"DateTime": "2023-07-03T00:26:24Z",

"DateTimeLocalOffset": "+00:00",

"ServiceEnabled": true,

"Status": {

"State": "Enabled",

"Health": "OK"

},

"LogEntryType": "SEL",

"Oem": {

"Supermicro": {

"@odata.type": "#SmcLogService.v1_0_0.LogService",

"ACPowerOnEventLog": true,

"FIFOEventLog": true,

"SmartPowerEventLog": true

91
 Log Service

},

"Entries": {

"@odata.id":
"/redfish/v1/Systems/1/LogServices/Log1/Entries"

},

"Actions": {

"Oem": {

"#SmcLogService.ClearAcknowledgements": {

"target":
"/redfish/v1/Systems/1/LogServices/Log1/Actions/Oem/SmcLogService.Cl
earAcknowledgements"

},

"#LogService.ClearLog": {

"target":
"/redfish/v1/Systems/1/LogServices/Log1/Actions/LogService.ClearLog"

Supported Actions
Clearing Logs
Use this API to delete all system health event log entries.

URI: /redfish/v1/Systems/1/LogServices/Log1/Actions/LogService.ClearLog

Method: POST

Response: 200

Clearing Acknowledgments
Use this API to clear acknowledgments to all log entries.

92
 Log Service

URI:
/redfish/v1/Systems/1/LogServices/Log1/Actions/Oem/SmcLogService.ClearAcknowledgeme
nts

Method: POST

Response: 200

Log Entry Collection

Navigate to view a collection of Log Entry resource instances.

/redfish/v1/Systems/1/LogServices

URI: /redfish/v1/Systems/1/LogServices/[logservice id]/Entries

Method: GET

Response: 200

"@odata.type": "#LogEntryCollection.LogEntryCollection",

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries",

"Name": "Health Event Log Service Collection",

"Description": "Collection of Health Event Logs",

"Members": [

"@odata.type": "#LogEntry.v1_7_0.LogEntry",

"@odata.id":
"/redfish/v1/Systems/1/LogServices/Log1/Entries/1",

"Id": "1",

"Name": "Health Event Log Entry 1",

"EntryType": "SEL",

"Severity": "Critical",

"Created": "2023-08-14T22:06:39Z",

"EntryCode": "Assert",

"SensorType": "Physical Chassis Security",

"SensorNumber": 170,

93
 Log Service

"Message": "[SEC-0000] General chassis intrusion",

"MessageId": "0x00FFFF",

"Oem": {

"Supermicro": {

"MarkAsAcknowledged": false,

"@odata.type":
"#SmcLogEntryExtensions.v1_0_1.LogEntry",

"RawEventData": {

"EventDirAndType": "0x6F",

"SensorType": "0x05",

"SensorName": "Chassis Intru"

],

"[email protected]": 1,

"@odata.etag": "\"37923498b2bd37c38d9c1175d04bd122\""

Acknowledging an Event
URI: /redfish/v1/Systems/1/LogServices/Log1/Entries/[num]

Method: PATCH

Payload:

"Oem":{ "Supermicro":{ "MarkAsAcknowledged": true } }

Response: 200

94
 Log Service

Maintenance Event Log

URI: /redfish/v1/Managers/1/LogServices/[logservice id]

Method: GET

Response: 200

Supported Actions
Clearing Logs
Use this API to delete all maintenance event log entries.

URI: /redfish/v1/Managers/1/LogServices/Log1/Actions/LogService.ClearLog

Method: POST

Response: 200

Log Entry Collection

Navigate to view the collection of Log Entry resource instances.

URI: /redfish/v1/Managers/1/LogServices/[logservice id]/Entries

Method: GET

Response: 200

"@odata.type": "#LogEntryCollection.LogEntryCollection",

"@odata.id": "/redfish/v1/Managers/1/LogServices/Log1/Entries",

"Name": "Maintenance Event Log Service Collection",

"Description": "Collection of Maintenance Event Logs",

"Members": [

"@odata.type": "#LogEntry.v1_7_0.LogEntry",

"@odata.id":
"/redfish/v1/Managers/1/LogServices/Log1/Entries/1",

"Id": "1",

"Name": "Maintenance Event Log Entry 1",

95
 Log Service

"EntryType": "Oem",

"Severity": "OK",

"Created": "2023-08-14T22:03:18Z",

"OemRecordFormat": "SMC",

"Message": "[MEL-0123] Maintenance event logs were

cleared successfully.",

"MessageId": "Event.1.0.BmcEvtCleared",

"Oem": {

"Supermicro": {

"@odata.type":
"#SmcLogEntryExtensions.v1_0_1.LogEntry",

"Interface": "Redfish",

"User": "ADMIN",

"Source": "10.124.1.193",

"Category": "Others"

],

"[email protected]": 1,

"@odata.etag": "\"2dec7e96ae97a2a4208e182930a44753\""

96
 JSON Schema

JSON Schema
The JSON Schema File resource describes the location (URI) of a particular Redfish schema
definition being implemented or referenced by a Redfish service.

URI: /redfish/v1/JsonSchemas

Method: GET

Response: 200

97
 Registries

Registries
Registries define the messages for Redfish. Registries define the messages for Redfish, which
in turn represents the registry properties. The Message ID is formed per the Redfish
specification. It consists of the RegistryPrefix concatenated with the version concatenated with
the unique identifier for the message registry entry.

URI:

/redfish/v1/Registries/Base

/redfish/v1/Registries/Event

/redfish/v1/Registries/SMC

/redfish/v1/Registries/BiosAttributeRegistry

Method: GET

Response: 200

"@odata.type":
"#MessageRegistryFileCollection.MessageRegistryFileCollection",

"@odata.id": "/redfish/v1/Registries",

"Name": "Registry File Collection",

"Description": "Registry Repository",

"Members": [

"@odata.id":
"/redfish/v1/Registries/BiosAttributeRegistry"

},

"@odata.id": "/redfish/v1/Registries/Base"

},

"@odata.id": "/redfish/v1/Registries/Event"

},

98
 Registries

"@odata.id": "/redfish/v1/Registries/SMC"

],

"[email protected]": 4,

"@odata.etag": "\"2e96cc1f348b08e443619f3268361321\""

99
 BMC Configuration Examples

BMC Configuration Examples

You can integrate current APIs into their software and applications in order to receive all
services provided by Redfish APIs.

System Reset
URI: /redfish/v1/Systems/1/Actions/ComputerSystem.Reset

Method: POST

ResetType: AllowableValues: [
"On","ForceOff","GracefulShutdown","GracefulRestart","ForceRestart","Nmi","ForceOn",
"PowerCycle"]

Response: 200

"Success": {

"code": "Base.v1_10_3.Success",

"message": "Successfully Completed Request."

Enable/Disable S5 Standby Fan Mode

Note: this function is supported beginning with X14/H14 motherboards.

URI: /redfish/v1/Chassis/1

Method: PATCH

AllowableValues: true, false

Payload:

"Oem": {

"Supermicro": {

"StandbyPowerControl": {

"AIOMEnabled": true

100
 BMC Configuration Examples

Response: 200

Clear CMOS
Note: this function is supported beginning with X14/H14 motherboards.

URI: /redfish/v1/Systems/1/Actions/ComputerSystem.Decommission

Method: POST

Payload:

"OEMDecommissionTypes": [

"ClearCMOS"

Response: 200

Note: AC power will automatically restart

Remote Standby Power Cycle

Note: this function is supported beginning with X14/H14 motherboards.

URI: /redfish/v1/Systems/1/Actions/Oem/OemSystemExtensions.Reset

Method: POST

Response: 200

Payload:

"ResetType": "ACCycle"

101
 BMC Configuration Examples

Notifications
SNMP
URI: /redfish/v1/Managers/1/NetworkProtocol

Method: PATCH

Payload:

"SNMP": {"ProtocolEnabled": true}

SNMPv2
URI: /redfish/v1/Managers/1/NetworkProtocol

Method: PATCH

Payload:

"SNMP": {"EnableSNMPv2c": true}

SNMPv3
URI: /redfish/v1/Managers/1/NetworkProtocol

Method: PATCH

Payload:

"SNMP": {"EnableSNMPv3": true}

Syslog
URI: /redfish/v1/Managers/1/Oem/Supermicro/Syslog

Method: PATCH

Payload:

102
 BMC Configuration Examples

"EnableSyslog": true,

"SyslogPortNumber": 514,

"SyslogServer": "10.136.176.16"

FanMode
URI: /redfish/v1/Managers/1/Oem/Supermicro/FanMode

Method: PATCH

Payload:

"Mode": "FullSpeed"

Mode Allowable Values: {"Standard", "FullSpeed", "Optimal", "PUE2","HeavyIO"}

NTP
URI: /redfish/v1/Managers/1/Oem/Supermicro/NTP

Method: GET

Response: 200

"@odata.type": "#NTP.v1_0_2.NTP",

"@odata.id": "/redfish/v1/Managers/1/Oem/Supermicro/NTP",

"Id": "NTP",

"Name": "NTP Service",

"NTPEnable": false,

"PrimaryNTPServer": "127.0.0.1",

"SecondaryNTPServer": "127.0.0.1",

"DaylightSavingTime": false,

"@odata.etag": "\"cb0e722d1a8a503198dc783ddaffbe2e\""

103
 BMC Configuration Examples

URI: /redfish/v1/Managers/1/Oem/Supermicro/NTP

Method: PATCH

Payload:

"NTPEnable": true,

"PrimaryNTPServer":"127.0.0.1",

"SecondaryNTPServer":"127.0.0.1",

"DaylightSavingTime": false

Response: 202

Note: Check the task monitor to check the progress for NTP.

Note: Daylight Saving Time cannot be PATCHED started with v. 1_0_2.

NTP AutoDST Enabled

URI: /redfish/v1/Managers/1

Method: PATCH

Allowable Value: false, true

Response: 200

"AutoDSTEnabled": false

Note: Can only PATCH true when timezone is supported.

RADIUS
URI: /redfish/v1/Managers/1/Oem/Supermicro/RADIUS

Method: PATCH

104
 BMC Configuration Examples

Payload:

"RadiusEnabled":true,

"RadiusServerIP":"127.0.0.1",

"RadiusPortNumber":1812,

"RadiusSecret":"SECRET"

Snooping
URI: /redfish/v1/Managers/1/Oem/Supermicro/Snooping

Method: GET

Response: 200

IP Access Control
URI: /redfish/v1/Managers/1/Oem/Supermicro/IPAccessControl

Method: PATCH

Payload:

"ServiceEnabled": true

Adding a Rule
URI: /redfish/v1/Managers/1/Oem/Supermicro/IPAccessControl/FilterRules

Method: POST

Payload:

"Address": "<IP>",

"PrefixLength": 24,

"Policy": "Accept"

105
 BMC Configuration Examples

Policy Allowable Values: "Accept", "Drop"

Deleting a Rule
URI: /redfish/v1/Managers/1/Oem/Supermicro/IPAccessControl/FilterRules/[num]

Method: DELETE

SMCRAKP
URI: /redfish/v1/Managers/1/Oem/Supermicro/SMCRAKP

Method: PATCH

Payload:

"Mode": "Enabled"

iKVM
URI: /redfish/v1/Managers/1/Oem/Supermicro/IKVM

Method: GET

Response: {"Mode": "Relative"}

"@odata.type": "#IKVM.v1_0_2.IKVM",

"@odata.id": "/redfish/v1/Managers/1/Oem/Supermicro/IKVM",

"Id": "IKVM",

"Name": "IKVM",

"Current interface": "HTML 5",

"URI": "/redfish/GyoehEnZlt76uco.IKVM"

Use response property, “URI”, above to prepend “https://${BMC_IP}“ and paste this complete
URL in a browser to render HTML5 iKVM.

Example of launching URL: https://{BMC_IP}/redfish/Kk1D4UVATDja0Jw.IKVM

106
 BMC Configuration Examples

iKVM Mouse Mode

URI: /redfish/v1/Managers/1/Oem/Supermicro/MouseMode

Method: PATCH

Payload:

"Mode": "Relative"

Mode Allowable Values: "Absolute", "Relative", "Single"

KCS Channel Control

This API allows you to secure their environment by giving appropriate privileges to access the
KCS interface.

URI: /redfish/v1/Managers/1/Oem/Supermicro/KCSInterface

Method: PATCH

Payload:

"Privilege": "Administrator"

Privilege Allowable Values:

l Administrator: Users accessing KCS interface will be able to do all the operations that
the administrator user can do.
l Operator: Users accessing KCS interface will be able to do all the operations that users
with Operator privileges can do.
l User: Users accessing the KCS interface will be able to do all the operations that users
with User privileges can do.
l Callback: This is the lowest privilege level. Only commands necessary to support
initiating a Callback are allowed.
l DisableKCS: Disabling KCS function, only support after KCS version 1.1.0, you can
check in "@odata.type".

URI: /redfish/v1/Managers/1/Oem/Supermicro/KCSInterface

107
 BMC Configuration Examples

Method: GET

Response: 200

"@odata.type": "#KCSInterface.v1_1_0.KCSInterface",

"@odata.id": "/redfish/v1/Managers/1/Oem/Supermicro/KCSInterface",

"Id": "KCSInterface",

"Name": "KCS Interface",

"Privilege": "Administrator",

"@odata.etag": "\"7f21b53f195494a7c2dad2008917b1d7\""

Getting MAC Addresses from System NICs

URI: /redfish/v1/Systems/1/EthernetInterfaces/1

Method: GET

Response: 200

"@odata.type": "#EthernetInterface.v1_5_2.EthernetInterface",

"@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces/1",

"Id": "1",

"Name": "AOC_NIC1",

"Description": "AOC-GTG-i2T #1",

"Status": {

"State": "Enabled",

"Health": "OK"

"MACAddress": "7c:c2:55:06:00:56",

"SpeedMbps": 0,

"FQDN": ""

108
 BMC Configuration Examples

Chassis Intrusion
URI: /redfish/v1/Chassis/1

Method: GET/PATCH

Payload:

"PhysicalSecurity":{"IntrusionSensor": "Normal"}

Network DNS
Supported Platforms Supported BMC Firmware Redfish User Guide Version
X12/H12 1.3.3 or later Version 3.4

URI: /redfish/v1/Managers/1/EthernetInterfaces/1

Method: GET/PATCH

Payload:

"StaticNameServers":[

"10.10.10.1",

"10.10.10.2"

LLDP
/redfish/v1/Managers/1/SharedNetworkPorts

URI: /redfish/v1/Managers/1/SharedNetworkPorts

Method: GET

Response: 200

"@odata.type": "#PortCollection.PortCollection",

109
 BMC Configuration Examples

"@odata.id": "/redfish/v1/Managers/1/SharedNetworkPorts",

"Name": "SharedNetworkPorts Collection",

"Description": "Collection of SharedNetworkPorts",

"[email protected]": 1,

"Members":[

"@odata.id": " /redfish/v1/Chassis/1/NetworkAdapters/1/Ports/1"

],

"@odata.etag": "894cb8ea4eb6da2fb62990a90f2d2859"

/redfish/v1/Managers/1/DedicatedNetworkPorts

URI: /redfish/v1/Managers/1/DedicatedNetworkPorts

Method: GET

Response: 200

"@odata.type": "#PortCollection.PortCollection",

"@odata.id": "/redfish/v1/Managers/1/DedicatedNetworkPorts",

"Name": "DedicatedNetworkPorts Collection",

"Description": "Collection of DedicatedNetworkPorts",

"[email protected]": 1,

"Members":[

"@odata.id": "/redfish/v1/Managers/1/DedicatedNetworkPorts/1"

],

"@odata.etag": "2a446445042d962d51a0f0c17658d6e1"

/redfish/v1/Managers/1/DedicatedNetworkPorts/num

110
 BMC Configuration Examples

URI: /redfish/v1/Managers/1/DedicatedNetworkPorts/num

Method: GET

Response: 200

"@odata.type": "#Port.v1_8_0.Port",

"@odata.id": "/redfish/v1/Managers/1/DedicatedNetworkPorts/1",

"Id": "1",

"Name": "DedicatedNetworkPorts 1",

"Description": "DedicatedNetworkPorts 1 information",

"CurrentSpeedGbps": 1,

"MaxSpeedGbps": 1,

"LinkStatus": "LinkUp",

"LinkState": "Enabled",

"PortId": "1",

"PortProtocol": "Ethernet",

"LinkNetworkTechnology": "Ethernet",

"PortType": "BidirectionalPort",

"Status":{

"State": "Enabled",

"Health": "OK",

"HealthRollup": "OK"

},

"Ethernet":{

"AssociatedMACAddresses":[

"7C:C2:55:30:FB:F6"

],

"LLDPEnabled": false,

"LLDPReceive":{},

111
 BMC Configuration Examples

"LLDPTransmit":{"ChassisIdSubtype": "NotTransmitted", "ChassisId":

"", "ManagementAddressIPv4": "", "ManagementAddressIPv6": "",…}

},

"Oem":{

"Supermicro":{

"@odata.type": "#SmcPortExtensions.v1_0_0.Ports",

"LLDPTransmitEnabled": false

},

"@odata.etag": "b253ce04be488af8d0daf5daa707e43e"

CPU Power Capping

Note: Supported beginning with X14/H14.

Enable/Disable Power Capping

URI: /redfish/v1/Chassis/1/Controls

Method: PATCH

Response: 200

Payload:

"ControlMode":"Manual"

License Required: SFT-DCMS-SINGLE

Priviledge Required: ConfigureManager

Allowable Values: "Disabled": Control by this API is disabled. "Manual": Capping value is
controlled by "SetPoint".

Set CPU Power Capping

URI: /redfish/v1/Chassis/1/Controls

112
 BMC Configuration Examples

Method: PATCH

Response: 200

Payload:

"SetPoint": 400

License Required: SFT-DCMS-SINGLE

Priviledge Required: ConfigureManager

Node Manager

Note: Supported beginning with X14/H14.

Enable/Disable Node Manager Policy Control

Enable/Disable All Domains

URI: /redfish/v1/Managers/1/Oem/Supermicro/NodeManager

Method: PATCH

Response: 200

License Required: SFT-DCMS-SINGLE

Payload:

"Status": {

"State": "Enabled"

Enable/Disable Individual Policy

URI: /redfish/v1/Managers/1/Oem/Supermicro/NodeManager/Policies/{PolicyID}

Method: PATCH

Response: 200

113
 BMC Configuration Examples

License Required: SFT-DCMS-SINGLE

Payload:

"Status": {

"State": "Enabled"

Enable/Disable Individual Domain

URI: /redfish/v1/Managers/1/Oem/Supermicro/NodeManager/Domains/{DomainName}

Method: PATCH

Response: 200

License Required: SFT-DCMS-SINGLE

Payload:

"Status": {

"State": "Enabled"

Set Node Manager Policy

Create Policy
URI: /redfish/v1/Managers/1/Oem/Supermicro/NodeManager/Policies

Method: POST

Response: 201

License Required: SFT-DCMS-SINGLE

Payload:

"CorrectionInMs" : 6000, // Correction Time

114
 BMC Configuration Examples

"Domain" : "CPUSubsystem", // Policy will be applied into

the whole domain

"Limit" : 0, // User configure actual power limit for the

assigned domain

"Id" : "5", // User configure actual policy ID, after POST, API
will be .../Policies/5

"LimitException": "NoAction", // Exception Action

"PolicyStorage" : "Volatile", // Policy Storage Option

"PowerCorrectionType":"Auto", // Aggressive CPU Power

Correction

"StatisticsReportingPeriod" : "PT1S", // Statistic Reporting

Period in seconds

"Status" : {

"State" : "Enabled" // Policy Enabled or not

},

"Trigger": {

"TriggerLimit" : 0, // Policy Trigger Limit

"TriggerType": "AlwaysOn" // Policy Trigger Type

Modify Policy
URI: /redfish/v1/Managers/1/Oem/Supermicro/NodeManager/Policies/{PolicyID}

Method: PATCH

Response: 200

License Required: SFT-DCMS-SINGLE

Payload:

"CorrectionInMs" : 6000, // Correction Time

"Limit" : 0, // User configure actual power limit for the

assigned domain

"LimitException": "NoAction", // Exception Action

115
 BMC Configuration Examples

"PolicyStorage" : "Volatile", // Policy Storage Option

"PowerCorrectionType":"Auto", // Aggressive CPU Power

Correction

"StatisticsReportingPeriod" : "PT1S", // Statistic Reporting

Period in seconds

"Status" : {

"State" : "Enabled" // Policy Enabled or not

},

"Trigger": {

"TriggerLimit" : 0, // Policy Trigger Limit

"TriggerType": "AlwaysOn" // Policy Trigger Type

Enable/Disable Policy
URI: /redfish/v1/Managers/1/Oem/Supermicro/NodeManager/Policies/{PolicyID}

Method: PATCH

Response: 200

License Required: SFT-DCMS-SINGLE

Payload:

"Status": {

"State": "Enabled" // To disable or enable policy

},

Delete Policy
URI: /redfish/v1/Managers/1/Oem/Supermicro/NodeManager/Policies/{PolicyID}

Method: DELETE

Response: 200

License Required: SFT-DCMS-SINGLE

116
 BMC Configuration Examples

Reset Node Manager Statistics

Reset Statistics per Domain
URI: /redfish/v1/Managers/1/Oem/Supermicro/NodeManager/Domains/
{DomainName}/Actions/Domain.ResetStatistics

Method: POST

Response: 200

License Required: SFT-DCMS-SINGLE

Payload:

Reset Statistics per Policy

URI: /redfish/v1/Managers/1/Oem/Supermicro/NodeManager/Policies/
{PolicyId}/Actions/Policy.ResetStatistics

Method: POST

Response: 200

License Required: SFT-DCMS-SINGLE

Payload:

Set Node Manager Power Draw Range

URI: /redfish/v1/Managers/1/Oem/Supermicro/NodeManager/Domains/{DomainName}

Method: PATCH

Response: 200

License Required: SFT-DCMS-SINGLE

Payload:

...

"Capabilities": {

"Max": 600,

"Min": 0

117
 BMC Configuration Examples

...

Set Total Power Budget

URI: /redfish/v1/Managers/1/Oem/Supermicro/NodeManager/Policies

Method: POST

Response: 200

License Required: SFT-DCMS-SINGLE

Payload:

"ComponentID": 255 // Each time with single ComponentID.

"Domain": "CPUSubsystem", //

"Limit": 1000, //

"PolicyStorage" // Persistent or Volatile

Reset Node Manager

URI: /redfish/v1/Managers/1/Oem/Supermicro/NodeManager/Actions/NodeManager.Reset

Method: POST

Response: 200

License Required: SFT-DCMS-SINGLE

Payload:

118
 Boot Certificates

Boot Certificates
URI: /redfish/v1/Systems/1Boot/Certificates

Method: GET

Response: 200

"@odata.type": "#CertificateCollection.CertificateCollection",

"@odata.id": "/redfish/v1/Systems/1/Boot/Certificates",

"Name": "Certificate Collection",

"Description": "Certificate Collection",

"[email protected]": 0,

"Members": [],

"@Redfish.SupportedCertificates": [

"PEM"

],

"@odata.etag": "ed264ad21e3740e5f8ad68c4e29e232b"

URI: /redfish/v1/Systems/1/Boot/Certificates

Method: POST

Response: 204

Payload:

"CertificateString": "-----BEGIN CERTIFICATE-----\n{CERT}\n-----END

CERTIFICATE-----".

"CertificateType": "PEM"

URI: /redfish/v1/Systems/1/Boot/Certificates/[num]

Method: DELETE

Response: 202

119
 Boot Certificates

"Accepted": {

"code": "Base.v1_10_3.Accepted",

"message": "Successfully Accepted Request. Please see the

location header and ExtendedInfo ...",

"@Message.ExtendedInfo": [

"MessageId": "Base.1.10.ResetRequired",

"Severity": "Warning",

"Resolution": "Perform the required reset

action on the specified component.",

"Message": "In order to complete the operation,

a component reset is required with...",

"MessageArgs": [

"/redfish/v1/Systems/1/Actions/ComputerSy
stem.Reset",

"GracefulRestart"

],

"RelatedProperties": [

""

120
 Power and Thermal Resource Tree

Power and Thermal Resource Tree

Change section name as “Power and Thermal resource tree …”Subsection will be
“PowerSubsystem”, “ThermalSubsystem”, .…

Description: We will follow DMTF spec (2020.4) to deprecate schema Thermal and Power
since X14 Reference Link: https://redfish.dmtf.org/schemas/Redfish_Release_History.pdf

Power Subsystem
/redfish/v1/Chassis/1/PowerSubsystem

URI: /redfish/v1/Chassis/1/PowerSubsystem

Method: GET

Response: 200

"@odata.type": "#PowerSubsystem.v1_1_0.PowerSubsystem",

"@odata.id": "/redfish/v1/Chassis/1/PowerSubsystem",

"Id": "PowerSubsystem",

"Name": "Power Subsystem for Chassis",

"CapacityWatts": 0,

121
 Power and Thermal Resource Tree

"Allocation": {

"AllocatedWatts": 0,

"RequestedWatts": 0

},

"PowerSupplies": {

"@odata.id":
"/redfish/v1/Chassis/1/PowerSubsystem/PowerSupplies"

},

"Status": {

"State": "Absent"

},

"@odata.etag": "8050d2303d48732ce134491ef337276b"

/redfish/v1/Chassis/1/PowerSubsystem/PowerSupplies

URI: /redfish/v1/Chassis/1/PowerSubsystem/PowerSupplies

Method: GET

Response: 200

"@odata.type": "#PowerSupplyCollection.PowerSupplyCollection",

"@odata.id":
"/redfish/v1/Chassis/1/PowerSubsystem/PowerSupplies",

"Name": "Power Supply Collection",

"Description": "Power Supply Collection",

"[email protected]": 0,

"Members": [],

"@odata.etag": "c3a55c3898f4be9d186aa3a7bf1f65ae"

Thermal Subsystem
/redfish/v1/Chassis/1/ThermalSubsystem

122
 Power and Thermal Resource Tree

URI: /redfish/v1/Chassis/1/ThermalSubsystem

Method: GET

Response: 200

"@odata.type": "#ThermalSubsystem.v1_0_0.ThermalSubsystem",

"@odata.id": "/redfish/v1/Chassis/1/ThermalSubsystem",

"Id": "ThermalSubsystem",

"Name": "Thermal Subsystem for Chassis",

"Fans": {

"@odata.id": "/redfish/v1/Chassis/1/ThermalSubsystem/Fans"

},

"ThermalMetrics": {

"@odata.id":
"/redfish/v1/Chassis/1/ThermalSubsystem/ThermalMetrics"

},

"Status": {

"State": "Enabled",

"Health": "OK"

},

"@odata.etag": "cf2acc17841d77f78e3d605be24f39f8"

/redfish/v1/Chassis/1/ThermalSubsystem/Fans

URI: /redfish/v1/Chassis/1/ThermalSubsystem/Fans

Method: GET

Response: 200

"@odata.type": "#FanCollection.FanCollection",

"@odata.id": "/redfish/v1/Chassis/1/ThermalSubsystem/Fans",

"Name": "Fan Collection",

123
 Power and Thermal Resource Tree

"Description": "Fan Collection",

"[email protected]": 8,

"Members": [

"@odata.id":
"/redfish/v1/Chassis/1/ThermalSubsystem/Fans/FAN1"

},

"@odata.id":
"/redfish/v1/Chassis/1/ThermalSubsystem/Fans/FAN2"

},

"@odata.id":
"/redfish/v1/Chassis/1/ThermalSubsystem/Fans/FAN3"

},

"@odata.id":
"/redfish/v1/Chassis/1/ThermalSubsystem/Fans/FAN4"

},

"@odata.id":
"/redfish/v1/Chassis/1/ThermalSubsystem/Fans/FAN5"

},

"@odata.id":
"/redfish/v1/Chassis/1/ThermalSubsystem/Fans/FAN6"

},

"@odata.id":
"/redfish/v1/Chassis/1/ThermalSubsystem/Fans/FAN7"

},

124
 Power and Thermal Resource Tree

"@odata.id":
"/redfish/v1/Chassis/1/ThermalSubsystem/Fans/FAN8"

],

"@odata.etag": "b9578f3d4600f31db6cffecede0045f1"

/redfish/v1/Chassis/1/ThermalSubsystem/Fans/num

URI: /redfish/v1/Chassis/1/ThermalSubsystem/Fans/num

Method: GET

Response: 200

"@odata.type": "#Fan.v1_1_0.Fan",

"@odata.id":
"/redfish/v1/Chassis/1/ThermalSubsystem/Fans/FAN1",

"Id": "FAN1",

"Name": "FAN1",

"PhysicalContext": "Fan",

"Location": {

"PartLocation": {

"LocationOrdinalValue": 1

},

"SpeedPercent": {

"DataSourceUri": "/redfish/v1/Chassis/1/Sensors/FAN1",

"SpeedRPM": null

},

"Status": {

"State": "Absent"

},

125
 Power and Thermal Resource Tree

"@odata.etag": "2007a26bf1386afa81b3938752ab49d5"

/redfish/v1/Chassis/1/ThermalSubsystem/ThermalMetrics

URI: /redfish/v1/Chassis/1/ThermalSubsystem/ThermalMetrics

Method: GET

Response: 200

"@odata.type": "#ThermalMetrics.v1_0_1.ThermalMetrics",

"@odata.id":
"/redfish/v1/Chassis/1/ThermalSubsystem/ThermalMetrics",

"Id": "ThermalMetrics",

"Name": "Chassis Thermal Metrics",

"TemperatureReadingsCelsius": [],

"@odata.etag": "a4db7f677c6260482aa1fa9db2632f08"

LeakDetection
Only supported for devices that have a Liquid-Cooling system.

URI: /redfish/v1/Chassis/1/ThermalSubsystem/LeakDetection

Method: GET

Response: 200

"@odata.type": "#LeakDetection.v1_0_0.LeakDetection",

"@odata.id":
"/redfish/v1/Chassis/1/ThermalSubsystem/LeakDetection",

"Id": "LeakDetection",

"Name": "Leak Detection Systems",

"LeakDetectorGroups": [

"GroupName": "Detectors under and around the CDU",

126
 Power and Thermal Resource Tree

"Detectors": [

"DataSourceUri":
"/redfish/v1/Chassis/1/ThermalSubsystem/LeakDetection/LeakDetectors/
CPU_Coldplate",

"DeviceName": "CPU Coldplate",

"DetectorState": "OK"

],

"Status": {

"State": "Enabled",

"Health": "OK"

],

"LeakDetectors": {

"@odata.id":
"/redfish/v1/Chassis/1/ThermalSubsystem/LeakDetection/LeakDetectors"

},

"Oem": {

"Supermicro": {

"LiquidCooling": {

"@odata.type": "#SmcLeakDetectionExtensions.v1_
0_0.LeakLeakDetection",

"LocationIndicatorActive": false

"PowerOption_LeakDetected":
"KeepCurrentPowerState",

"LeakDetectionLockEnabled": false

127
 Power and Thermal Resource Tree

},

"@odata.etag": "95524aa931fa44c70b639336ea4ca255"

/redfish/v1/Chassis/1/ThermalSubsystem/LeakDetection/LeakDetectors

Only supported for devices that have a Liquid-Cooling system.

URI: /redfish/v1/Chassis/1/ThermalSubsystem/LeakDetection/LeakDetectors

Method: GET

Response: 200

"@odata.type": "#LeakDetectorCollection.LeakDetectorCollection",

"@odata.id":
"/redfish/v1/Chassis/1/ThermalSubsystem/LeakDetection/LeakDetectors",

"Name": "Collection of LeakDetector",

"Description": "Collection of LeakDetectors",

"[email protected]": 3,

"Members": [

"@odata.id":
"/redfish/v1/Chassis/1/ThermalSubsystem/LeakDetection/LeakDetectors/
CPU_Coldplate"

},

"@odata.id":
"/redfish/v1/Chassis/1/ThermalSubsystem/LeakDetection/LeakDetectors/
PCIeSwitch_Coldplate"

},

"@odata.id":
"/redfish/v1/Chassis/1/ThermalSubsystem/LeakDetection/LeakDetectors/
GPU_Coldplate"

128
 Power and Thermal Resource Tree

],

"@odata.etag": "d1005794c8b2d088348297fce3862c15"

/redfish/v1/Chassis/1/ThermalSubsystem/LeakDetection/LeakDetectors/CPU_Coldplate

Only supported for devices that have a Liquid-Cooling system.

URI: /redfish/v1/Chassis/1/ThermalSubsystem/LeakDetection/LeakDetectors/CPU_Coldplate

Method: GET

Response: 200

"@odata.type": "#LeakDetector.v1_0_1.LeakDetector",

"@odata.id":
"/redfish/v1/Chassis/1/ThermalSubsystem/LeakDetection/LeakDetectors/CPU_Coldplate",

"Id": "CPU_Coldplate",

"Name": "Moisture-type Leak Detector",

"LeakDetectorType": "Moisture",

"Status": {

"State": "Enabled",

"Health": "OK"

},

"DetectorState": "OK",

"Manufacturer": "Supermicro",

"@odata.etag": "30b7d982a660ea7b38021a59228cd4ce"

/redfish/v1/Chassis/1/Sensors

Moving sensors under Power and Thermal to this Sensors collection

URI: /redfish/v1/Chassis/1/Sensors

Method: GET

Response: 200

129
 Power and Thermal Resource Tree

"@odata.type": "#SensorCollection.SensorCollection",

"@odata.id": "/redfish/v1/Chassis/1/Sensors",

"Name": "Sensor Collection",

"[email protected]": 47,

"Members":[

"@odata.id": "/redfish/v1/Chassis/1/Sensors/CPU1Temp"

},

"@odata.id": "/redfish/v1/Chassis/1/Sensors/CPU2Temp"

},

"@odata.id": "/redfish/v1/Chassis/1/Sensors/InletTemp"

},

"@odata.id": "/redfish/v1/Chassis/1/Sensors/PCHTemp"

},

"@odata.id": "/redfish/v1/Chassis/1/Sensors/SystemTemp"

],

"@odata.etag": "\"1efd4293d26546cd2a5636e6b729bf47\""

/redfish/v1/Chassis/1/Sensors/CPU1Temp

URI: /redfish/v1/Chassis/1/Sensors/CPU1Temp

Method: GET

130
 Power and Thermal Resource Tree

Response: 200

"@odata.type": "#Sensor.v1_4_0.Sensor",

"@odata.id": "/redfish/v1/Chassis/1/Sensors/CPU1Temp",

"Id": "CPU1Temp",

"Name": "CPU1 Temp",

"ReadingType": "Temperature",

"PhysicalContext": "CPU",

"Status": {

"State": "Enabled",

"Health": "OK"

},

"Reading": 52,

"ReadingUnits": "Cel",

"Thresholds": {

"UpperCritical": {

"Reading": 92,

"Activation": "Increasing"

},

"UpperFatal": {

"Reading": 92,

"Activation": "Increasing"

},

"LowerCritical": {

"Reading": 5,

"Activation": "Decreasing"

},

"LowerFatal": {

"Reading": 5,

131
 Power and Thermal Resource Tree

"Activation": "Decreasing"

},

"RelatedItem": [

"@odata.id": "/redfish/v1/Systems/1/Processors/1"

],

"Oem": {

"Supermicro": {

"@odata.type": "#SmcSensorExtensions.v1_0_1.Sensor",

"SensorNumber": 1

},

"@odata.etag": "\"6f1c8d1219f6c0da633fffa416343d9e\""

Component Integrity
URI: /redfish/v1/ComponentIntegrity

Method: GET

Response: 200

"@odata.type":

"#ComponentIntegrityCollection.ComponentIntegrityCollect

ion",

"@odata.id": "/redfish/v1/ComponentIntegrity",

"Name": "Component Integrity Collection",

"Description": "Collection of Component Integrity

Resource Instances",

132
 Power and Thermal Resource Tree

"[email protected]": 1,

"Members":[

"@odata.id":

"/redfish/v1/ComponentIntegrity/TPM_AMD_002d"

],

"@odata.etag": "\"78a07967aeac9bb0b6a0d459ddf3a613\""

Component Integrity for TPM

URI: /redfish/v1/ComponentIntegrity/TPM_{VendorID}_{handle}

Method: GET

Response: 200

"@odata.type":

"#ComponentIntegrity.v1_2_3.ComponentIntegr

ity",

"@odata.id":

"/redfish/v1/ComponentIntegrity/TPM_AMD_002

d",

"Id": "TPM_AMD_002d",

"Name": "Component Integrity",

"Description": "TPM Integrity for

TPM_AMD_002d",

"Status":{

"State": "Enabled",

"Health": "OK"

},

"ComponentIntegrityType": "TPM",

133
 Power and Thermal Resource Tree

"ComponentIntegrityTypeVersion": "1.2.0",

(From SMBIOS type 43, Major Spec Version)

"ComponentIntegrityEnabled": true,

"TPM":{ (From bios external file)

"MeasurementSet":{

"Measurements":[

"PCR": 1,

"Measurement": "{VALUE which been

Base64-encoded}",

"MeasurementHashAlgorithm":

"TPM_ALG_SHA256"

},

"PCR": 2,

"Measurement": "{VALUE which been

Base64-encoded}",

"MeasurementHashAlgorithm":

"TPM_ALG_SHA256"

},

"@odata.etag":

"\"0d47e797614b94532b70508c5c1a722f\""

Assembly
You can now find FRU information in this API

134
 Power and Thermal Resource Tree

URI: /redfish/v1/Chassis/1/Assembly

Method: GET

Response: 200

"@odata.type": "#Assembly.v1_4_0.Assembly",

"@odata.id": "/redfish/v1/Chassis/1/Assembly",

"Id": "Assembly",

"Name": "Assembly data for 1",

"Assemblies": [ {

"@odata.id": "/redfish/v1/Chassis/1/Assembly#/Assemblies/0",

"MemberId": "0",

"Name": "Board FRU Assembly",

"PhysicalContext": "Chassis",

"Vendor": "Supermicro",

"Model": null,

"ProductionDate": "1996-01-01T00:00:00Z",

"SerialNumber": null,

"PartNumber": null,

"Location": {

"PartLocation": {

"LocationType": "Embedded"

}, {

"@odata.id": "/redfish/v1/Chassis/1/Assembly#/Assemblies/1",

"MemberId": "1",

"Name": "Product FRU Assembly",

"PhysicalContext": "Chassis",

"Vendor": null,

135
 Power and Thermal Resource Tree

"Model": null,

"Version": null,

"SerialNumber": "test123",

"PartNumber": null,

"Location": {

"PartLocation": {

"LocationType": "Embedded"

}, {

"@odata.id": "/redfish/v1/Chassis/1/Assembly#/Assemblies/2",

"MemberId": "2",

"Name": "Chassis FRU Assembly",

"PhysicalContext": "Chassis",

"SerialNumber": null,

"PartNumber": null,

"Location": {

"PartLocation": {

"LocationType": "Embedded"

],

"@odata.etag": "\"19bb92249b67a8dd889ad1f8a5afb3eb\""

136
 Activating via Redfish API

Activating via Redfish API

URI: /redfish/v1/Managers/1/LicenseManager/Actions/LicenseManager.ActivateLicense

Method: POST

Payload:

"ProductKey":{"Node":{"LicenseID":"2","LicenseName":"SFT-
DCMSSINGLE","CreateDate":"20230407"},"Signature":"Xe2bdYNKGkmPJ/E5wg
O5nQG8

aFgWrbZ8KRMngZwvB/gUDKu4dmtziB3BIgrOQ9BnmUbisCFIbtMYr9g0/tCdzLEGslJV
WbeoHTD5AeYnsUW8LGSLyVFd3YpaUAJz0HP5M2mOej9jlPB6Cd7cK5oYJx3ILlpSOcR6
ryB9

hC2X3/EfUByCJT12KAiwXLhJ7RCV2P2EFDJ0bDim38hLmst1sAiwK829QtbLECftWOOy
ek
+CPZnS11QxoJ4mTlBXH+LbKGpdq1bDv9iZqWAIj1qWHkYdszH/FDhmYaI12nOJZhJjj9
TD

PoHLHYGXTpvW1ofou+0pzDbAtQ5KLUf2ZzoWQA=="}

Response: 200

"Success": {

"code": "Base.v1_10_3.Success",

"message": "Successfully Completed Request."

137
 Available APIs

Available APIs
API List License Notes
/redfish Standard show version

/redfish/v1 Standard service root

/redfish/v1/SessionService Standard

/redfish/v1/Chassis Standard

/redfish/v1/AccountService Standard

/redfish/v1/Managers Standard

/redfish/v1/Systems Standard

/redfish/v1/EventService Standard

/redfish/v1/UpdateService Standard

/redfish/v1/Registries Standard

/redfish/v1/JsonSchemas Standard

/redfish/v1/TaskService Standard

SFT-DCMS-
/redfish/v1/CertificateService
SINGLE

/redfish/v1/TelemetryService Standard

/redfish/v1/Oem/Supermicro/DumpService Standard

/redfish/v1/SessionService/Sessions Standard

/redfish/v1/SessionService/Sessions/[session_num] Standard

/redfish/v1/Chassis/1/PowerSubsystem/
Standard
PowerSupplies/[PowerSupplyId]/Assembly

/redfish/v1/Chassis/Backplane_[num]_CPLD_[num] Standard

/redfish/v1/Chassis/1/Boards/OtherPCB_[num] Standard

/redfish/v1/Chassis/1/PowerSubsystem/
Standard
PowerSupplies/PSU_[num]

/redfish/v1/Chassis/StorageController_[num]/Drives/
Standard
SSD[num]

/redfish/v1/Chassis1/Oem/Supermicro/MultiNodes Standard

/redfish/v1/Chassis1/Oem/Supermicro/MultiNodes/
Standard
Node(arg)

/redfish/v1/Chassis/1 Standard

/redfish/v1/Chassis/1/EnvironmentMetrics DCSM

138
 Available APIs

API List License Notes

/redfish/v1/Chassis/1/Thermal Standard

/redfish/v1/Chassis/1/ThermalSubsystem Standard

/redfish/v1/Chassis/1/ThermalSubsystem/Fans Standard

/redfish/v1/Chassis/1/ThermalSubsystem/Fans/
Standard
Fan[num]

/redfish/v1/Chassis/1/ThermalSubsystem/
Standard
ThermalMetrics

/redfish/v1/Chassis/1/ThermalSubsystem/LeakDetection Standard

/redfish/v1/Chassis/1/ThermalSubsystem/LeakDetection/LeakDet
Standard
ectors

/redfish/v1/Chassis/1/ThermalSubsystem/LeakDetection/LeakDet
Standard
ectors/Coldplate

/redfish/v1/Chassis/1/Power Standard

/redfish/v1/Chassis/1/PowerSubsystem Standard

/redfish/v1/Chassis/1/PowerSubsystem/PowerSupplies Standard

/redfish/v1/Chassis/1/PowerSubsystem/
Standard
PowerSupplies/PowerSupply[num]

/redfish/v1/Chassis/1/PowerSubsystem/
Standard
PowerSupplies/PowerSupply[num]/Metrics

/redfish/v1/Chassis/1/Sensors Standard

/redfish/v1/Chassis/1/Sensors/[sensor_num] Standard

BIOS-BMC joint feature

/redfish/v1/Chassis/1/NetworkAdapters Standard BIOS FW update might be

required

BIOS-BMC joint feature

/redfish/v1/Chassis/1/NetworkAdapters/[adapter_num] Standard BIOS FW update might be

required

BIOS-BMC joint feature

/redfish/v1/Chassis/1/NetworkAdapters/[adapter_num]/
Standard BIOS FW update might be
Ports
required

BIOS-BMC joint feature

/redfish/v1/Chassis/1/NetworkAdapters/[adapter_num]/
Standard BIOS FW update might be
Ports/[np_num]
required

139
 Available APIs

API List License Notes

BIOS-BMC joint feature
/redfish/v1/Chassis/1/NetworkAdapters/[adapter_num]/
Standard BIOS FW update might be
NetworkPorts
required

BIOS-BMC joint feature

/redfish/v1/Chassis/1/NetworkAdapters/[adapter_num]/
Standard BIOS FW update might be
NetworkPorts/[np_num]
required

BIOS-BMC joint feature

/redfish/v1/Chassis/1/NetworkAdapters/[adapter_num]/
Standard BIOS FW update might be
NetworkDeviceFunctions
required

BIOS-BMC joint feature

/redfish/v1/Chassis/1/NetworkAdapters/[adapter_num]/
Standard BIOS FW update might be
NetworkDeviceFunctions/[ndf_num]
required

BIOS-BMC joint feature

/redfish/v1/Chassis/1/PCIeSlots Standard BIOS FW update might be

required

BIOS-BMC joint feature

/redfish/v1/Chassis/1/PCIeDevices Standard BIOS FW update might be

required

Network AOC installation is

/redfish/v1/Chassis/1/PCIeDevices/NIC[aoc_card_num] Standard required; asset information of

each AOC's NIC chip.

Network AOC installation is

/redfish/v1/Chassis/1/PCIeDevices/NIC[aoc_card_
Standard required; asset information of
num]/PCIeFunctions
each AOC's NIC chip.

/redfish/v1/Chassis/1/PCIeDevices/NIC[aoc_card_ Network AOC installation is

Standard
num]/PCIeFunctions/[port_num] required

GPU card installation is required;

/redfish/v1/Chassis/1/PCIeDevices/GPU[gpu_card_num] Standard asset information of GPU cards.

(Model, P/N, S/N, FW ver, etc.)

/redfish/v1/Chassis/1/PCIeDevices/GPU[gpu_card_
Standard GPU card installation is required
num]/PCIeFunctions

GPU card installation is required;

/redfish/v1/Chassis/1/PCIeDevices/GPU[gpu_card_ Detail information of GPU cards.

Standard
num]/PCIeFunctions/[gpu_instance_num] (DeviceID, Capacity, location,

etc.)

140
 Available APIs

API List License Notes

Asset information of GPU cards.
/redfish/v1/Chassis/1/PCIeDevices/NVMeSSD[nvme_ssd_num] Standard
(Model, P/N, S/N, FW ver, etc.)

/redfish/v1/Chassis/1/PCIeDevices/NVMeSSD[nvme_ssd_
Standard
num]/PCIeFunctions

Detail information of GPU cards.

/redfish/v1/Chassis/1/PCIeDevices/NVMeSSD[nvme_ssd_
Standard (DeviceID, Capacity, location,
num]/PCIeFunctions/[nvme_ssd_instance_num]
etc.)

SAS3108, SAS3408, SAS39xx,

/redfish/v1/Chassis/HA-RAID.[controller_num].StorageEnclosure. SFT-DCMS- SAS38xxIR

[enclosure_num] SINGLE https://www.supermicro.com/zh_

tw/products/storage/cards

SAS3108, SAS3408, SAS39xx,

/redfish/v1/Chassis/HA-RAID.[controller_num].StorageEnclosure. SFT-DCMS- SAS38xxIR

[enclosure_num]/Drives/Disk.Bay.[disk_num] SINGLE https://www.supermicro.com/zh_

tw/products/storage/cards

Light on physical drive indication

LED SAS3108, SAS3408,

/redfish/v1/Chassis/HA-RAID.[controller_num].StorageEnclosure. SAS39xx, SAS38xxIR

SFT-DCMS-
[enclosure_num]/Drives/Disk.Bay.[disk_ https://www.supermicro.com/zh_
SINGLE
num]/Actions/Oem/SmcDrive.Indicate tw/products/storage/cards

This URI will be deprecated since

X14/H14

SAS3108, SAS3408, SAS39xx,

/redfish/v1/Chassis/HA-RAID.[controller_num].StorageEnclosure.
SFT-DCMS- SAS38xxIR
[enclosure_num]/Drives/Disk.Bay.[disk_
SINGLE https://www.supermicro.com/zh_
num]/Actions/Drive.SecureErase
tw/products/storage/cards

/redfish/v1/Chassis/HA-RAID.[controller_num].StorageEnclosure. SAS3108, SAS3408, SAS39xx,

[enclosure_num]/ SFT-DCMS- SAS38xxIR

Drives/Disk.Bay.[disk_ SINGLE https://www.supermicro.com/zh_

num]/Actions/Oem/SmcDrive.SecureEraseAbort tw/products/storage/cards

SAS3108, SAS3408, SAS39xx,

/redfish/v1/Chassis/HA-RAID.[controller_num].StorageEnclosure.
SFT-DCMS- SAS38xxIR
[enclosure_num]/Drives/Disk.Bay.[disk_
SINGLE https://www.supermicro.com/zh_
num]/Actions/Oem/SmcDrive.AssignSpare
tw/products/storage/cards

141
 Available APIs

API List License Notes

SAS3108, SAS3408, SAS39xx,
/redfish/v1/Chassis/HA-RAID.[controller_num].StorageEnclosure.
SFT-DCMS- SAS38xxIR
[enclosure_num]/Drives/Disk.Bay.[disk_
SINGLE https://www.supermicro.com/zh_
num]/Actions/Oem/SmcDrive.DeleteSpare
tw/products/storage/cards

SAS3108, SAS3408, SAS39xx,

/redfish/v1/Chassis/HA-RAID.[controller_num].StorageEnclosure.
SFT-DCMS- SAS38xxIR
[enclosure_num]/Drives/Disk.Bay.[disk_
SINGLE https://www.supermicro.com/zh_
num]/Oem/Supermicro/IndicateActionInfo
tw/products/storage/cards

SAS3108, SAS3408, SAS39xx,

/redfish/v1/Chassis/HA-RAID.[controller_num].StorageEnclosure.
SFT-DCMS- SAS38xxIR
[enclosure_num]/Drives/Disk.Bay.[disk_
SINGLE https://www.supermicro.com/zh_
num]/Oem/Supermicro/AssignSpareActionInfo
tw/products/storage/cards

For AOC-S3916L-H16iR
/redfish/v1/Chassis/HBA.[controller_num].StorageEnclosure.
Standard https://www.supermicro.com/zh_
[enclosure_num]
tw/products/storage/cards

SAS3008, SAS32xx, SAS36xx,

/redfish/v1/Chassis/HBA.[controller_num].StorageEnclosure. SFT-DCMS- SAS38xxIT

[enclosure_num]/Drives/Disk.Bay.[disk_num] SINGLE https://www.supermicro.com/zh_

tw/products/storage/cards

Light on physical drive indication

LED SAS3008, SAS32xx,

/redfish/v1/Chassis/HBA.[controller_num].StorageEnclosure. SAS36xx, SAS38xxIT

SFT-DCMS-
[enclosure_num]/Drives/Disk.Bay.[disk_ https://www.supermicro.com/zh_
SINGLE
num]/Actions/Oem/SmcDrive.Indicate tw/products/storage/cards

This URI will be deprecated with

X14/H14

Light on physical drive indication

LED SAS3008, SAS32xx,

SAS36xx, SAS38xxIT
/redfish/v1/Chassis/HBA.[controller_num].StorageEnclosure. SFT-DCMS-
https://www.supermicro.com/zh_
[enclosure_num]/Drives/Disk.Bay.[disk_num]/IndicateActionInfo SINGLE
tw/products/storage/cards

This URI will be deprecated with

X14/H14

142
 Available APIs

API List License Notes

Light on physical drive indication

/redfish/v1/Chassis/HBA.[controller_num].StorageEnclosure. LED SAS3008, SAS32xx,

SFT-DCMS-
[enclosure_num]/Drives/Disk.Bay.[disk_ SAS36xx, SAS38xxIT
SINGLE
num]/Oem/Supermicro/IndicateActionInfo https://www.supermicro.com/zh_

tw/products/storage/cards

Light on physical drive indication

LED SAS3008, SAS32xx,

SFT-DCMS-
/redfish/v1/Chassis/StorageBackplane SAS36xx, SAS38xxIT
SINGLE
https://www.supermicro.com/zh_

tw/products/storage/cards

/redfish/v1/Chassis/StorageBackplane/Drives/ SFT-DCMS-

Disk.Bay.[disk_num] SINGLE

/redfish/v1/Chassis/NVMeSSD.[pcie_controller_num].Group.
Standard
[group_num].StorageBackplane

/redfish/v1/Chassis/NVMeSSD.[pcie_controller_num].Group. SFT-DCMS-

[group_num].StorageBackplane/Drives/Disk.Bay.[disk_num] SINGLE

/redfish/v1/Chassis/NVMeSSD.[pcie_controller_num].Group.
SFT-DCMS- Light on physical drive indication
[group_num].StorageBackplane/Drives/Disk.Bay.[disk_
SINGLE LED
num]/Actions/Oem/SmcDrive.Indicate

/redfish/v1/Chassis/NVMeSSD.[pcie_controller_num].Group.
SFT-DCMS-
[group_num].StorageBackplane/Drives/Disk.Bay.[disk_
SINGLE
num]/Oem/Supermicro/IndicateActionInfo

/redfish/v1/Chassis/MRVL.HA-RAID.[controller_
Standard For Marvell SE9230
num].StorageModule

/redfish/v1/Chassis/MRVL.HA-RAID.[controller_ SFT-DCMS-
For LSI 3108
num].StorageModule/Drives/Disk.Bay.[disk_num] SINGLE

/redfish/v1/AccountService/Roles Standard

/redfish/v1/AccountService/Roles/Administrator Standard

/redfish/v1/AccountService/Roles/Operator Standard

/redfish/v1/AccountService/Roles/ReadOnly Standard

/redfish/v1/AccountService/Accounts Standard

/redfish/v1/AccountService/Accounts/[account_num] Standard

/redfish/v1/Managers/1 Standard

/redfish/v1/Managers/1/DedicatedNetworkPorts Standard

/redfish/v1/Managers/1/DedicatedNetworkPorts/[num] Standard

143
 Available APIs

API List License Notes

/redfish/v1/Managers/1/SharedNetworkPorts Standard

/redfish/v1/Managers/1/PrivilegeRegistry Standard

/redfish/v1/Managers/1/Actions/Manager.Reset Standard BMC cold reset

/redfish/v1/Managers/1/Actions/Oem/
Standard BMC to factory default
SmcManagerConfig.Reset

/redfish/v1/Managers/1/Oem/Supermicro/
Standard
ResetActionInfo

SFT-OOB-LIC,

/redfish/v1/Managers/1/SerialInterfaces SFT-DCMS-

SINGLE

SFT-OOB-LIC,

/redfish/v1/Managers/1/SerialInterfaces/[service_num] SFT-DCMS-

SINGLE

/redfish/v1/Managers/1/LogServices Standard

/redfish/v1/Managers/1/LogServices/Log1 Standard

/redfish/v1/Managers/1/LogServices/Log1/Actions/
Standard
LogService.ClearLog

/redfish/v1/Managers/1/LogServices/Log1/Entries Standard

/redfish/v1/Managers/1/LogServices/Log1/Entries/[log_num] Standard

(redfish 1.8 supported VM APIs) Standard

Supported Mounting Method:

/redfish/v1/Managers/1/VirtualMedia Standard
HTTP/CIFS/SAMBA

User must mount image first. This

/redfish/v1/Managers/1/VirtualMedia/CD[mounted_dev_num] Standard URI will be deprecated with

X14/H14

Standard for

Samba, CIFS; SFT-OOB-LIC or SFT-DCMS-

SFT-OOB- SINGLE is required for http and

redfish/v1/Managers/1/VirtualMedia/CD[mounted_dev_
LIC/SFT- https mount.
num]/Actions/VirtualMedia.InsertMedia
DCMS-SINGLE This URI will be deprecated with

for HTTP and X14/H14

HTTPS

SFT-OOB-LIC,
/redfish/v1/Managers/1/VirtualMedia/CD[mounted_dev_ This URI will be deprecated with
SFT-DCMS-
num]/InsertMediaActionInfo X14/H14
SINGLE

144
 Available APIs

API List License Notes

redfish/v1/Managers/1/VirtualMedia/CD[mounted_dev_ This URI will be deprecated with
Standard
num]/Actions/VirtualMedia.EjectMedia X14/H14

User must mount image first. This

/redfish/v1/Managers/1/VirtualMedia/Floppy[mounted_dev_num] Standard URI will be deprecated with

X14/H14

User must mount image first.This

/redfish/v1/Managers/1/VirtualMedia/VirtualMedia[mounted_dev_
Standard URI will be deprecated with
num]
X14/H14

Standard for
Support since Redfish 2020.3
Samba, CIFS;
X13/H13 (BMC FW 1.01.xx)
SFT-OOB-
/redfish/v1/Managers/1/VirtualMedia/VirtualMedia[mounted_dev_ X12/H12 (BMC FW 1.03.xx) SFT-
LIC/SFT-
num]/Actions/VirtualMedia.InsertMedia OOB-LIC or SFT-DCMS-SINGLE
DCMS-SINGLE
is required for http and https
for HTTP and
mount
HTTPS

SFT-OOB-LIC, Support since Redfish 2020.3

/redfish/v1/Managers/1/VirtualMedia/VirtualMedia[mounted_dev_
SFT-DCMS- X13/H13 (BMC FW 1.01.xx)
num]/InsertMediaActionInfo
SINGLE X12/H12 (BMC FW 1.03.xx)

Support since Redfish 2020.3

/redfish/v1/Managers/1/VirtualMedia/VirtualMedia[mounted_dev_
Standard X13/H13 (BMC FW 1.01.xx)
num]/Actions/VirtualMedia.EjectMedia
X12/H12 (BMC FW 1.03.xx)

/redfish/v1/Managers/1/EthernetInterfaces Standard

/redfish/v1/Managers/1/EthernetInterfaces/[eth_num] Standard

/redfish/v1/Managers/1/EthernetInterfaces/ToHost Standard

SFT-OOB-LIC,

/redfish/v1/Managers/1/HostInterfaces SFT-DCMS-

SINGLE

SFT-OOB-LIC,

/redfish/v1/Managers/1/HostInterfaces/1 SFT-DCMS-

SINGLE

SFT-OOB-LIC,
/redfish/v1/Managers/1/HostInterfaces/1/
SFT-DCMS-
HostEthernetInterfaces
SINGLE

/redfish/v1/Managers/1/NetworkProtocol Standard

/redfish/v1/Managers/1/NetworkProtocol/HTTPS/ SFT-DCMS-

Certificates SINGLE

145
 Available APIs

API List License Notes

/redfish/v1/Managers/1/NetworkProtocol/HTTPS/ SFT-DCMS-

Certificates/1 SINGLE

/redfish/v1/Managers/1/NetworkProtocol/HTTPS/ SFT-DCMS-

Certificates/1/Actions/Certificate.Rekey SINGLE

/redfish/v1/Managers/1/NetworkProtocol/HTTPS/ SFT-DCMS-

Certificates/1/RekeyActionInfo SINGLE

/redfish/v1/Managers/1/NetworkProtocol/HTTPS/ SFT-DCMS-

Certificates/1/Actions/Certificate.Renew SINGLE

/redfish/v1/Managers/1/Oem/Supermicro/FanMode Standard

This URI can only be supported on

SFT-DCMS- Intel platforms.

/redfish/v1/Managers/1/Oem/Supermicro/MemoryPFA
SINGLE This feature can be supported on

X13 and future platforms.

This URI can only be supported on

/redfish/v1/Managers/1/Oem/Supermicro/ SFT-DCMS- Intel platforms.

MemoryHealthComp SINGLE This feature can be supported on

X13 and future platforms.

/redfish/v1/Managers/1/Oem/Supermicro/MouseMode Standard

/redfish/v1/Managers/1/Oem/Supermicro/Snooping Standard

/redfish/v1/Managers/1/Oem/Supermicro/Syslog Standard

/redfish/v1/Managers/1/Oem/Supermicro/RADIUS Standard

/redfish/v1/Managers/1/Oem/Supermicro/SMCRAKP Standard

/redfish/v1/Managers/1/Oem/Supermicro/
Standard
IPAccessControl

/redfish/v1/Managers/1/Oem/Supermicro/
Standard
IPAccessControl/FilterRules

/redfish/v1/Managers/1/Oem/Supermicro/
Standard
IPAccessControl/FilterRules/[rule_num]

/redfish/v1/Managers/1/Oem/Supermicro/NTP Standard

/redfish/v1/Managers/1/Oem/Supermicro/LLDP Standard

/redfish/v1/Managers/1/Oem/Supermicro/SmartPower Standard

iKVM over HTML5 can be

/redfish/v1/Managers/1/Oem/Supermicro/IKVM Standard
supported

/redfish/v1/Managers/1/Oem/Supermicro/KCSInterface Standard

146
 Available APIs

API List License Notes

SFT-DCMS-
/redfish/v1/Managers/1/Oem/Supermicro/
SINGLE for
SysLockdown
PATCH

/redfish/v1/Managers/1/LicenseManager Standard

/redfish/v1/Managers/1/LicenseManager/
Standard
ActivateLicense

/redfish/v1/Managers/1/LicenseManager/QueryLicense Standard

/redfish/v1/Managers/1/LicenseManager/ClearLicense Standard

/redfish/v1/Managers/bmc Standard

"BootOrder" property does not

support PATCH method since

SFT-DCMS- X13/H13 platforms Configuring

SINGLE for system boot device order should

/redfish/v1/Systems/1
Bootoption/Bo be via FixedBootOrder

ot Next (/redfish/v1/Systems/1/Oem/Supe

rmicro/

FixedBootOrder)

/redfish/v1/Systems/1/Actions/ComputerSystem.Reset Standard System reset

/redfish/v1/Systems/1/ResetActionInfo Standard

/redfish/v1/Systems/1/Processors Standard

/redfish/v1/Systems/1/Processors/[processor_num] Standard

BIOS-BMC joint feature

/redfish/v1/Systems/1/ProcessorSummary/ SFT-DCMS-
BIOS FW update might be
ProcessorMetrics SINGLE
required

/redfish/v1/Systems/1/Memory Standard

/redfish/v1/Systems/1/Memory/[memory_num] Standard

SFT-DCMS-
/redfish/v1/Systems/1/Memory/1/MemoryMetrics
SINGLE

BIOS-BMC joint feature

redfish/v1/Systems/1/MemorySummary/ SFT-DCMS-
BIOS FW update might be
MemoryMetrics SINGLE
required

/redfish/v1/Systems/1/EthernetInterfaces Standard

BIOS-BMC joint feature

/redfish/v1/Systems/1/EthernetInterfaces/[eth_num] Standard BIOS FW update might be

required

147
 Available APIs

API List License Notes

/redfish/v1/Systems/1/EthernetInterfaces/[eth_num]/VLANs Standard

/redfish/v1/Systems/1/EthernetInterfaces/[eth_num]/VLANs/[vlan_
Standard
instance]

/redfish/v1/Systems/1/EthernetInterfaces/ToManager Standard

SFT-OOB-LIC,

/redfish/v1/Systems/1/SimpleStorage SFT-DCMS-

SINGLE

SFT-OOB-LIC,

/redfish/v1/Systems/1/SimpleStorage/[controller_num] SFT-DCMS-

SINGLE

SFT-OOB-LIC,

/redfish/v1/Systems/1/Storage SFT-DCMS-

SINGLE

Storage AOC installation is

SFT-DCMS- required.
/redfish/v1/Systems/1/Storage/HA-RAID
SINGLE SAS3108, SAS3408, SAS39xx,

SAS38xxIR

Storage AOC installation is

SFT-DCMS- required.
/redfish/v1/Systems/1/Storage/HA-RAID/Volumes
SINGLE SAS3108, SAS3408, SAS39xx,

SAS38xxIR

Storage AOC installation is

/redfish/v1/Systems/1/Storage/HA-RAID/Volumes/ SFT-DCMS- required.

Controller.[controller_num].Volume.[volume_num] SINGLE SAS3108, SAS3408, SAS39xx,

SAS38xxIR

Storage AOC installation is

/redfish/v1/Systems/1/Storage/HA-RAID/Volumes/Controller. required.
SFT-DCMS-
[controller_num].Volume.[volume_ SAS3108, SAS3408, SAS39xx,
SINGLE
num]/Actions/Oem/SmcVolume.Indicate SAS38xxIR

Light on virtual drive LED indicator

Storage AOC installation is

/redfish/v1/Systems/1/Storage/HA-RAID/Volumes/Controller.
SFT-DCMS- required.
[controller_num].Volume.[volume_
SINGLE SAS3108, SAS3408, SAS39xx,
num]/Oem/Supermicro/IndicateActionInfo
SAS38xxIR

148
 Available APIs

API List License Notes

Storage AOC installation is

required.
/redfish/v1/Systems/1/Storage/HA-RAID/Volumes/Controller.
SFT-DCMS- SAS3108, SAS3408, SAS39xx,
[controller_num].Volume.[volume_
SINGLE SAS38xxIR
num]/Actions/Oem/SmcVolume.Delete
To delete a specific drive in logical

view.

Storage AOC installation is

required.
/redfish/v1/Systems/1/Storage/HA- SFT-DCMS-
SAS3108, SAS3408, SAS39xx,
RAID/Actions/Oem/SmcStorage.CreateVolume SINGLE
SAS38xxIR

Create virtual drives

Storage AOC installation is

/redfish/v1/Systems/1/Storage/HA- SFT-DCMS- required.

RAID/Oem/Supermicro/CreateVolumeActionInfo SINGLE SAS3108, SAS3408, SAS39xx,

SAS38xxIR

Storage AOC installation is

required.

/redfish/v1/Systems/1/Storage/HA- SFT-DCMS- SAS3108, SAS3408, SAS39xx,

RAID/Actions/Oem/SmcStorage.ClearVolumes SINGLE SAS38xxIR

To clear all configurations in

logical view.

Storage AOC installation is

/redfish/v1/Systems/1/Storage/HA- SFT-DCMS- required.

RAID/Oem/Supermicro/ClearVolumesActionInfo SINGLE SAS3108, SAS3408, SAS39xx,

SAS38xxIR

Storage AOC installation is

required.

/redfish/v1/Systems/1/Storage/HA- SFT-DCMS- SAS3108, SAS3408, SAS39xx,

RAID/Actions/Oem/SmcHARAIDController.Save SINGLE SAS38xxIR

Save controller's "BIOS Boot

Mode"

Storage AOC installation is

/redfish/v1/Systems/1/Storage/HA- SFT-DCMS- required.

RAID/Oem/Supermicro/SaveActionInfo SINGLE SAS3108, SAS3408, SAS39xx,

SAS38xxIR

149
 Available APIs

API List License Notes

SFT-DCMS- Storage AOC installation is
/redfish/v1/Systems/1/Storage/HBA
SINGLE required.

SFT-DCMS- Storage AOC installation is

/redfish/v1/Systems/1/Storage/HBA/Volumes
SINGLE required.

SFT-DCMS- Storage AOC installation is

/redfish/v1/Systems/1/Storage/RAIDIntegrated
SINGLE required; Must have TAS running.

/redfish/v1/Systems/1/Storage/RAIDIntegrated/ SFT-DCMS- Storage AOC installation is

Volumes SINGLE required; Must have TAS running.

/redfish/v1/Systems/1/Storage/RAIDIntegrated/ SFT-DCMS- Storage AOC installation is

Volumes/[volume_num] SINGLE required; Must have TAS running.

SFT-DCMS- Storage AOC installation is

/redfish/v1/Systems/1/Storage/SATAEmbedded
SINGLE required; Must have TAS running.

/redfish/v1/Systems/1/Storage/SATAEmbedded/ SFT-DCMS- Storage AOC installation is

Volumes SINGLE required; Must have TAS running.

/redfish/v1/Systems/1/Storage/SATAEmbedded/ SFT-DCMS- Storage AOC installation is

Volumes/[volume_num] SINGLE required; Must have TAS running.

SFT-DCMS- Storage AOC installation is

/redfish/v1/Systems/1/Storage/MRVL.HA-RAID
SINGLE required; For Marvell SE9230

SFT-DCMS- Storage AOC installation is

/redfish/v1/Systems/1/Storage/MRVL.HA-RAID/Volumes
SINGLE required; For Marvell SE9230

/redfish/v1/Systems/1/Storage/MRVL.HA- SFT-DCMS- Storage AOC installation is

RAID/Volumes/Controller.[controller_num].Volume.[volume_num] SINGLE required; For Marvell SE9230

Storage AOC installation is

/redfish/v1/Systems/1/Storage/MRVL.HA-
SFT-DCMS- required; For Marvell SE9230. To
RAID/Volumes/Controller.[controller_num].Volume.[volume_
SINGLE delete a specific virtual drive in
num]/Actions/Oem/SmcVolume.DeleteVD
logical view.

Storage AOC installation is

/redfish/v1/Systems/1/Storage/MRVL.HA-
SFT-DCMS- required; For Marvell SE9230. To
RAID/Volumes/Controller.[controller_num].Volume.[volume_
SINGLE rebuild a specific virtual drive in
num]/Actions/Oem/SmcVolume.RebuildVD
logical view.

Storage AOC installation is

/redfish/v1/Systems/1/Storage/MRVL.HA-
SFT-DCMS- required; For Marvell SE9230. To
RAID/Volumes/Controller.[controller_num].Volume.[volume_
SINGLE import a specific virtual drive in
num]/Actions/Oem/SmcVolume.ImportVD
logical view.

150
 Available APIs

API List License Notes

Storage AOC installation is
/redfish/v1/Systems/1/Storage/MRVL.HA- SFT-DCMS-
required; For Marvell SE9230. To
RAID/Actions/Oem/SmcStorage.CreateVD SINGLE
create virtual drives.

SFT-DCMS- Storage AOC installation is

/redfish/v1/Systems/1/Storage/NVMeSSD
SINGLE required.

SFT-DCMS-
/redfish/v1/Systems/1/Bios BIOS current settings.
SINGLE

SFT-DCMS-
/redfish/v1/Systems/1/Bios/SD BIOS pending settings.
SINGLE

SFT-DCMS-
/redfish/v1/Systems/1/Bios/Actions/Bios.ResetBios Reset BIOS settings to default.
SINGLE

/redfish/v1/Systems/1/Bios/Actions/ SFT-DCMS-
Change BIOS booting password.
Bios.ChangePassword SINGLE

/redfish/v1/Systems/1/Bios/ SFT-DCMS-

ChangePasswordActionInfo SINGLE

/redfish/v1/Systems/1/LogServices Standard

/redfish/v1/Systems/1/LogServices/Log1 Standard

/redfish/v1/Systems/1/LogServices/Log1/Actions/
Standard Clear system management logs
LogService.ClearLog

/redfish/v1/Systems/1/LogServices/Log1/Actions/Oem/ SFT-DCMS- Clear acknowledgments of system

SmcLogService.ClearAcknowledgements SINGLE management logs

/redfish/v1/Systems/1/LogServices/Log1/Entries Standard

PATCH method for

/redfish/v1/Systems/1/LogServices/Log1/Entries/[log_num] Standard
acknowledgment;

SFT-DCMS-
/redfish/v1/Systems/1/SecureBoot BIOS secureboot settings.
SINGLE

/redfish/v1/Systems/1/SecureBoot/ SFT-DCMS-
Supported since X13/H13
SecureBootDatabases SINGLE

/redfish/v1/Systems/1/SecureBoot/ SFT-DCMS-
Supported since X13/H13
SecureBootDatabases/dbt SINGLE

/redfish/v1/Systems/1/SecureBoot/ SFT-DCMS-
Supported since X13/H13
SecureBootDatabases/dbr SINGLE

/redfish/v1/Systems/1/SecureBoot/ SFT-DCMS-
Supported since X13/H13
SecureBootDatabases/dbx SINGLE

151
 Available APIs

API List License Notes

/redfish/v1/Systems/1/SecureBoot/ SFT-DCMS-
Supported since X13/H13
SecureBootDatabases/PK SINGLE

/redfish/v1/Systems/1/SecureBoot/ SFT-DCMS-
Supported since X13/H13
SecureBootDatabases/KEK SINGLE

/redfish/v1/Systems/1/SecureBoot/ SFT-DCMS-
Supported since X13/H13
SecureBootDatabases/db SINGLE

BIOS-BMC joint feature

BIOS FW update might be

/redfish/v1/Systems/1/SecureBoot/ SFT-DCMS- required.

SecureBootDatabases/db/Certificates SINGLE Redfish URI will be generated as

signatures, or certificates, or both.

Supported since X13/H13.

BIOS-BMC joint feature

BIOS FW update might be

/redfish/v1/Systems/1/SecureBoot/ SFT-DCMS- required.

SecureBootDatabases/dbt/Certificates SINGLE Redfish URI will be generated as

signatures, or certificates, or both.

Supported since X13/H13.

BIOS-BMC joint feature

BIOS FW update might be

/redfish/v1/Systems/1/SecureBoot/ SFT-DCMS- required.

SecureBootDatabases/dbr/Certificates SINGLE Redfish URI will be generated as

signatures, or certificates, or both.

Supported since X13/H13.

BIOS-BMC joint feature

BIOS FW update might be

/redfish/v1/Systems/1/SecureBoot/ SFT-DCMS- required.

SecureBootDatabases/PK/Certificates SINGLE Redfish URI will be generated as

signatures, or certificates, or both.

Supported since X13/H13.

BIOS-BMC joint feature

BIOS FW update might be

/redfish/v1/Systems/1/SecureBoot/ SFT-DCMS- required.

SecureBootDatabases/KEK/Certificates SINGLE Redfish URI will be generated as

signatures, or certificates, or both.

Supported since X13/H13.

152
 Available APIs

API List License Notes

BIOS-BMC joint feature

BIOS FW update might be

/redfish/v1/Systems/1/SecureBoot/ SFT-DCMS- required.

SecureBootDatabases/dbx/Signatures SINGLE Redfish URI will be generated as

signatures, or certificates, or both.

Supported since X13/H13.

BIOS-BMC joint feature

BIOS FW update might be

/redfish/v1/Systems/1/SecureBoot/ SFT-DCMS- required.

SecureBootDatabases/PK/Certificates/[num] SINGLE Redfish URI will be generated as

signatures, or certificates, or both.

Supported since X13/H13.

BIOS-BMC joint feature

BIOS FW update might be

/redfish/v1/Systems/1/SecureBoot/ SFT-DCMS- required.

SecureBootDatabases/KEK/Certificates/[num] SINGLE Redfish URI will be generated as

signatures, or certificates, or both.

Supported since X13/H13.

BIOS-BMC joint feature

BIOS FW update might be

/redfish/v1/Systems/1/SecureBoot/ SFT-DCMS- required.

SecureBootDatabases/db/Certificates/[num] SINGLE Redfish URI will be generated as

signatures, or certificates, or both.

Supported since X13/H13.

BIOS-BMC joint feature

BIOS FW update might be

/redfish/v1/Systems/1/SecureBoot/ SFT-DCMS- required.

SecureBootDatabases/dbr/Certificates/[num] SINGLE Redfish URI will be generated as

signatures, or certificates, or both.

Supported since X13/H13.

BIOS-BMC joint feature

BIOS FW update might be

/redfish/v1/Systems/1/SecureBoot/ SFT-DCMS- required.

SecureBootDatabases/dbt/Certificates/[num] SINGLE Redfish URI will be generated as

signatures, or certificates, or both.

Supported since X13/H13.

153
 Available APIs

API List License Notes

BIOS-BMC joint feature

BIOS FW update might be

/redfish/v1/Systems/1/SecureBoot/ SFT-DCMS- required.

SecureBootDatabases/dbx/Signatures/[num] SINGLE Redfish URI will be generated as

signatures, or certificates, or both.

Supported since X13/H13.

/redfish/v1/Systems/1/SecureBoot/Actions/ SFT-DCMS-
Reset key for secure boot.
SecureBoot.ResetKeys SINGLE

/redfish/v1/Systems/1/SecureBoot/ SFT-DCMS-

ResetKeysActionInfo SINGLE

/redfish/v1/Systems/1/BootOptions None

This URI does not support PATCH

method, since X13/H13 platforms.

To configure system boot, device

order should be via

/redfish/v1/Systems/1/BootOptions/num None
FixedBootOrder

(/redfish/v1/Systems/1/Oem/Supe

rmicro/

FixedBootOrder)

Configure system boot device

/redfish/v1/Systems/1/Oem/Supermicro/ SFT-DCMS- order via this URI.

FixedBootOrder SINGLE Supported since X13/H13

platforms

SFT-OOB-LIC,

/redfish/v1/Systems/1/NetworkInterfaces SFT-DCMS-

SINGLE

SFT-OOB-LIC,

/redfish/v1/Systems/1/NetworkInterfaces/[ni_num] SFT-DCMS-

SINGLE

SFT-OOB-LIC,

/redfish/v1/Systems/1/NetworkInterfaces/[ni_num]/NetworkPorts SFT-DCMS-

SINGLE

SFT-OOB-LIC,
/redfish/v1/Systems/1/NetworkInterfaces/[ni_
SFT-DCMS-
num]/NetworkDeviceFunctions
SINGLE

RoT2.0 is required. This URI

/redfish/v1/Systems/1/Certificates/ Standard
supported since X13/H13

154
 Available APIs

API List License Notes

RoT2.0 is required. This URI
/redfish/v1/Systems/1/Certificates/[num] Standard
supported since X13/H13

SFT-OOB-LIC, This Redfish API can only be

/redfish/v1/Systems/1/Oem/Supermicro/NodeManager SFT-DCMS- supported on Intel platforms with

SINGLE Intel ME

SFT-OOB-LIC, This Redfish API can only be

/redfish/v1/Systems/1/Oem/Supermicro/NodeManager/
SFT-DCMS- supported on Intel platforms with
Actions/SmcNodeManager.ClearAllPolicies
SINGLE Intel ME

SFT-OOB-LIC,

SFT-DCMS-

/redfish/v1/EventService/Subscriptions SINGLE for

SNMPv3/redfis

SFT-OOB-LIC,

SFT-DCMS-

/redfish/v1/EventService/Subscriptions/[destination_num] SINGLE for

SNMPv3/redfis

/redfish/v1/EventService/Actions/
Standard
EventService.SubmitTestEvent

/redfish/v1/EventService/SubmitTestEventActionInfo Standard

SFT-DCMS-

SINGLE(HGX,

PSU, Storage Post Body with multipart/form-data

/redfish/v1/UpdateService/upload
AOC, DCPMM for MultipartHttpPushUri

DIMM, Network

AOC)

/redfish/v1/UpdateService/FirmwareInventory Standard

/redfish/v1/UpdateService/FirmwareInventory/BMC Standard

/redfish/v1/UpdateService/FirmwareInventory/Backup_BMC Standard

/redfish/v1/UpdateService/FirmwareInventory/Golden_BMC Standard

/redfish/v1/UpdateService/FirmwareInventory/Staging_BMC Standard

/redfish/v1/UpdateService/FirmwareInventory/BIOS Standard

/redfish/v1/UpdateService/FirmwareInventory/Backup_BIOS Standard

/redfish/v1/UpdateService/FirmwareInventory/Golden_BIOS Standard

155
 Available APIs

API List License Notes

/redfish/v1/UpdateService/FirmwareInventory/Staging_BIOS Standard

/redfish/v1/UpdateService/FirmwareInventory/CPLD_Motherboard Standard

/redfish/v1/UpdateService/FirmwareInventory/Golden_CPLD_
Standard
Motherboard

/redfish/v1/UpdateService/FirmwareInventory/Staging_CPLD_
Standard
Motherboard

This Redfish API can only be

/redfish/v1/UpdateService/FirmwareInventory/BIOS_ME Standard
supported on Intel Platform

/redfish/v1/UpdateService/FirmwareInventory/ This URI can only be supported on

Standard
Capsule_ME Intel Platform since X13

/redfish/v1/UpdateService/FirmwareInventory/Staging_Capsule_ This URI can only be supported on

Standard
ME Intel Platform since X13

/redfish/v1/UpdateService/FirmwareInventory/ This URI can only be supported on

Standard
Capsule_BIOS Intel Platform since X13

/redfish/v1/UpdateService/FirmwareInventory/Staging_Capsule_ This URI can only be supported on

Standard
BIOS Intel Platform since X13

/redfish/v1/UpdateService/FirmwareInventory/ This URI can only be supported on

Standard
Capsule_MCU Intel Platform since X13

/redfish/v1/UpdateService/FirmwareInventory/Staging_Capsule_ This URI can only be supported on

Standard
MCU Intel Platform since X13

/redfish/v1/UpdateService/FirmwareInventory/ This URI can only be supported on

Standard
StagingPMem Intel Platform since X13

/redfish/v1/UpdateService/FirmwareInventory/
Standard
PowerSupply[power_supply_num]

/redfish/v1/UpdateService/FirmwareInventory/
Standard
NIC[aoc_card_num]

/redfish/v1/UpdateService/FirmwareInventory/ This URI can only be supported on

Standard
PMem[dcpmm_num] Intel Platform since X13

/redfish/v1/UpdateService/FirmwareInventory/
Standard
Broadcom[broadcom_num]

/redfish/v1/UpdateService/FirmwareInventory/
Standard
Marvell[marvell_num]

/redfish/v1/UpdateService/FirmwareInventory/
Standard
GPU[gpu_num]

/redfish/v1/UpdateService/FirmwareInventory/HGX_A100 Standard

156
 Available APIs

API List License Notes

/redfish/v1/UpdateService/Actions/ SFT-DCMS-

UpdateService.SimpleUpdate SINGLE

SFT-DCMS-
/redfish/v1/UpdateService/SimpleUpdateActionInfo
SINGLE

/redfish/v1/UpdateService/Actions/
Standard
UpdateService.StartUpdate

/redfish/v1/UpdateService/FirmwareInventory/
Standard
SupermicroAOC_[num]_Retimer_[num]

/redfish/v1/UpdateService/FirmwareInventory/
Standard
Backplane_[num]_CPLD_[num]

/redfish/v1/UpdateService/FirmwareInventory/
Standard
Backplane_[num]_nonCPL_[num]

/redfish/v1/UpdateService/FirmwareInventory/
Standard
OtherPCB_[num]_FW

/redfish/v1/UpdateService/FirmwareInventory/
Standard
PSU_[num]_FW

/redfish/v1/UpdateService/FirmwareInventory/
Standard
Switchboard_[num]_CPLD_[num]

/redfish/v1/UpdateService/FirmwareInventory/
Standard
Fanboard_[num]_CPLD_[num]

/redfish/v1/UpdateService/FirmwareInventory/
Standard
SASExpander[num]

SFT-DCMS-
/redfish/v1/UpdateService/Actions/Oem/
SINGLE for FW
SmcUpdateService.Install
Recovery

/redfish/v1/UpdateService/Oem/Supermicro/ SFT-DCMS-

InstallActionInfo SINGLE

View current SSL certification

/redfish/v1/UpdateService/Oem/Supermicro/SSLCert Standard
information

/redfish/v1/UpdateService/Oem/Supermicro/SSLCert/
Standard Upload new SSL certification file
Actions/SmcSSLCert.Upload

/redfish/v1/UpdateService/Oem/Supermicro/
Standard
IPMIConfig

/redfish/v1/UpdateService/Oem/Supermicro/ Upload new BMC configuration file

Standard
IPMIConfig/Actions/SmcIPMIConfig.Upload to set BMC

157
 Available APIs

API List License Notes

/redfish/v1/UpdateService/Oem/Supermicro/ Download BMC configuration as a
Standard
IPMIConfig/Actions/SmcIPMIConfig.Download file

/redfish/v1/UpdateService/Oem/Supermicro/ SFT-DCMS- Supported on X12/H12.

FirmwareInventory SINGLE Deprecated since X13/H13

/redfish/v1/UpdateService/Oem/Supermicro/ SFT-DCMS- Supported on X12/H12.

FirmwareInventory/BMC SINGLE Deprecated since X13/H13

/redfish/v1/UpdateService/Oem/Supermicro/
SFT-DCMS- Supported on X12/H12.
FirmwareInventory/BMC/Actions/
SINGLE Deprecated since X13/H13
SmcFirmwareInventory.EnterUpdateMode

/redfish/v1/UpdateService/Oem/Supermicro/
SFT-DCMS- Supported on X12/H12.
FirmwareInventory/BMC/Actions/
SINGLE Deprecated since X13/H13
SmcFirmwareInventory.Upload

/redfish/v1/UpdateService/Oem/Supermicro/
SFT-DCMS- Supported on X12/H12.
FirmwareInventory/BMC/Actions/
SINGLE Deprecated since X13/H13
SmcFirmwareInventory.Update

/redfish/v1/UpdateService/Oem/Supermicro/ SFT-DCMS- Supported on X12/H12.

FirmwareInventory/BMC/UpdateActionInfo SINGLE Deprecated since X13/H13

/redfish/v1/UpdateService/Oem/Supermicro/
SFT-DCMS- Supported on X12/H12.
FirmwareInventory/BMC/Actions/
SINGLE Deprecated since X13/H13
SmcFirmwareInventory.Cancel

/redfish/v1/UpdateService/Oem/Supermicro/ SFT-DCMS- Supported on X12/H12.

FirmwareInventory/BIOS SINGLE Deprecated since X13/H13

/redfish/v1/UpdateService/Oem/Supermicro/
SFT-DCMS- Supported on X12/H12.
FirmwareInventory/BIOS/Actions/
SINGLE Deprecated since X13/H13
SmcFirmwareInventory.EnterUpdateMode

/redfish/v1/UpdateService/Oem/Supermicro/
SFT-DCMS- Supported on X12/H12.
FirmwareInventory/BIOS/Actions/
SINGLE Deprecated since X13/H13
SmcFirmwareInventory.Upload

/redfish/v1/UpdateService/Oem/Supermicro/
SFT-DCMS- Supported on X12/H12.
FirmwareInventory/BIOS/Actions/
SINGLE Deprecated since X13/H13
SmcFirmwareInventory.Update

/redfish/v1/UpdateService/Oem/Supermicro/ SFT-DCMS- Supported on X12/H12.

FirmwareInventory/BIOS/UpdateActionInfo SINGLE Deprecated since X13/H13

/redfish/v1/UpdateService/Oem/Supermicro/
SFT-DCMS- Supported on X12/H12.
FirmwareInventory/BIOS/Actions/
SINGLE Deprecated since X13/H13
SmcFirmwareInventory.Cancel

158
 Available APIs

API List License Notes

Once the HARAID upgrade has

completed successfully. please

/redfish/v1/UpdateService/Oem/Supermicro/ SFT-DCMS-
reset the system. Supported on
FirmwareInventory/HARAIDController.[controller_num] SINGLE
X12/H12. Deprecated since

X13/H13

Once the HARAID upgrade has

completed successfully. please

/redfish/v1/UpdateService/Oem/Supermicro/ SFT-DCMS-
reset the system. Supported on
FirmwareInventory/MRVL_HARAIDController.[controller_num] SINGLE
X12/H12. Deprecated since

X13/H13

/redfish/v1/Registries/Base Standard

/redfish/v1/Registries/BiosAttributeRegistry Standard

/redfish/v1/Registries/Event Standard

/redfish/v1/Registries/SMC Standard

/redfish/v1/JsonSchemas/[variety_of_services] Standard

/redfish/v1/TaskService/Tasks Standard

/redfish/v1/TaskService/Tasks/[task_num] Standard

/redfish/v1/TaskMonitor/[task_num] Standard

SFT-DCMS-
/redfish/v1/CertificateService/CertificateLocations/
SINGLE

/redfish/v1/CertificateService/Actions/ SFT-DCMS-

CertificateService.GenerateCSR SINGLE

SFT-DCMS-
/redfish/v1/CertificateService/GenerateCSRActionInfo
SINGLE

/redfish/v1/CertificateService/Actions/ SFT-DCMS-

CertificateService.ReplaceCertificate SINGLE

/redfish/v1/CertificateService/ SFT-DCMS-

ReplaceCertificateActionInfo SINGLE

/redfish/v1/Oem/Supermicro/DumpService/Dumps Standard ROT is required.

/redfish/v1/Oem/Supermicro/DumpService/Actions/
Standard ROT is required.
OemDumpService.Collect

ROT is required. This URI can

/redfish/v1/Oem/Supermicro/DumpService/
Standard only be supported on Intel
CreateDumpActionInfo
platforms.

159
 Available APIs

API List License Notes

ROT is required. This URI can
/redfish/v1/Oem/Supermicro/DumpService/Actions/ SFT-DCMS-
only be supported on Intel
SmcDumpService.CreateDump SINGLE
platforms.

/redfish/v1/Oem/Supermicro/DumpService/Actions/ SFT-DCMS-
ROT is required.
SmcDumpService.DeleteAll SINGLE

/redfish/v1/Oem/Supermicro/DumpService/Dumps/ SFT-DCMS-
ROT is required.
HostCrashDump SINGLE

/redfish/v1/Oem/Supermicro/DumpService/Dumps/ SFT-DCMS-
ROT is required.
HostCrashDump/Actions/SmcDump.Download SINGLE

/redfish/v1/Oem/Supermicro/DumpService/Dumps/
Standard ROT is required.
BMCEvidenceDump

/redfish/v1/Oem/Supermicro/DumpService/Dumps/

BMCEvidenceDump/Actions/ Standard ROT is required.

SmcBMCEvidenceDump.Download

/redfish/v1/Oem/Supermicro/DumpService/Dumps/

BMCEvidenceDump/Actions/ Standard ROT is required.

SmcBMCEvidenceDump.Generate

/redfish/v1/Oem/Supermicro/DumpService/Dumps/
Standard ROT is required.
BIOSEvidenceDump

/redfish/v1/Oem/Supermicro/DumpService/Dumps/

BIOSEvidenceDump/Actions/ Standard ROT is required.

SmcBIOSEvidenceDump.Download

/redfish/v1/Oem/Supermicro/DumpService/Dumps/

BIOSEvidenceDump/Actions/ Standard ROT is required.

SmcBIOSEvidenceDump.Generate

/redfish/v1/Oem/Supermicro/DumpService/Dumps/ ROT2.0 is required and supported

Standard
AttestationDump/ since X13/H13

/redfish/v1/Oem/Supermicro/DumpService/Dumps/
ROT2.0 is required and supported
AttestationDump/Actions/ Standard
since X13/H13
SmcAttestationDump.Download

/redfish/v1/Oem/Supermicro/DumpService/Dumps/
ROT2.0 is required and supported
AttestationDump/Actions/ Standard
since X13/H13
SmcAttestationDump.Generate

/redfish/v1/Oem/Supermicro/DumpService/Dumps/ ROT2.0 is required and supported

Standard
AttestationDump/Actions/SmcAttestationDump.Delete since X13/H13

160
 Available APIs

API List License Notes

/redfish/v1/Oem/Supermicro/DumpService/Dumps/
Standard
DriveSmartDump/

/redfish/v1/Oem/Supermicro/DumpService/Dumps/

DriveSmartDump/Actions/ Standard

SmcDriveSmartDump.Download

/redfish/v1/Oem/Supermicro/DumpService/Dumps/

DriveSmartDump/Actions/ Standard

SmcDriveSmartDump.Generate

/redfish/v1/TelemetryService/MetricDefinitions Standard

/redfish/v1/TelemetryService/MetricDefinitions/
Standard
AvgPowerConsumedHour

/redfish/v1/TelemetryService/MetricDefinitions/
Standard
MinPowerConsumedHour

/redfish/v1/TelemetryService/MetricDefinitions/
Standard
MaxPowerConsumedHour

/redfish/v1/TelemetryService/MetricDefinitions/
Standard
AvgPowerConsumedDay

/redfish/v1/TelemetryService/MetricDefinitions/
Standard
MinPowerConsumedDay

/redfish/v1/TelemetryService/MetricDefinitions/
Standard
MaxPowerConsumedDay

/redfish/v1/TelemetryService/MetricDefinitions/
Standard
AvgPowerConsumedWeek

/redfish/v1/TelemetryService/MetricDefinitions/
Standard
MinPowerConsumedWeek

/redfish/v1/TelemetryService/MetricDefinitions/
Standard
MaxPowerConsumedWeek

/redfish/v1/TelemetryService/MetricReportDefinitions Standard

/redfish/v1/TelemetryService/MetricReportDefinitions/
Standard
AvgPowerConsumptionHour

/redfish/v1/TelemetryService/MetricReportDefinitions/
Standard
MinPowerConsumptionHour

/redfish/v1/TelemetryService/MetricReportDefinitions/
Standard
MaxPowerConsumptionHour

161
 Available APIs

API List License Notes

/redfish/v1/TelemetryService/MetricReportDefinitions/
Standard
AvgPowerConsumptionDay

/redfish/v1/TelemetryService/MetricReportDefinitions/
Standard
MinPowerConsumptionDay

/redfish/v1/TelemetryService/MetricReportDefinitions/
Standard
MaxPowerConsumptionDay

/redfish/v1/TelemetryService/MetricReportDefinitions/
Standard
AvgPowerConsumptionWeek

/redfish/v1/TelemetryService/MetricReportDefinitions/
Standard
MinPowerConsumptionWeek

/redfish/v1/TelemetryService/MetricReportDefinitions/
Standard
MaxPowerConsumptionWeek

/redfish/v1/TelemetryService/MetricReports Standard

/redfish/v1/TelemetryService/MetricReports/
Standard
AvgPowerConsumptionHour

/redfish/v1/TelemetryService/MetricReports/
Standard
MinPowerConsumptionHour

/redfish/v1/TelemetryService/MetricReports/
Standard
MaxPowerConsumptionHour

/redfish/v1/TelemetryService/MetricReports/
Standard
AvgPowerConsumptionDay

/redfish/v1/TelemetryService/MetricReports/
Standard
MinPowerConsumptionDay

/redfish/v1/TelemetryService/MetricReports/
Standard
MaxPowerConsumptionDay

/redfish/v1/TelemetryService/MetricReports/
Standard
AvgPowerConsumptionWeek

/redfish/v1/TelemetryService/MetricReports/
Standard
MinPowerConsumptionWeek

/redfish/v1/TelemetryService/MetricReports/
Standard
MaxPowerConsumptionWeek

SFT-OOB-LIC,
Supported on X12/H12.
/redfish/v1/Systems/1/Storage/VROC SFT-DCMS-
Deprecated since X13/H13
SINGLE

162
 Available APIs

API List License Notes

SFT-OOB-LIC,
/redfish/v1/Systems/1/Storage/VROC/Actions/Oem/ Supported on X12/H12.
SFT-DCMS-
SmcVROC.CreateVolume Deprecated since X13/H13
SINGLE

SFT-OOB-LIC,
/redfish/v1/Systems/1/Storage/VROC/Oem/ Supported on X12/H12.
SFT-DCMS-
Supermicro/CreateVolumeActionInfo Deprecated since X13/H13
SINGLE

SFT-OOB-LIC,
/redfish/v1/Systems/1/Storage/VROC/Actions/Oem/ Supported on X12/H12.
SFT-DCMS-
SmcVROC.VolumeDelete Deprecated since X13/H13
SINGLE

SFT-OOB-LIC,
/redfish/v1/Systems/1/Storage/VROC/Oem/ Supported on X12/H12.
SFT-DCMS-
Supermicro/VolumeDeleteActionInfo Deprecated since X13/H13
SINGLE

SFT-OOB-LIC,
/redfish/v1/Systems/1/Storage/VROC/Actions/Oem/ Supported on X12/H12.
SFT-DCMS-
SmcVROC.DriveMarkSpare Deprecated since X13/H13
SINGLE

SFT-OOB-LIC,
/redfish/v1/Systems/1/Storage/VROC/Actions/Oem/ Supported on X12/H12.
SFT-DCMS-
SmcVROC.DriveUnmarkSpare Deprecated since X13/H13
SINGLE

SFT-OOB-LIC,
/redfish/v1/Systems/1/Storage/VROC/Oem/ Supported on X12/H12.
SFT-DCMS-
Supermicro/DriveMakerSpareActionInfo Deprecated since X13/H13
SINGLE

SFT-OOB-LIC,
/redfish/v1/Systems/1/Storage/VROC/Oem/ Supported on X12/H12.
SFT-DCMS-
Supermicro/DriveUnmarkSpareActionInfo Deprecated since X13/H13
SINGLE

SFT-OOB-LIC,
Supported on X12/H12.
/redfish/v1/Systems/1/Storage/VROC/Volumes SFT-DCMS-
Deprecated since X13/H13
SINGLE

SFT-OOB-LIC,
/redfish/v1/Systems/1/Storage/VROC/Volumes/ Supported on X12/H12.
SFT-DCMS-
[volume_num] Deprecated since X13/H13
SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

HGX_FW_GPU_SXM_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

HGX_FW_ERoT_GPU_SXM_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

HGX_FW_NVSwitch_[num] SINGLE

163
 Available APIs

API List License Notes

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

HGX_FW_ERoT_NVSwitch_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

HGX_FW_PCIeSwitch_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

HGX_FW_ERoT_PCIeSwitch_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

HGX_FW_PCIeRetimer_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

HGX_FW_BMC_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

HGX_FW_ERoT_BMC_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

HGX_FW_FPGA_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

HGX_FW_ERoT_FPGA_[num] SINGLE

/redfish/v1/Chassis/1/NetworkAdapters/ SFT-DCMS-

[NetworkAdapterId]/Certificates/[CertificateId] SINGLE

/redfish/v1/Systems/1/Storage/[StorageId]/
SFT-DCMS-
Controllers/[StorageControllerId]/Certificates/
SINGLE
[CertificateId]

SFT-DCMS-
/redfish/v1/Managers/1/SecurityPolicy
SINGLE

/redfish/v1/Managers/1/SecurityPolicy/SPDM/ SFT-DCMS-

TrustedCertificates SINGLE

/redfish/v1/Managers/1/SecurityPolicy/SPDM/ SFT-DCMS-

RevokedCertificates SINGLE

/redfish/v1/Managers/1/SecurityPolicy/SPDM/ SFT-DCMS-

TrustedCertificates/[CertificateId] SINGLE

/redfish/v1/Managers/1/SecurityPolicy/SPDM/ SFT-DCMS-

RevokedCertificates/[CertificateId] SINGLE

SFT-DCMS-
/redfish/v1/ComponentIntegrity
SINGLE

SFT-DCMS-
/redfish/v1/ComponentIntegrity/[ComponentIntegrityId]
SINGLE

164
 Available APIs

API List License Notes

/redfish/v1/ComponentIntegrity/{ComponentIntegrityId}/Actions/ SFT-DCMS-

ComponentIntegrity.SPDMGetSignedMeasurements SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

OnBoard_Retimer_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

UBB_[num]_CPLD_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

Staging_UBB_[num]_CPLD_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

UBB_[num]_AMC_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

Staging_UBB_[num]_AMC_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

UBB_[num]_Retimer_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

Staging_UBB_[num]_Retimer_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

OnBoard_Retimer_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

UBB_[num]_CPLD_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

Staging_UBB_[num]_CPLD_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

UBB_[num]_AMC_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

Staging_UBB_[num]_AMC_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

UBB_[num]_Retimer_[num] SINGLE

/redfish/v1/UpdateService/FirmwareInventory/ SFT-DCMS-

Staging_UBB_[num]_Retimer_[num] SINGLE

/redfish/v1/Managers/1/Oem/Supermicro/
Standard
NodeManager

/redfish/v1/Managers/1/Oem/Supermicro/ SFT-DCMS-

NodeManager/Actions/NodeManager.Reset SINGLE

165
 Available APIs

API List License Notes

/redfish/v1/Managers/1/Oem/Supermicro/
Standard
NodeManager/Domains

/redfish/v1/Managers/1/Oem/Supermicro/
Standard
NodeManager/Domains/[DomainName]

/redfish/v1/Managers/1/Oem/Supermicro/
SFT-DCMS-
NodeManager/Domains/
SINGLE
[DomainName]/Actions/Domain.ResetStatistics

/redfish/v1/Managers/1/Oem/Supermicro/ SFT-DCMS- SFT-DCMS-SINGLE only for

NodeManager/Policies SINGLE POST and DELETE

/redfish/v1/Managers/1/Oem/Supermicro/
Standard
NodeManager/Policies/[PolicyID]

/redfish/v1/Managers/1/Oem/Supermicro/ SFT-DCMS-

NodeManager/Policies/[PolicyID]/Actions/Policy.ResetStatistics SINGLE

/redfish/v1/Managers/1/Oem/Supermicro/
Standard
NodeManager/Triggers

/redfish/v1/Managers/1/Oem/Supermicro/
Standard
NodeManager/Triggers/[TriggerId]

/redfish/v1/Managers/1/Oem/Supermicro/
Standard
NodeManager/ThrottlingStatus

/redfish/v1/ThermalEquipment Standard

/redfish/v1/ThermalEquipment/CDU Standard

/redfish/v1/ThermalEquipment/CDU/[CoolingUnitId] Standard

/redfish/v1/ThermalEquipment/CDU/[CoolingUnitId]/LeakDetection Standard

/redfish/v1/ThermalEquipment/CDU/
Standard
[CoolingUnitId]/LeakDetection/LeakDetectors

/redfish/v1/ThermalEquipment/CDU/
Standard
[CoolingUnitId]/LeakDetection/LeakDetectors/[LeakDetectorId]

/redfish/v1/Systems/1/Actions/Oem/ SFT-DCMS-
For Lego project
OemSystemExtensions.Reset SINGLE

APIs URL Changes

RF 1.11 -> /redfish/v1/UpdateService/FirmwareInventory/Golden_CPLD_Motherboard

RF 1.14 -> /redfish/v1/UpdateService/FirmwareInventory/Golden_Motherboard_CPLD_num

RF 1.11 -> /redfish/v1/Managers/1/LicenseManager/ActivateLicense

166
 Available APIs

RF 1.14 -> /redfish/v1/Managers/1/LicenseManager/Actions/LicenseManager.ActivateLicense

RF 1.11 -> /redfish/v1/Managers/1/LicenseManager/ClearLicense

RF 1.14 -> /redfish/v1/Managers/1/LicenseManager/Actions/LicenseManager.ClearLicense

RF 1.11 -> /redfish/v1/UpdateService/FirmwareInventory/CPLD_Motherboard_num

RF 1.14 -> /redfish/v1/UpdateService/FirmwareInventory/Motherboard_CPLD_num

RF 1.11 -> /redfish/v1/Oem/Supermicro/DumpService/Actions/SmcDumpService.CreateDump

RF 1.14 -> /redfish/v1/Oem/Supermicro/DumpService/Actions/OemDumpService.Collect

RF 1.11 -> /redfish/v1/Oem/Supermicro/DumpService/Actions/SmcDumpService.DeleteAll

RF 1.14 -> /redfish/v1/Oem/Supermicro/DumpService/Actions/OemDumpService.Collect

Privilege Changes since RF1.14.0-00.01

l Storage POST/PATCH Privilege change from ConfigureManager to
ConfigureComponent since X14/H14 (ASPEED 2600, 2700 of X14/H14)
l /redfish/v1/Chassis/HA-RAID.[controller_num].StorageEnclosure.[enclosure_
num]/Drives/Disk.Bay.[disk_num]
l /redfish/v1/Chassis/HA-RAID.[controller_num].StorageEnclosure.[enclosure_
num]/Drives/Disk.Bay.[disk_num]/Actions/Oem/SmcDrive.Indicate (Per task,
deprecate since X14)
l /redfish/v1/Chassis/HA-RAID.[controller_num].StorageEnclosure.[enclosure_
num]/Drives/Disk.Bay.[disk_num]/Actions/Drive.SecureErase
l /redfish/v1/Chassis/HA-RAID.[controller_num].StorageEnclosure.[enclosure_
num]/Drives/Disk.Bay.[disk_num]/Actions/Oem/SmcDrive.SecureEraseAbort
l /redfish/v1/Chassis/HA-RAID.[controller_num].StorageEnclosure.[enclosure_
num]/Drives/Disk.Bay.[disk_num]/Actions/Oem/SmcDrive.AssignSpare
l /redfish/v1/Chassis/HA-RAID.[controller_num].StorageEnclosure.[enclosure_
num]/Drives/Disk.Bay.[disk_num]/Actions/Oem/SmcDrive.DeleteSpare
l /redfish/v1/Chassis/HBA.[controller_num].StorageEnclosure.[enclosure_
num]/Drives/Disk.Bay.[disk_num]/Actions/Oem/SmcDrive.Indicate (Per task,
deprecate since X14)
l /redfish/v1/Chassis/HBA.[controller_num].StorageEnclosure.[enclosure_
num]/Drives/Disk.Bay.[disk_num]

167
 Available APIs

l /redfish/v1/Systems/1/Storage/HA-RAID/Volumes/Controller.[controller_
num].Volume.[volume_num]/Actions/Oem/SmcVolume.Indicate
l /redfish/v1/Systems/1/Storage/HA-RAID/Volumes/Controller.[controller_
num].Volume.[volume_num]/Actions/Oem/SmcVolume.Delete
l /redfish/v1/Systems/1/Storage/HA-RAID/Actions/Oem/SmcStorage.CreateVolume
l /redfish/v1/Chassis/HA-RAID.[controller_num].StorageEnclosure.[enclosure_
num]/Drives/Disk.Bay.[disk_num]/Actions/Oem/SupermicroDrive.DeleteJBOD
l /redfish/v1/Chassis/HA-RAID.[controller_num].StorageEnclosure.[enclosure_
num]/Drives/Disk.Bay.[disk_num]/Actions/Oem/SupermicroDrive.AssignJBOD
l /redfish/v1/Chassis/NVMeSSD.[pcie_controller_num].Group.[group_
num].StorageBackplane/Drives/Disk.Bay.[disk_
num]/Actions/Oem/SmcDrive.Indicate (Per task, deprecate since X14)
l /redfish/v1/Chassis/NVMeSSD.[pcie_controller_num].Group.[group_
num].StorageBackplane/Drives/Disk.Bay.[disk_num]
l /redfish/v1/Systems/1/Storage/HA-RAID/Actions/Oem/SmcStorage.ClearVolumes
l /redfish/v1/Systems/1/Storage/HA-RAID/Actions/Oem/SmcHARAIDController.Save
l /redfish/v1/Systems/1/Storage/MRVL.HA-RAID/Volumes/Controller.[controller_
num].Volume.[volume_num]/Actions/Oem/SmcVolume.DeleteVD
l /redfish/v1/Systems/1/Storage/MRVL.HA-RAID/Volumes/Controller.[controller_
num].Volume.[volume_num]/Actions/Oem/SmcVolume.RebuildVD
l /redfish/v1/Systems/1/Storage/MRVL.HA-RAID/Volumes/Controller.[controller_
num].Volume.[volume_num]/Actions/Oem/SmcVolume.ImportVD
l /redfish/v1/Systems/1/Storage/MRVL.HA-RAID/Actions/Oem/SmcStorage.CreateVD
l Change PATCH privilege from ConfigureComponents to ConfigureManager
l /redfish/v1/Managers/1/Oem/Supermicro/IPAccessControl
l /redfish/v1/Managers/1/VirtualMedia/VirtualMedia[mounted_dev_num]
l the two APIs below will always display
l /redfish/v1/Managers/1/VirtualMedia/VirtualMedia[mounted_dev_
num]/Actions/VirtualMedia.InsertMedia
l /redfish/v1/Managers/1/VirtualMedia/VirtualMedia[mounted_dev_
num]/Actions/VirtualMedia.EjectMedia
l If not supported, the return code will be 400

168
 Available APIs

Deprecated APIs
The following APIs will be deprecated in Redfish X14/H14

/redfish/v1/Oem/Supermicro/DumpService/Dumps/DriveSmartDump/Actions/SmcDriveSmart
Dump.Download

/redfish/v1/Oem/Supermicro/DumpService/Dumps/DriveSmartDump/Actions/SmcDriveSmart
Dump.Generate

The following APIs will be deprecated in Redfish v1.14:

/redfish/v1/Systems/1/SimpleStorage

/redfish/v1/Systems/1/SimpleStorage/1

/redfish/v1/Systems/1/Storage/NVMeSSD/StorageControllers

For below APIs, /redfish/v1/UpdateService/Oem/Supermicro/XXXX is deprecated since

X12/H12, Redfish v1.14 or X13/H13, Redfish v1.11.

Please use /redfish/v1/UpdateService/upload API.

/redfish/v1/UpdateService/Oem/Supermicro/FirmwareInventory/BIOS/Actions/SmcFirmwareI
nventory.Cancel

/redfish/v1/UpdateService/Oem/Supermicro/FirmwareInventory/BIOS/Actions/SmcFirmwareI
nventory.EnterUpdateMode

/redfish/v1/UpdateService/Oem/Supermicro/FirmwareInventory/BIOS/Actions/SmcFirmwareI
nventory.Update

/redfish/v1/UpdateService/Oem/Supermicro/FirmwareInventory/BIOS/Actions/SmcFirmwareI
nventory.Upload

/redfish/v1/UpdateService/Oem/Supermicro/FirmwareInventory/BIOS/UpdateActionInfo

/redfish/v1/UpdateService/Oem/Supermicro/FirmwareInventory/BIOS

/redfish/v1/UpdateService/Oem/Supermicro/FirmwareInventory/BMC/Actions/SmcFirmwareIn
ventory.Cancel

/redfish/v1/UpdateService/Oem/Supermicro/FirmwareInventory/BMC/Actions/SmcFirmwareIn
ventory.EnterUpdateMode

/redfish/v1/UpdateService/Oem/Supermicro/FirmwareInventory/BMC/Actions/SmcFirmwareIn
ventory.Update

/redfish/v1/UpdateService/Oem/Supermicro/FirmwareInventory/BMC/Actions/SmcFirmwareIn
ventory.Upload

169
 Available APIs

/redfish/v1/UpdateService/Oem/Supermicro/FirmwareInventory/BMC/UpdateActionInfo

/redfish/v1/UpdateService/Oem/Supermicro/FirmwareInventory/BMC

/redfish/v1/UpdateService/Oem/Supermicro/FirmwareInventory

170
 Reference Links

Reference Links
Supermicro Redfish:

https://www.supermicro.com/solutions/Redfish.cfm

Supermicro on YouTube:

https://www.youtube.com/SupermicroSoftware

DMTF Redfish:

http://www.dmtf.org/standards/redfish

http://redfish.dmtf.org/

Mockups:

http://redfish.dmtf.org/redfish/v1

Supermicro Technical Support:

[email protected]

171
 Redfish 5.0: Contacting Supermicro

Contacting Supermicro
Headquarters
Address: Super Micro Computer, Inc.
980 Rock Ave.
San Jose, CA 95131 U.S.A.
Tel: +1 (408) 503-8000
Fax: +1 (408) 503-8008
Email: [email protected] (General Information)
[email protected] (Sales Inquiries)
[email protected] (Gov. Sales Inquiries)
[email protected] (Technical Support)
[email protected] (RMA Support)
[email protected] (Webmaster)
Website: https://www.supermicro.com

Europe
Address: Super Micro Computer B.V.
Het Sterrenbeeld 28, 5215 ML
's-Hertogenbosch, The Netherlands
Tel: +31 (0) 73-6400390
Fax: +31 (0) 73-6416525
Email: [email protected] (Sales Inquiries)
[email protected] (Technical Support)
[email protected] (RMA Support)
Website: https://www.supermicro.nl

Asia-Pacific
Address: Super Micro Computer, Inc.
3F, No. 150, Jian 1st Rd.
Zhonghe Dist., New Taipei City 235 Taiwan (R.O.C)
Tel: +886 (2) 8226-3990
Fax: +886 (2) 8226-3992
Email: [email protected] (Sales Inquiries)
[email protected] (Technical Support)
[email protected] (RMA Support)
Website: https://www.supermicro.com.tw

172