xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Common/FactoryReset/README.md (revision 991b2b8bdbc950f2a85aebfc29d1b34ea3264686)
1# Factory Reset
2
3## Overview
4
5The OpenBMC API defines a factory reset interface, which is intended to be used
6to restore the BMC to its original manufacturer settings. This interface is
7defined generically; it is specifically and variously implemented throughout
8OpenBMC services, which allows these services to be individually restored to
9factory defaults as needed.
10
11## Known Implementations (listed by D-Bus service)
12
13### xyz.openbmc_project.Network
14
15Path: `/xyz/openbmc_project/network`
16The network factory reset overwrites the configuration for all configured
17network interfaces to a DHCP setting. Configuration changes will take effect
18the next time each interface is brought up - either manually or during a BMC
19reboot.
20
21### xyz.openbmc_project.Software.BMC.Updater
22
23Path: `/xyz/openbmc_project/software`
24The BMC software updater factory reset clears any volumes and persistence files
25created by the BMC processes. This reset occurs only on the next BMC reboot.
26