docs/designs/guard-on-bmc.md

5 On systems with multiple processor units and other redundant vital resources,
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
61   Processor core to manually keep it out of service.
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
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: -
96   Inventory path of the DIMM or Processor core to be guarded.
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:
114   - Guarded hardware inventory path:
115     - Forward Name must be "isolated_hw".
116     - Reverse Name must be "isolated_hw_entry".
117   - BMC Error Log:
118     - Forward Name must be "isolated_hw_errorlog".
119     - Reverse Name must be "isolated_hw_entry".
124 - Severity: Type of Guard
125   - Manual - Manually Guarded
126   - Critical - Guarded based on a critical error
127   - Warning - Guarded based on an error which is not critical, but eventually,
129 - Resolved: Status of guarded hardware
130   - Used to indicate whether guarded hardware is repaired or replaced.
152   "@odata.type": "#Processor.v1_7_0.Processor",
154   "Name": "Processor",
169         "Enabled": "False" <--- guarded a CPU1
191       "Created": "2020-10-15T10:30:08+00:00",
195       "Name": "Processor 1",
202       "SensorType" : "Processor",
221 - The host creates, applies, and present guard records: In this case, BMC has no
225 - BMC manages the external interfaces for guard: There will be one common point
233 - The guard records will be presented as an extension to logs
234 - Redfish implementation will have an impact to do the operations required for
243 unit is implementation-specific.