summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Tritz <mtritz@us.ibm.com>2017-09-29 16:30:26 -0500
committerMichael Tritz <mtritz@us.ibm.com>2017-09-29 16:30:49 -0500
commita86aaa9036730203b85666955dcb065ccf044f59 (patch)
tree1f2c2a4890c82d6d3ac72e1569f360fda26e4814
parent77e153f8e8a6d0c5b6b3b519491cce8bdebdb854 (diff)
downloadopenpower-dbus-interfaces-a86aaa9036730203b85666955dcb065ccf044f59.zip
openpower-dbus-interfaces-a86aaa9036730203b85666955dcb065ccf044f59.tar.gz
Factory reset documentation for OpenPower service
This commit adds documentation for the the factory reset interface for the org.open_power.Software.Host.Updater interface. Change-Id: If6d719e6c795480d8c7e38e0c1190c7da2274f7c Signed-off-by: Michael Tritz <mtritz@us.ibm.com>
-rw-r--r--xyz/openbmc_project/Common/FactoryReset/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/xyz/openbmc_project/Common/FactoryReset/README.md b/xyz/openbmc_project/Common/FactoryReset/README.md
new file mode 100644
index 0000000..13afc66
--- /dev/null
+++ b/xyz/openbmc_project/Common/FactoryReset/README.md
@@ -0,0 +1,19 @@
+# Factory Reset
+
+## Overview
+
+The OpenBMC API defines a factory reset interface, which is intended to be used
+to restore the BMC to its original manufacturer settings. This interface is
+defined generically; it is specifically and variously implemented throughout
+OpenBMC services, which allows these services to be individually restored to
+factory defaults as needed.
+
+More reading for OpenBMC services [here](https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/xyz/openbmc_project/Common/FactoryReset/README.md).
+
+## Known Implementations (listed by D-Bus service)
+
+### org.open_power.Software.Host.Updater
+Path: `/xyz/openbmc_project/software`
+The host software updater factory reset immediately clears persistence files
+and any data stored in the read-write and preserved volumes created by the host
+BIOS.
OpenPOWER on IntegriCloud