docs/designs/guard-on-bmc.md

5 On systems with multiple processor units and other redundant vital resources,
19 units.
25 units. This operation is helpful in isolating a suspected component without
46 limited set of units during the early boot time, after a severe fault, which
56 ![Guard Usecases](https://user-images.githubusercontent.com/16666879/70852658-0edfda80-1eca-11ea-9d…
58 - When user requests, create a record in the right guard record repository,
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
72 - The sub-system which owns the hardware resource will apply the guard record
73   and isolates the units.
74 - The clearing of the records after the replacement of the faulty component
76 - There should be a mapping between key in the guard record to the key used in
85 ### D-Bus Interfaces
95 - Create Guard: Create guard record for a DIMM or Processor core Inputs: -
98 - Delete Guard: Delete an existing guard record Deleting the guard record D-Bus
101 - Clear all guard: Clear all guard records in the system.
103 - List Guard: List all the guarded components.
112 - ID: Id of the record which is part of the entry object path.
113 - Associations:
115   - Guarded hardware inventory path:
116     - Forward Name must be "isolated_hw".
117     - Reverse Name must be "isolated_hw_entry".
118   - BMC Error Log:
120     - Forward Name must be "isolated_hw_errorlog".
121     - Reverse Name must be "isolated_hw_entry".
126 - Severity: Type of Guard
127   - Manual - Manually Guarded
128   - Critical - Guarded based on a critical error
129   - Warning - Guarded based on an error which is not critical, but eventually,
131 - Resolved: Status of guarded hardware
133   - Used to indicate whether guarded hardware is repaired or replaced.
140 hardware units. The application which implements the common guard entry
172         "Enabled": "False" <--- guarded a CPU1
194       "Created": "2020-10-15T10:30:08+00:00",
219 created, an isolation procedure is needed to isolate the units from service.
220 Some of the units like which are controlled by the host can be isolated only
221 after a reboot, but the units controlled by BMC can be immediately taken out of
224 - The host creates, applies, and present guard records: In this case, BMC has no
228 - BMC manages the external interfaces for guard: There will be one common point
236 - The guard records will be presented as an extension to logs
237 - Redfish implementation will have an impact to do the operations required for
239   planned for the method to list the isolated units in the redfish since that is
246 unit is implementation-specific.