| Jagpal Singh Gill | a60ff84 | 2023-07-12 15:13:25 -0700 | [diff] [blame^] | 1 | description: > |
| 2 | This interface provides the Board Manager Metric values for resource |
| 3 | utilization. |
| 4 | |
| 5 | properties: |
| 6 | - name: Value |
| 7 | type: double |
| 8 | description: > |
| 9 | The current metric value. |
| 10 | flags: |
| 11 | - readonly |
| 12 | - name: MaxValue |
| 13 | type: double |
| 14 | default: infinity |
| 15 | flags: |
| 16 | - readonly |
| 17 | description: > |
| 18 | The maximum supported metric value. |
| 19 | - name: MinValue |
| 20 | type: double |
| 21 | default: -infinity |
| 22 | flags: |
| 23 | - readonly |
| 24 | description: > |
| 25 | The minimum supported metric value. |
| 26 | - name: Unit |
| 27 | type: enum[self.Unit] |
| 28 | description: > |
| 29 | The unit for metric value. For example, memory in bytes, CPU in |
| 30 | percent, reboots in count. |
| 31 | flags: |
| 32 | - const |
| 33 | |
| 34 | enumerations: |
| 35 | - name: Unit |
| 36 | description: > |
| 37 | Metric value unit. |
| 38 | values: |
| 39 | - name: Bytes |
| 40 | description: > |
| 41 | Unit to indicate bytes. |
| 42 | - name: Count |
| 43 | description: > |
| 44 | Unit to indicate counts. |
| 45 | - name: Percent |
| 46 | description: > |
| 47 | Unit to indicate percentage. |
| 48 | |
| 49 | associations: |
| 50 | - name: measuring |
| 51 | description: > |
| 52 | Metrics measure the inventory item's resource utilization, therefore |
| 53 | implement an association to the inventory item. |
| 54 | reverse_names: |
| 55 | - measured_by |
| 56 | required_endpoint_interfaces: |
| 57 | - xyz.openbmc_project.Inventory.Item |