docs/designs/guard-on-bmc.md

6 the system downtime can be prevented by isolating the faulty components. This
8 The defective components can be kept isolated until a replacement. Most of the
9 actions required to isolate the parts will be dependant on the architecture and
31 them out of service. The list of faulty but guarded components can be stored in
33 record or manage the record will be decided by the respective component. Some of
35 the fans can be managed by the fan control application, or the guard on the
36 power components can be managed by the power management application.
38 These records will be created when an error is encountered on an element that
39 can be isolated. The decision to create a record is based on the type of error,
42 is named as Guard Record. The guard record will be deleted after a repair action
48 be controlled by BMC. The BMC retrieves the guard records for presenting to an
60 - An option should be given to user to create guard record for DIMM and
62 - An option should be given to the user to delete a guard record.
63 - An option should be given to list the guard records.
64 - An option should be given to delete all guard records
65 - Industry standard interfaces should be provided to carry out these operations
70 - The guard records on the units which are owned by the host will be applied
75   should be done by the component owning the guard records.
76 - There should be a mapping between key in the guard record to the key used in
87 On BMC, There will be a guard manager object and objects for each entry.
96   Inventory path of the DIMM or Processor core to be guarded.
105 **Note:** In few platforms may be the system or hardware is not in a state where
106 guard operation can be performed either "permanently" or "temporarily".
110 The properties of each guard entry will be part of this object Properties:
115     - Forward Name must be "isolated_hw".
116     - Reverse Name must be "isolated_hw_entry".
118     - Forward Name must be "isolated_hw_errorlog".
119     - Reverse Name must be "isolated_hw_entry".
121       Error Log association can be optional because a user may be tried guard
128     there can be critical failures.
133     system platforms guarded hardware records may not be deleted and used for
214 The guard records can be created for any components which are redundant and
217 Some of the units like which are controlled by the host can be isolated only
218 after a reboot, but the units controlled by BMC can be immediately taken out of
222   control, and the host needs to provide the user interface, so there may not be
225 - BMC manages the external interfaces for guard: There will be one common point
228   host; as a system control entity, it will be easier for BMC to handle such
233 - The guard records will be presented as an extension to logs
242 and that should be automated, further tests on the isolation of each type of the