Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-dbus-interfaces / 387a6191f225335caa052522b4774cdb70853189 / . / yaml / xyz / openbmc_project / Inventory / Item.interface.yaml
blob: 4319b02e04f625c9b9613fba0929442508b00419 [file] [log] [blame]
Brad Bishopa948d262016-10-05 19:51:48 -0400[diff] [blame]1description: >
Patrick Williamsa1347412022-12-06 10:56:22 -0600[diff] [blame]2 Implement to provide basic item attributes. Required by all objects within
3 the inventory namespace.
Ed Tanousfd26ad12022-07-12 15:20:26 -0700[diff] [blame]4
5 Any service implementing Inventory.Item on one or more objects must
6 implement org.freedesktop.DBus.ObjectManager on
7 /xyz/openbmc_project/inventory.
8
Brad Bishopa948d262016-10-05 19:51:48 -0400[diff] [blame]9properties:
10 - name: PrettyName
Deepak Kodihalli1542bae2016-11-09 05:23:39 -0600[diff] [blame]11 type: string
Brad Bishopa948d262016-10-05 19:51:48 -0400[diff] [blame]12 description: >
13 The human readable name of the item.
14 - name: Present
Deepak Kodihalli1542bae2016-11-09 05:23:39 -0600[diff] [blame]15 type: boolean
Brad Bishopa948d262016-10-05 19:51:48 -0400[diff] [blame]16 description: >
17 Whether or not the item is present.
Shounak Mitrad4fad162022-08-08 21:53:41 +0000[diff] [blame]18
19associations:
Benjamin Fair36b527a2022-11-02 20:41:21 +0000[diff] [blame]20 - name: containing
21 description: >
22 Any inventory Items (usually Boards or Chassis) can optionally
Patrick Williamsa1347412022-12-06 10:56:22 -0600[diff] [blame]23 implement the 'containing' association to provide one or more links to
24 Items which it physically contains.
Benjamin Fair36b527a2022-11-02 20:41:21 +0000[diff] [blame]25 reverse_name: contained_by
26 required_endpoint_interfaces:
27 - xyz.openbmc_project.Inventory.Item
28 - name: contained_by
29 description: >
30 Any inventory Items can optionally implement the 'contained_by'
31 association to provide a link to exactly one Item (usually a Board or
32 Chassis) which physically contains it.
33 reverse_name: containing
34 required_endpoint_interfaces:
35 - xyz.openbmc_project.Inventory.Item
George Liud0aa13b2022-10-31 14:17:32 +0800[diff] [blame]36 - name: cooled_by
37 description: >
Patrick Williamsa1347412022-12-06 10:56:22 -0600[diff] [blame]38 Objects that implement Item can optionally implement the 'cooled_by'
39 association to provide a link to one or more fans.
George Liud0aa13b2022-10-31 14:17:32 +0800[diff] [blame]40 reverse_name: cooling
41 required_endpoint_interfaces:
42 - xyz.openbmc_project.Inventory.Item.Fan
George Liue7c10bd2022-11-03 21:12:53 +0800[diff] [blame]43 - name: fault_identified_by
44 description: >
45 Objects that implement Item can optionally implement the
Patrick Williamsa1347412022-12-06 10:56:22 -0600[diff] [blame]46 'fault_identified_by' association to provide a link to one or more LED
47 Groups.
George Liue7c10bd2022-11-03 21:12:53 +0800[diff] [blame]48 reverse_name: fault_identifying
49 required_endpoint_interfaces:
50 - xyz.openbmc_project.Led.Group
George Liub3b70d92024-01-25 08:42:50 +0800[diff] [blame]51 - name: identified_by
George Liu380bb022022-11-10 08:31:25 +0800[diff] [blame]52 description: >
George Liub3b70d92024-01-25 08:42:50 +0800[diff] [blame]53 Objects that implement Item can optionally implement the
54 'identified_by' association to provide a link to one or more LED
55 Groups.
56 reverse_name: identifying
George Liu380bb022022-11-10 08:31:25 +0800[diff] [blame]57 required_endpoint_interfaces:
George Liub3b70d92024-01-25 08:42:50 +0800[diff] [blame]58 - xyz.openbmc_project.Led.Group
Jagpal Singh Gilla60ff842023-07-12 15:13:25 -0700[diff] [blame]59 - name: measured_by
60 description: >
61 Objects that implement Item can optionally implement the 'measured_by'
62 association to provide a link to one or more metrics.
63 reverse_name: measuring
64 required_endpoint_interfaces:
65 - xyz.openbmc_project.Metrics
Chau Ly6cfd0d02023-11-30 03:41:37 +0000[diff] [blame]66 - name: monitored_by
67 description: >
68 Any inventory Item (usually Boards or Chassis) can optionally
69 implement the 'monitored_by' association to provide a link to the
70 chassis intrusion sensor that is monitoring its security state against
71 intrusion events.
72 reverse_name: monitoring
73 required_endpoint_interfaces:
74 - xyz.openbmc_project.Chassis.Intrusion
George Liub3b70d92024-01-25 08:42:50 +0800[diff] [blame]75 - name: powered_by
76 description: >
77 Objects that implement Item can optionally implement the 'powered_by'
78 association to provide a link to one or more power supplies.
79 reverse_name: powering
80 required_endpoint_interfaces:
81 - xyz.openbmc_project.Inventory.Item.PowerSupply
George Liu1abc0c52024-01-24 17:24:00 +0800[diff] [blame]82 - name: throttled_by
83 description: >
84 Objects that implement Chassis can optionally implement the
85 'throttled_by' association to provide a link to throttle.
86 reverse_name: throttling
87 required_endpoint_interfaces:
88 - xyz.openbmc_project.Control.Power.Throttle
George Liub3b70d92024-01-25 08:42:50 +0800[diff] [blame]89 - name: sensors
90 description: >
91 Sensors may implement an 'inventory' to 'sensors' association with the
92 inventory item related to it.
93 reverse_names:
94 - inventory
95 required_endpoint_interfaces:
96 - xyz.openbmc_project.Sensor.Value
Zhichuang Sun387a6192023-07-19 15:48:03 -0700[diff] [blame^]97 - name: authenticated_by
98 description: >
99 Objects that implement Item can optionally implement the
100 "authenticated_by" association to provide a link to the component
101 integrity object that authenticates this item.
102 reverse_name: authenticating
103 required_endpoint_interfaces:
104 - xyz.openbmc_project.Attestation.ComponentIntegrity
Patrick Williams2c872b32024-01-22 09:51:52 -0600[diff] [blame]105
106paths:
107 - namespace: /xyz/openbmc_project/inventory