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 53 An optional callback can be triggered when property values change.' 54 class: watch 55 watch: property 56 paths: example path group 57 properties: example property group 58 callback: example count condition 59 60- name: example journal callback 61 description: > 62 'Callbacks are actions PDM should take when instructed to do so. 63 64 Some callback types refer to a group of paths and group of properties 65 in a similar fashion as the property watch directive. 66 67 The journal callback logs the specified message to the systemd journal 68 with the specified severity. 69 70 Additionally, the journal callback will add to the journal key value 71 pair metadata for each property in the specified property group with 72 the key being the property element metadata and the value being the 73 property value.' 74 class: callback 75 callback: journal 76 paths: example path group 77 properties: example property group 78 severity: INFO 79 message: Hello world from PDM! 80 81- name: example callback group 82 description: > 83 'Callbacks groups are simply named collections of other callbacks. 84 Configuration file directives can only refer to a single callback. 85 Through use of a group, these configuration file directives can 86 refer to more than one callback. 87 88 For example for a given event, one may wish to trace multiple 89 messages to the systemd journal. The journal callback does not 90 support tracing multiple messages. To do that, define a callback 91 group composed of multiple journal callbacks. 92 93 This example callback group only has one member. To add more, add 94 additional callbacks to the members element.' 95 class: callback 96 callback: group 97 members: 98 - example journal callback 99 100- name: example count condition 101 description: > 102 'Conditions or conditional callbacks apply a test prior to invoking 103 the callback function. 104 105 All conditional callbacks must specify the callback to issue if 106 the condition evaulates. 107 108 The count condition applies the op comparison operator to the value of each 109 property in the specified groups. It then counts the number of properties 110 that pass the comparison, and applies another comparison on the result 111 against the specified bound. 112 113 For example, a callback that requires at least three temperature sensors 114 in the group to be higher than 115 degrees might use a count condition 115 with an op of >, a count op of >=, a bound of 115, and a countbound of 3.' 116 117 class: condition 118 condition: count 119 paths: example path group 120 properties: example property group 121 callback: example callback group 122 countop: '>=' 123 countbound: 3 124 op: '>=' 125 bound: 115 126