diff options
author | Michael Tritz <mtritz@us.ibm.com> | 2017-09-07 14:39:54 -0500 |
---|---|---|
committer | Brad Bishop <bradleyb@fuzziesquirrel.com> | 2017-10-02 01:53:01 +0000 |
commit | 73b90641813116e934d347e7f0bcb946b690ef3b (patch) | |
tree | ef48ae571d409d34c307a6f6250dd80c7ec4b257 | |
parent | 02b39246d45ea029a1652a49cc20eab7723dd63b (diff) | |
download | phosphor-dbus-interfaces-73b90641813116e934d347e7f0bcb946b690ef3b.tar.gz phosphor-dbus-interfaces-73b90641813116e934d347e7f0bcb946b690ef3b.zip |
Add README for FactoryReset interface
This commit adds a README explanation of the FactoryReset interface,
both in generic terms and a brief description of each of the current
implementations. This is intended to clarify what does and doesn't
occur when each factory reset implementation is called.
Resolves openbmc/openbmc#2229
Change-Id: Ic5072346dbe9bb87af05192de19ed17be2bb1482
Signed-off-by: Michael Tritz <mtritz@us.ibm.com>
-rw-r--r-- | xyz/openbmc_project/Common/FactoryReset/README.md | 23 |
1 files changed, 23 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..c488756 --- /dev/null +++ b/xyz/openbmc_project/Common/FactoryReset/README.md @@ -0,0 +1,23 @@ +# 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. + +## Known Implementations (listed by D-Bus service) + +### xyz.openbmc_project.Network +Path: `/xyz/openbmc_project/network` +The network factory reset overwrites the configuration for all configured +network interfaces to a DHCP setting. Configuration changes will take effect +the next time each interface is brought up - either manually or during a BMC +reboot. + +### xyz.openbmc_project.Software.BMC.Updater +Path: `/xyz/openbmc_project/software` +The BMC software updater factory reset clears any volumes and persistence files +created by the BMC processes. This reset occurs only on the next BMC reboot. |