1# Example PDM configuration file.
2
3- name: example path group
4  description: >
5    'A path group is a named collection of DBus object
6    paths and associated metadata.  These collections
7    serve only to be referenced by other configuration
8    directives.
9
10    The metadata element has different uses depending
11    on the referencing directive.
12
13    Within a single configuration file path group names
14    must be unique.  The same name can appear in multiple
15    configuration files; however, the referencing directive
16    will only search for the group in the same configuration
17    file.'
18  class: group
19  group: path
20  members:
21    - meta: path
22      path: /xyz/openbmc_project/testing/inst1
23    - meta: path
24      path: /xyz/openbmc_project/testing/inst2
25    - meta: path
26      path: /xyz/openbmc_project/testing/inst3
27    - meta: path
28      path: /xyz/openbmc_project/testing/inst4
29
30- name: example property group
31  description: >
32    'Like path groups, a property group is a named collection
33    of DBus property names and associated metadata.
34
35    Properties in a group must all have the same DBus type signature
36    and must be explicitly declared.'
37  class: group
38  group: property
39  type: uint32
40  members:
41    - interface: xyz.openbmc_project.Sensor.Value
42      meta: property
43      property: ValueA
44    - interface: xyz.openbmc_project.Sensor.Value
45      meta: property
46      property: ValueB
47
48- name: example property watch
49  description: >
50    'A property watch instructs PDM to maintain a cache of the state
51    of the specified properties on the specified DBus objects.'
52  class: watch
53  watch: property
54  paths: example path group
55  properties: example property group
56
57- name: example journal callback
58  description: >
59    'Callbacks are actions PDM should take when instructed to do so.
60
61    Some callback types refer to a group of paths and group of properties
62    in a similar fashion as the property watch directive.
63
64    The journal callback logs the specified message to the systemd journal
65    with the specified severity.
66
67    Additionally, the journal callback will add to the journal key value
68    pair metadata for each property in the specified property group with
69    the key being the property element metadata and the value being the
70    property value.'
71  class: callback
72  callback: journal
73  paths: example path group
74  properties: example property group
75  severity: INFO
76  message: Hello world from PDM!
77