BMC Configuration Examples
You can integrate current APIs into their software and applications in order to receive all services provided by Redfish APIs.
Manager ResetToDefaults
URI: /redfish/v1/Managers/1/Actions/Manager.ResetToDefaults
Method: POST
ResetType: PreserveNetworkAndUsers, ResetAll
Payload:
{
"ResetType":"(ResetType)"
}
Response: 200
{
"Success": {
"code": "Base.v1_10_3.Success",
"message": "Successfully Completed Request."
}
}
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 Gen 14 motherboards.
URI: /redfish/v1/Chassis/1
Method: PATCH
AllowableValues: true, false
Payload:
{
"Oem": {
"Supermicro": {
"StandbyPowerControl": {
"AIOMEnabled": true
}
}
}
}
Response: 200
Clear CMOS
Note: This function is supported beginning with Gen 14 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 Gen 14 motherboards.
URI: /redfish/v1/Systems/1/Actions/Oem/OemSystemExtensions.Reset
Method: POST
Response: 200
Payload:
{
"ResetType": "ACCycle"
}
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:
{
"EnableSyslog": true,
"SyslogPortNumber": 514,
"SyslogServer": "10.136.176.16"
}
GET Syslog
-
Before BMC firmware versions Gen 13 1.10 and Gen 14 1.08:
URI: /redfish/v1/Managers/1/Oem/Supermicro/Syslog
Method: GET
{
"@odata.type": "#Syslog.v1_0_1.Syslog",
"@odata.id": "/redfish/v1/Managers/1/Oem/Supermicro/Syslog",
"Id": "Syslog",
"Name": "Syslog",
"EnableSyslog": false,
"SyslogServer": "",
"SyslogPortNumber": 0
}
-
Since BMC firmware versions Gen 13 1.10 and Gen 14 1.08:
URI: /redfish/v1/Managers/1/Oem/Supermicro/Syslog
Method: GET
{
"@odata.type": "#Syslog.v1_0_2.Syslog",
"@odata.id": "/redfish/v1/Managers/1/Oem/Supermicro/Syslog",
"Id": "Syslog",
"Name": "Syslog",
"EnableSyslog": false,
"SyslogServer": [
{
"ServerIP": "xxx.xxx.xxx.xxx",
"Port": (integer)
},
{
"ServerIP": null,
"Port": null
},
{
"ServerIP": null,
"Port": null
}
],
"@odata.etag": "\"fa6d9d38cfa24edbec2b9ddd4ddfe5e4\""
}
PATCH Syslog
-
Before BMC firmware versions Gen 13 1.10 and Gen 14 1.08:
URI: /redfish/v1/Managers/1/Oem/Supermicro/Syslog
Method: PATCH
Payload:
{
"EnableSyslog": true,
"SyslogPortNumber": 514,
"SyslogServer": "10.136.176.16"
}
-
Since BMC firmware versions Gen 13 1.10 and Gen 14 1.08:
URI: /redfish/v1/Managers/1/Oem/Supermicro/Syslog
Method: PATCH
Payload:
{
"EnableSyslog": true,
"SyslogServer": [
{
"ServerIP": "1.2.3.4",
"SyslogPortNumber": 514
}
]
}
FanMode
URI: /redfish/v1/Managers/1/Oem/Supermicro/FanMode
Method: PATCH
Payload:
{
"Mode": "FullSpeed"
}
Mode Allowable Values: {"Standard", "FullSpeed", "Optimal", "PUE2","HeavyIO"}
GET FanMode
URI: /redfish/v1/Managers/1/Oem/Supermicro/FanMode
Method: GET
Response:
{
"@odata.type": "#FanMode.v1_0_1.FanMode",
"@odata.id": "/redfish/v1/Managers/1/Oem/Supermicro/FanMode",
"Name": "FanMode",
"Id": "Fan Mode",
"Mode": "Standard",
"Mode@Redfish.AllowableValues": [
"Standard",
"FullSpeed",
"PUE2",
"HeavyIO"
],
"@odata.etag": "\"5b0d65aea89689a2e4ee563be7865b98\""
}
PATCH FanMode
URI: /redfish/v1/Managers/1/Oem/Supermicro/FanMode
Method: PATCH
All Allowable Values for Mode: Standard, FullSpeed, PUE2, HeavyIO, PUE3, LiquidCooling, Smart, PUEOptimalSpeed, SmartCoolingSpeed, Performance, Silent
Note: Not all modes are supported on every system; to know which are supported on your system, check Mode@Redfish.AllowableValues. Silent and Performance mode are currently only supported on X14SAE/X14SAE-F.
Payload:
{
"Mode": "(value)"
}
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\""
}
URI: /redfish/v1/Managers/1/NetworkProtocol
Method: PATCH
Payload:
{
"NTP": {
"ProtocolEnabled":"true",
"NTPServers":"127.0.0.1",
}
}
Response: 202
Note: Check the task monitor to check the progress for NTP.
GET NTP
-
Before BMC firmware versions Gen 12 1.14, Gen 13 1.12, and Gen 14 1.10:
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\""
}
-
Supported since BMC firmware versions Gen 12 1.14, Gen 13 1.12, and Gen 14 1.10:
URI: /redfish/v1/Managers/1/NetworkProtocol
Method: GET
Response: 200
...,
"NTP": {
"ProtocolEnabled": true,
"NTPServers": [
"172.31.44.202",
"127.0.0.1"
],
},
...
PATCH NTP
-
Before BMC firmware versions Gen 12 1.14, Gen 13 1.12, and Gen 14 1.10:
URI: /redfish/v1/Managers/1/NetworkProtocol
Method: PATCH
Payload:
{
"NTP" : {
"ProtocolEnabled":"true",
"NTPServers":"127.0.0.1",
}
}
Response: 200
Note: Check the task monitor to view the progress for NTP.
-
Supported since BMC firmware versions Gen 12 1.14, Gen 13 1.12, and Gen 14 1.10:
URI: /redfish/v1/Managers/1/NetworkProtocol
Method: PATCH
Payload:
{
"NTP": {
"NTPServers": [
"tock.stdtime.gov.tw",
"watch.stdtime.gov.tw",
"time.stdtime.gov.tw"
]
}
}
Clear NTP Servers
Note: This feature is supported since BMC firmware versions Gen 12 1.14, Gen 13 1.12, and Gen 14 1.10.
URI: /redfish/v1/Managers/1/NetworkProtocol
Method: PATCH
Payload: One of the following:
-
{
"NTP": {
"NTPServers": [
null,
null,
null
]
}
}
-
{
"NTP": {
"NTPServers": [
"",
"",
""
]
}
}
Response: 200
NTP AutoDST Enabled
URI: /redfish/v1/Managers/1
Method: PATCH
Allowable Value: false, true
Payload: 200
{
"AutoDSTEnabled": false
}
Note: AutoDSTEnabled can only be PATCH as true if the system supports changing time zones.
SmartPower
Supported platform: Gen 14
URI: /redfish/v1/Managers/1/Actions/Oem/SmartPower
Method: PATCH
Value:
-
For FlexTwin only: SmartPowerModeOn, HPCNPowerModeOn
-
For other platforms: SmartPowerModeOn, SmartPowerModeOff
Payload:
{
"Option": (value)
}
Response: 200
SyncTime
URI: /redfish/v1/Managers/1/Actions/Oem/SupermicroManager.SyncTime
Method: POST
Value: Host
Response: 200
{
"TimeSource": "Host"
}
RADIUS
URI: /redfish/v1/Managers/1/Oem/Supermicro/RADIUS
Method: PATCH
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
The following two APIs have been supported since Gen 15.
-
/redfish/v1/Managers/1/Oem/Supermicro/IPAccessControl/FilterRules
-
/redfish/v1/Managers/1/Oem/Supermicro/IPAccessControl/FilterRules/num
GET IP Access Control
-
Before SmcIPAccessControl Ver. 1_1_0:
URI: /redfish/v1/Managers/1/Oem/Supermicro/IPAccessControl
Method: GET
{
"@odata.type": "#IPAccessControl.v1_0_1.IPAccessControl",
"@odata.id": "/redfish/v1/Managers/1/Oem/Supermicro/IPAccessControl",
"Id": "IP Access Control",
"Name": "IP Access Control",
"ServiceEnabled": false,
"FilterRules": {
"@odata.id": "/redfish/v1/Managers/1/Oem/Supermicro/IPAccessControl/FilterRules"
}
}
Response: 200
-
Since SmcIPAccessControl Ver. 1_1_0:
URI: /redfish/v1/Managers/1/Oem/Supermicro/IPAccessControl
Method: GET
{
"@odata.id": "/redfish/v1/Managers/1/Oem/Supermicro/IPAccessControl",
"@odata.type": "#SmcIPAccessControl.v1_1_0.SmcIPAccessControl",
"Id": "IPAccessControl",
"Name": "IP Access Control",
"ServiceEnabled": true,
"Rules": [
{
"Address": "192.1.21.1.100",
"PrefixLength": 32,
"Policy": "Accept"
},
{
"Address": "192.1.21.2.0",
"PrefixLength": 24,
"Policy": "Drop"
},
{
"Address": "fe80::abcd:1234",
"PrefixLength": 64,
"Policy": "Accept"
}
]
}
Response: 200
Enable Service
URI: /redfish/v1/Managers/1/Oem/Supermicro/IPAccessControl
Method: PATCH
Payload:
{
"ServiceEnabled": true
}
Modifying Rules
-
To keep an item unchanged, use {} as its index.
-
To delete an item, use null as its index.
-
To modify an item, put the content as its index.
URI: /redfish/v1/Managers/1/Oem/Supermicro/IPAccessControl
Method: PATCH
Payload:
{
"Rules": [
null,
{
"Address": "192.168.3.1",
"PrefixLength": 24,
"Policy": "Drop"
},
{}
]
}
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
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:
-
Administrator: Users accessing KCS interface will be able to perform all the operations that the administrator user can.
-
Operator: Users accessing KCS interface will be able to perform all the operations that users with Operator privileges can.
-
User: Users accessing the KCS interface will be able to perform all the operations that users with User privileges can.
-
Callback: This is the lowest privilege level. Only commands necessary to support initiating a Callback are allowed.
-
DisableKCS: Disabling KCS function, supported since KCS version 1.1.0; you can check in "@odata.type".
URI: /redfish/v1/Managers/1/Oem/Supermicro/KCSInterface
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": ""
}
Chassis Intrusion
The user can set the option to Automatic and Manual to clear a chassis intrusion.
By default, the value is Manual. If PhysicalSecurity.IntrusionSensorReArm is set to Automatic, the chassis sensor should auto-reset once the cover is closed.
URI: /redfish/v1/Chassis/1
Method: PATCH
-
Value: HardwareIntrusion, Normal, TamperingDetected
Payload:
{
"PhysicalSecurity": {
"IntrusionSensor": "(value)"
}
}
-
Value: Automatic, Manual
Payload:
{
"PhysicalSecurity": {
"IntrusionSensorReArm": "(value)"
}
}
Network DNS
|
Supported Platforms |
Supported BMC Firmware |
Redfish User Guide Version |
|---|---|---|
|
Gen 12 |
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
GET SharedNetworkPorts Collection
URI: /redfish/v1/Managers/1/SharedNetworkPorts
Method: GET
Response: 200
{
"@odata.type": "#PortCollection.PortCollection",
"@odata.id": "/redfish/v1/Managers/1/SharedNetworkPorts",
"Name": "SharedNetworkPorts Collection",
"Description": "Collection of SharedNetworkPorts",
"Members@odata.count": 1,
"Members":[
{
"@odata.id": " /redfish/v1/Chassis/1/NetworkAdapters/1/Ports/1"
}
],
"@odata.etag": "894cb8ea4eb6da2fb62990a90f2d2859"
}
GET DedicatedNetworkPorts Collection
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",
"Members@odata.count": 1,
"Members":[
{
"@odata.id": "/redfish/v1/Managers/1/DedicatedNetworkPorts/1"
}
],
"@odata.etag": "2a446445042d962d51a0f0c17658d6e1"
}
GET DedicatedNetworkPorts Information
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":{},
"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 since Gen 13.
Enable/Disable Power Capping
URI: /redfish/v1/Chassis/1/Controls/CPU_PowerLimit
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/CPU_PowerLimit
Method: PATCH
Response: 200
Payload:
{
"SetPoint": 400
}
License Required: SFT-DCMS-SINGLE
Priviledge Required: ConfigureManager
Node Manager
Note: Supported beginning with Gen 14.
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
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
"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
"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
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
}
...
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:
{
}