Define redfish fw inventory status object mappings
The Redfish software inventory objects have a Status object associated
with them. Use this to provide accurate status back to the user on their
requested inventory item
Change-Id: Ic5d0c4342d7439cad9f07d6bfe8aeeff9dc0713a
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
diff --git a/designs/firmware-update-over-redfish.md b/designs/firmware-update-over-redfish.md
index 7486c2e..074e454 100644
--- a/designs/firmware-update-over-redfish.md
+++ b/designs/firmware-update-over-redfish.md
@@ -70,6 +70,7 @@
implemented by OpenBMC once approved. The existing API will continue to be
supported within the Redfish specification so the OpenBMC 2.7 release will
support this.
+ - Must provide status to user on their image during an update
- Support a subset of ApplyTime (Immediate, OnReset)
- Support a TFTP based SimpleUpdate
- This must be configurable (enable/disable) via compile option within bmcweb
@@ -125,6 +126,24 @@
Note that the ApplyTime property is global to all firmware update packages and
will be used for all subsequent firmware update packages.
+### Status of an Image
+
+The user needs to know the status of their firmware images, especially during
+an update. The Task concept is still being defined within the DMTF and will
+provide the full status of an image during upload and activate.
+Using the Status object associated with the software inventory items will be
+used as a mechanism to provide status of inventory items back to the user.
+Here is the mapping of [phosphor activation states][13] to
+[Redfish Status States][14].
+```
+NotReady -> Disabled
+Invalid -> Disabled
+Ready -> Disabled
+Activating -> Updating
+Active -> Enabled
+Failed -> Disabled
+```
+
### Change the Priority of an Image
On OpenBMC systems that support multiple flash images for one target, there will
@@ -221,3 +240,5 @@
[10]: https://github.com/DMTF/Redfish/issues/3357
[11]: https://github.com/DMTF/Redfish/pull/3296
[12]: https://github.com/DMTF/Redfish/pull/3420
+[13]: https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/xyz/openbmc_project/Software/Activation.interface.yaml
+[14]: http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status