1description: >
2    Implement to provide triggers management.
3
4methods:
5    - name: AddTrigger
6      description: Create new object that represent Trigger with
7          xyz.openbmc_project.Telemetry.Trigger interface stored in path
8          /xyz/openbmc_project/Telemetry/Triggers/{Domain}/{Name} where
9          Domain and Name are parameters of this method.
10      parameters:
11          - name: name
12            type: string
13            description: >
14                Defines the name of report to be exposed over D-Bus. Service allows
15                to use separator '/' in name to group reports in directory.
16          - name: triggerActions
17            type: array[enum[xyz.openbmc_project.Telemetry.Trigger.TriggerAction]]
18            description: >
19                Defines which actions are taken when threshold conditions are met.
20          - name: sensors
21            type: array[struct[object_path,string]]
22            description: >
23                Array of sensors that is monitored within trigger. Object path
24                points to a sensor in DBus envrionment. String is used as user
25                metadata.
26          - name: reportNames
27            type: array[string]
28            description: >
29                Collection of report names that are updated when threshold
30                conditions are met. This parameter is ignored if triggerActions
31                parameter does not contain 'UpdateReport' action.
32          - name: thresholds
33            type: variant[array[struct[enum[xyz.openbmc_project.Telemetry.Trigger.Type],uint64,enum[xyz.openbmc_project.Telemetry.Trigger.Direction],double]],array[struct[string,enum[xyz.openbmc_project.Telemetry.Trigger.Severity],uint64,string]]]
34            description: >
35                Contains array of numeric or discrete thresholds that are described
36                in xyz.openbmc_project.Telemetry.Trigger interface.
37      returns:
38          - name: triggerPath
39            type: object_path
40            description: >
41                Path to new trigger ->
42                /xyz/openbmc_project/Telemetry/Triggers/{name}.
43