xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Inventory/Item.interface.yaml (revision 9d01e5ea679050cec1e38d5349ff5e63e39b35eb)
1b1b4d261SWilliam A. Kennington IIIdescription: >
2a1347418SPatrick Williams    Implement to provide basic item attributes.  Required by all objects within
3a1347418SPatrick Williams    the inventory namespace.
4fd26ad1eSEd Tanous
5fd26ad1eSEd Tanous    Any service implementing Inventory.Item on one or more objects must
6fd26ad1eSEd Tanous    implement org.freedesktop.DBus.ObjectManager on
7fd26ad1eSEd Tanous    /xyz/openbmc_project/inventory.
8fd26ad1eSEd Tanous
9b1b4d261SWilliam A. Kennington IIIproperties:
10b1b4d261SWilliam A. Kennington III    - name: PrettyName
11b1b4d261SWilliam A. Kennington III      type: string
12b1b4d261SWilliam A. Kennington III      description: >
13b1b4d261SWilliam A. Kennington III          The human readable name of the item.
14b1b4d261SWilliam A. Kennington III    - name: Present
15b1b4d261SWilliam A. Kennington III      type: boolean
16b1b4d261SWilliam A. Kennington III      description: >
17b1b4d261SWilliam A. Kennington III          Whether or not the item is present.
18d4fad16eSShounak Mitra
19d4fad16eSShounak Mitraassociations:
2036b527afSBenjamin Fair    - name: containing
2136b527afSBenjamin Fair      description: >
2236b527afSBenjamin Fair          Any inventory Items (usually Boards or Chassis) can optionally
23a1347418SPatrick Williams          implement the 'containing' association to provide one or more links to
24a1347418SPatrick Williams          Items which it physically contains.
2536b527afSBenjamin Fair      reverse_name: contained_by
2636b527afSBenjamin Fair      required_endpoint_interfaces:
2736b527afSBenjamin Fair          - xyz.openbmc_project.Inventory.Item
2836b527afSBenjamin Fair    - name: contained_by
2936b527afSBenjamin Fair      description: >
3036b527afSBenjamin Fair          Any inventory Items can optionally implement the 'contained_by'
3136b527afSBenjamin Fair          association to provide a link to exactly one Item (usually a Board or
3236b527afSBenjamin Fair          Chassis) which physically contains it.
3336b527afSBenjamin Fair      reverse_name: containing
3436b527afSBenjamin Fair      required_endpoint_interfaces:
3536b527afSBenjamin Fair          - xyz.openbmc_project.Inventory.Item
36d0aa13b4SGeorge Liu    - name: cooled_by
37d0aa13b4SGeorge Liu      description: >
38a1347418SPatrick Williams          Objects that implement Item can optionally implement the 'cooled_by'
39a1347418SPatrick Williams          association to provide a link to one or more fans.
40d0aa13b4SGeorge Liu      reverse_name: cooling
41d0aa13b4SGeorge Liu      required_endpoint_interfaces:
42d0aa13b4SGeorge Liu          - xyz.openbmc_project.Inventory.Item.Fan
43e7c10bd5SGeorge Liu    - name: fault_identified_by
44e7c10bd5SGeorge Liu      description: >
45e7c10bd5SGeorge Liu          Objects that implement Item can optionally implement the
46a1347418SPatrick Williams          'fault_identified_by' association to provide a link to one or more LED
47a1347418SPatrick Williams          Groups.
48e7c10bd5SGeorge Liu      reverse_name: fault_identifying
49e7c10bd5SGeorge Liu      required_endpoint_interfaces:
50e7c10bd5SGeorge Liu          - xyz.openbmc_project.Led.Group
51b3b70d92SGeorge Liu    - name: identified_by
52380bb024SGeorge Liu      description: >
53b3b70d92SGeorge Liu          Objects that implement Item can optionally implement the
54b3b70d92SGeorge Liu          'identified_by' association to provide a link to one or more LED
55b3b70d92SGeorge Liu          Groups.
56b3b70d92SGeorge Liu      reverse_name: identifying
57380bb024SGeorge Liu      required_endpoint_interfaces:
58b3b70d92SGeorge Liu          - xyz.openbmc_project.Led.Group
59a60ff845SJagpal Singh Gill    - name: measured_by
60a60ff845SJagpal Singh Gill      description: >
61a60ff845SJagpal Singh Gill          Objects that implement Item can optionally implement the 'measured_by'
62a60ff845SJagpal Singh Gill          association to provide a link to one or more metrics.
63a60ff845SJagpal Singh Gill      reverse_name: measuring
64a60ff845SJagpal Singh Gill      required_endpoint_interfaces:
65a60ff845SJagpal Singh Gill          - xyz.openbmc_project.Metrics
666cfd0d08SChau Ly    - name: monitored_by
676cfd0d08SChau Ly      description: >
686cfd0d08SChau Ly          Any inventory Item (usually Boards or Chassis) can optionally
696cfd0d08SChau Ly          implement the 'monitored_by' association to provide a link to the
706cfd0d08SChau Ly          chassis intrusion sensor that is monitoring its security state against
71*9d01e5eaSJagpal Singh Gill          intrusion events. Objects that implement Item can optionally implement
72*9d01e5eaSJagpal Singh Gill          the 'monitored_by' association to provide links to one or more
73*9d01e5eaSJagpal Singh Gill          detectors that monitors its state.
746cfd0d08SChau Ly      reverse_name: monitoring
756cfd0d08SChau Ly      required_endpoint_interfaces:
766cfd0d08SChau Ly          - xyz.openbmc_project.Chassis.Intrusion
77*9d01e5eaSJagpal Singh Gill          - xyz.openbmc_project.State.Leak.Detector
78b3b70d92SGeorge Liu    - name: powered_by
79b3b70d92SGeorge Liu      description: >
80b3b70d92SGeorge Liu          Objects that implement Item can optionally implement the 'powered_by'
81b3b70d92SGeorge Liu          association to provide a link to one or more power supplies.
82b3b70d92SGeorge Liu      reverse_name: powering
83b3b70d92SGeorge Liu      required_endpoint_interfaces:
84b3b70d92SGeorge Liu          - xyz.openbmc_project.Inventory.Item.PowerSupply
851abc0c57SGeorge Liu    - name: throttled_by
861abc0c57SGeorge Liu      description: >
871abc0c57SGeorge Liu          Objects that implement Chassis can optionally implement the
881abc0c57SGeorge Liu          'throttled_by' association to provide a link to throttle.
891abc0c57SGeorge Liu      reverse_name: throttling
901abc0c57SGeorge Liu      required_endpoint_interfaces:
911abc0c57SGeorge Liu          - xyz.openbmc_project.Control.Power.Throttle
92b3b70d92SGeorge Liu    - name: sensors
93b3b70d92SGeorge Liu      description: >
94b3b70d92SGeorge Liu          Sensors may implement an 'inventory' to 'sensors' association with the
95b3b70d92SGeorge Liu          inventory item related to it.
96b3b70d92SGeorge Liu      reverse_names:
97b3b70d92SGeorge Liu          - inventory
98b3b70d92SGeorge Liu      required_endpoint_interfaces:
99b3b70d92SGeorge Liu          - xyz.openbmc_project.Sensor.Value
100387a6191SZhichuang Sun    - name: authenticated_by
101387a6191SZhichuang Sun      description: >
102387a6191SZhichuang Sun          Objects that implement Item can optionally implement the
103387a6191SZhichuang Sun          "authenticated_by" association to provide a link to the component
104387a6191SZhichuang Sun          integrity object that authenticates this item.
105387a6191SZhichuang Sun      reverse_name: authenticating
106387a6191SZhichuang Sun      required_endpoint_interfaces:
107387a6191SZhichuang Sun          - xyz.openbmc_project.Attestation.ComponentIntegrity
108534515b7SZhichuang Sun    - name: protected_by
109534515b7SZhichuang Sun      description: >
110534515b7SZhichuang Sun          Objects that implement Item can optionally implement the
111534515b7SZhichuang Sun          "protected_by" association to provide a link to the target trusted
112534515b7SZhichuang Sun          component object that protects this item.
113534515b7SZhichuang Sun      reverse_name: protecting
114534515b7SZhichuang Sun      required_endpoint_interfaces:
115534515b7SZhichuang Sun          - xyz.openbmc_project.Inventory.Item.TrustedComponent
116cdda6382SShantappa Teekappanavar    - name: connected_to
117cdda6382SShantappa Teekappanavar      description: >
118cdda6382SShantappa Teekappanavar          Objects that implement Item can optionally implement the
119cdda6382SShantappa Teekappanavar          'connected_to' association to provide a link to cables.
120cdda6382SShantappa Teekappanavar      reverse_name: connecting
121cdda6382SShantappa Teekappanavar      required_endpoint_interfaces:
122cdda6382SShantappa Teekappanavar          - xyz.openbmc_project.Inventory.Item.Cable
1232c872b3cSPatrick Williams
1242c872b3cSPatrick Williamspaths:
1252c872b3cSPatrick Williams    - namespace: /xyz/openbmc_project/inventory
126