Redfish Reference Guide - Supermicro

1 Redfish Reference Guide Revision Supermicro Redfish Reference Guide 2 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, makes no commitment to update or to keep current the information in this manual, or to notify any person organization of the updates. Please Note: For the most up-to-date version of this manual, please see our web site at 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.

2 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.

3 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. Manual Revision Release Date: May 10, 2023 Unless you request and receive written permission from Super Micro Computer, Inc., you may not copy any part of this document. Information in this document is subject to change without notice.

4 Other products and companies referred to herein are trademarks or registered trademarks of their respective companies or mark holders. Copyright 2023 Super Micro Computer, Inc. All rights reserved. Printed in the United States of America Supermicro Redfish Reference Guide 3 Revision History Date Rev. Description 03/21/2022 Made corrections and changes in revision 09/26/2022 1. Deleted Section 6: AuthFailureLoggingThreshold: 2. Modified Section : Replacing a Certificate 3. Modified Section : SendTestEvent-> SubmitTestEvent 4. Modified Section17,18: Method, Response of Jsonschema 5. Delete SMTP section (deprecated in RF ) 6. Modified SNMP Section 7. Modified Available APIs - / Redfish /v1/ - / Redfish /v1/UpdateService/FirmwareInvent ory/Backup_BIOS - / Redfish /v1/UpdateService/FirmwareInvent ory/Backup_BMC 11/01/2022 Fix uri to / Redfish /v1/Registries/Base Added Check Task State.

5 04/06/2023 1. Added the FixedBootOder section. 2. Modified the VirtualMedia section. 3. Updated the API URI list. 4. Added the Updated the NIC Firmware chapter. 5. Adde support for activating via the Redfish API. Supermicro Redfish Reference Guide 4 Contents 1 Applicable or Supported Platforms .. 8 2 9 3 HTTP Request Methods .. 10 Responses .. 10 HTTP Status Code Description .. 11 4 Using RESTful APIs .. 12 Authentication .. 12 Basic Authentication .. 12 Session Management .. 13 5 FirmwareInventory and UpdateService .. 15 FirmwareInventory .. 15 Firmware Resiliency Actions .. 16 Updating BIOS Firmware .. 17 Updating BMC Firmware .. 18 Updating CPLD Firmware .. 19 Simple Update .. 20 Updating Broadcom Storage Controller Firmware .. 21 Updating Marvel Storage Controller Firmware .. 22 Updating AOC NIC Firmware.

6 22 Updating SSL Certificate and Key .. 23 6 Account Service .. 24 Creating a User .. 24 Configuring User Lockout .. 24 Active Directory .. 24 LDAP .. 25 7 System Management .. 26 Changing a Password .. 26 Configuring BIOS over Redfish .. 26 Modifying BIOS 28 Viewing Pending Settings .. 28 Resetting BIOS .. 28 Boot Options .. 29 Configuring the Boot Order in System BIOS .. 29 Configuring UefiBootNext .. 30 Supermicro Redfish Reference Guide 5 Secure Boot .. 31 Enabling Redfish Secure Boot by GET .. 31 Enabling Redfish Secure Boot by PATCH .. 31 Confirming in Pending 32 Enabling Secureboot in BIOS .. 33 8 CertificateService .. 34 Generating CSR .. 35 Generating CSR Action Info .. 35 Generating a CSR Request .. 36 Viewing Certificate Details .. 37 Replacing a Certificate .. 38 Replacing Certificate Action Info.

7 38 Renewing a Certificate .. 38 Replacing the Key Certificate .. 39 9 Event Service .. 40 Adding a Subscription .. 40 Viewing All Subscriptions .. 41 Deleting a Subscription .. 41 Testing an Event Subscription .. 41 10 Virtual Media Management .. 43 Mounting and Configuring the Virtual Media Settings .. 43 Checking the Task State .. 43 Verifying the ISO was Mounted by the Redfish Command .. 44 Unmounting the ISO .. 45 Verifying the ISO was Unmounted by the Redfish Command .. 46 11 Device Management .. 47 NIC Device .. 47 GPU .. 49 NVMeSSD .. 50 PCIe Functions .. 51 12 RAID Management .. 52 Viewing Details of HA-RAID Controller, Drive and Volume .. 52 Viewing Details of HBA Controller, Drive and Volume .. 53 Creating LSI31XX/39XX Logical Volume .. 54 Locating Physical HDD .. 54 Locating Logical Volume .. 54 Deleting Logical Volume.

8 55 Supermicro Redfish Reference Guide 6 Clearing All Logical Volumes .. 55 Saving HA-Raid Controller Configuration .. 55 Viewing Details of Marvell Controller, Drive and Volume 55 Creating a Virtual Drive for Marvell .. 56 Deleting a Virtual Drive for Marvell .. 56 Rebuilding a Virtual Drive for 56 Importing a Virtual Drive for Marvell .. 56 NVME SSD .. 57 13 Network Management .. 58 Viewing Network Settings .. 58 IPv6 Configuration .. 59 Host Interface .. 59 Enabling Host Interface .. 59 Editing a Host IP Address .. 60 14 TelemetryService .. 61 Metric Definitions .. 62 Metric Report Definitions .. 63 Metric Reports .. 64 15 DumpService .. 65 CreateDump .. 66 HostCrashDumps .. 67 Downloading Crash Dump .. 68 16 Log Service .. 69 System Health Event Log .. 69 Supported Actions .. 69 Log Entry Collection.

9 70 Maintenance Event Log .. 71 Supported Actions .. 71 Log Entry Collection .. 72 17 Jsonschema .. 73 18 73 19 Examples .. 74 System Reset .. 74 Notifications .. 75 SNMP .. 75 Syslog .. 75 Supermicro Redfish Reference Guide 7 FanMode .. 75 NTP .. 76 76 Snooping .. 76 IP Access Control .. 76 Adding a Rule .. 77 Deleting a Rule .. 77 SMCRAKP .. 77 IKVM .. 77 iKVM Mouse Mode .. 78 KCS Channel Control .. 78 Getting MAC Addresses from System NICs .. 79 Python Code for Redfish API Response .. 79 Chassis Intrusion .. 80 20 FixedBootOrder .. 81 Changing the Boot Order .. 81 Getting the Current Boot Order .. 81 Changing the Current Boot Order .. 82 21 Activating via Redfish API .. 84 22 Available APIs .. 85 23 Reference Links .. 98 Contacting Supermicro .. 99 Supermicro Redfish Reference Guide 8 1 Applicable or Supported Platforms The Redfish Reference Guide applies to X12 and H12 platforms.

10 The supported platforms are as follows: X12 DPi-N(T)6 X12 DPU-6 X12 DDW-A6 X12 DPT-B6 X12 DPG-QT6 X12 DPFR-AN6 X12 DGO-6 X12 DPD-A6M25 X12 DPG-OA6 B12 DPT-6 X12 DAi-N6 X12 DHM X12 SPi-TF X12 SPW-F/TF X12 SPO-F/NTF X12 SPM-LN4F/LN6TF/TF X12 SPL-F/LN4F X12 SPA-TF H12 DSG-O-CPU H12 SSW-iNR/NTR H12 SSL-i/C/CT/NT H12 DSG-Q-CPU6 H12 SSFR-AN6 H12 SSFF-AN6 M12 SWA-TF H12 DGO-6 H12 SSW-AN6 H12 DSi-6/NT6 H12 SSG-6 BH12 SSi-M25 H12 DSU-iN H12 SSW-iN/NT H12 DST-B H12 SST-PS Supermicro Redfish Reference Guide 9 2 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.