openbmc/docs/host-management.md

3 This document describes the host-management interfaces of the OpenBMC object
9 [REST-cheatsheet](https://github.com/openbmc/docs/blob/master/REST-cheatsheet.md#establish-rest-con…
15 …-k -H "Content-Type: application/json" -X POST https://${bmc}/login -d '{"username" :  "root", "pa…
16 $ curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/...
21 The system inventory structure is under the `/xyz/openbmc_project/inventory`
25 physical system topology. Items in the inventory are referred to as inventory
26 items and are not necessarily FRUs (field-replaceable units). If the system
30 `inventory/system/chassis0/motherboard0/cpu0`
35 - `Version`: A code version associated with this item.
36 - `Present`: Indicates whether this item is present in the system (True/False).
37 - `Functional`: Indicates whether this item is functioning in the system
40 The usual `list` and `enumerate` REST queries allow the system inventory
44     $ curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/inventory/enumerate
48 …$ curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/inventory/system/chassis/mo…
52 The system sensor structure is under the `/xyz/openbmc_project/sensors`
55 This interface allows monitoring of system attributes like temperature or
57 the top-level `sensors` object name. The path categorizes the sensor and shows
59 topology of the system.
66 - `Value`: Current value of the sensor
67 - `Unit`: Unit of the value and "Critical" and "Warning" values
68 - `Scale`: The scale of the value and "Critical" and "Warning" values
69 - `CriticalHigh` & `CriticalLow`: Sensor device upper/lower critical threshold
71 - `CriticalAlarmHigh` & `CriticalAlarmLow`: True if the sensor has exceeded the
73 - `WarningHigh` & `WarningLow`: Sensor device upper/lower warning threshold
75 - `WarningAlarmHigh` & `WarningAlarmLow`: True if the sensor has exceeded the
80 …$ curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/sensors/temperature/ocp_zone
90         "Scale": -3,
102 Note the value of this sensor is 34.625C (34625 \* 10^-3).
107 To enumerate all sensors in the system:
109     $ curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/sensors/enumerate
113 …  $ curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/sensors/temperature/outlet
121 BMC and host firmware on POWER-based servers can report event logs to the BMC.
127 - `Message`: The type of event log (e.g.
129 - `Resolved` : Indicates whether the event has been resolved.
130 - `Severity`: The level of problem ("Info", "Error", etc.).
131 - `Timestamp`: The date of the event log in epoch time.
132 - `Associations`: A URI to the failing inventory part.
136     $ curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/logging/entry
153     $ curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/logging/entry/1
165         "Version": "2.8.0-dev-132-gd1c1b74-dirty",
175 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X POST -d '{"data" : []}'…
177 To clear all event logs, call the top-level `DeleteAll` method:
179 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X POST -d '{"data" : []}'…
183 With OpenBMC, the Host boot options are stored as D-Bus properties under the
184 `control/host0/boot` path. Properties include
185 …BootMode`](https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_projec…
186 …otSource`](https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_projec…
188 …BootType`](https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_projec…
190 - Set boot mode:
193 …-k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT https://${bmc}/xyz/openbmc…
196 - Set boot source:
199 …-k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT https://${bmc}/xyz/openbmc…
202 - Set boot type (valid only if host is based on the x86 CPU):
205 …-k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT https://${bmc}/xyz/openbmc…
209 [`Enable`](https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project…
210 properties that control if the boot source override is persistent or one-time,
213 - Set boot override one-time flag:
216 …l -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT https://${bmc}/xyz/openb…
219 - Enable boot override:
222 … curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT https://${bmc}/xyz/o…
225 ## Host State Control
234 $ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -d '{"data": "xyz.openbmc_p…
240 $ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -d '{"data": "xyz.openbmc_p…
246 $ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT -d '{"data":"xyz.ope…
252 $ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT -d '{"data":"xyz.ope…
256 https://github.com/openbmc/phosphor-dbus-interfaces/tree/master/yaml/xyz/openbmc_project/State
260 On OpenPOWER systems, the host maintains a record of bad or non-working
267 - Method 1: From the BMC command line:
271     /org/open_power/control/gard \
275 - Method 2: Using the REST API:
278 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X POST -d '{"data":[]}' h…
281 Implementation: https://github.com/openbmc/openpower-pnor-code-mgmt
290 target. System settings will then determine the recovery behavior from that
291 state, for example, attempting to reboot the system.
293 The host watchdog utilizes the generic [phosphor-watchdog][1] repository. The
295 phosphor-watchdog:
297     /lib/systemd/system/phosphor-watchdog@poweron.service.d/poweron.conf
302 information for phosphor-watchdog (more information on these can be found in the
303 [phosphor-watchdog][1] repository).
307     phosphor-watchdog@poweron.service
308     obmc-enable-host-watchdog@0.service
310 `phosphor-watchdog@poweron` starts the host watchdog service and
311 `obmc-enable-host-watchdog` starts the watchdog timer. Both are run as a part of
312 the `obmc-host-startmin@.target`. Service dependencies ensure the service is
320 [1]: https://github.com/openbmc/phosphor-watchdog
322 …https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/State/Wat…