blob: d74db109312fc34d8fc23290133993a21afe7f45 [file] [log] [blame]
Brad Bishopa948d262016-10-05 19:51:48 -04001description: >
2 Implement to provide basic item attributes. Required by all objects
3 within the inventory namespace.
Ed Tanousfd26ad12022-07-12 15:20:26 -07004
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 -04009properties:
10 - name: PrettyName
Deepak Kodihalli1542bae2016-11-09 05:23:39 -060011 type: string
Brad Bishopa948d262016-10-05 19:51:48 -040012 description: >
13 The human readable name of the item.
14 - name: Present
Deepak Kodihalli1542bae2016-11-09 05:23:39 -060015 type: boolean
Brad Bishopa948d262016-10-05 19:51:48 -040016 description: >
17 Whether or not the item is present.
Shounak Mitrad4fad162022-08-08 21:53:41 +000018
19associations:
Benjamin Fair36b527a2022-11-02 20:41:21 +000020 - name: containing
21 description: >
22 Any inventory Items (usually Boards or Chassis) can optionally
23 implement the 'containing' association to provide one or more links
24 to Items which it physically contains.
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
Shounak Mitrad4fad162022-08-08 21:53:41 +000036 - name: sensors
37 description: >
38 Sensors may implement an 'inventory' to 'sensors' association with
39 the inventory item related to it.
40 reverse_names:
41 - inventory
42 required_endpoint_interfaces:
Benjamin Fair36b527a2022-11-02 20:41:21 +000043 - xyz.openbmc_project.Sensor.Value
George Liud0aa13b2022-10-31 14:17:32 +080044 - name: cooled_by
45 description: >
46 Objects that implement Item can optionally implement the
47 'cooled_by' association to provide a link to one or more fans.
48 reverse_name: cooling
49 required_endpoint_interfaces:
50 - xyz.openbmc_project.Inventory.Item.Fan