blob: 747c3493acf51999a06ebbf360082a5fe8cd9725 [file] [log] [blame]
Wludzik, Jozefb2bbac72021-01-21 12:52:01 +01001description: >
2 Implement this interface to provide trigger inspection features. An
Szymon Dompke7e624b62021-09-20 18:45:12 +02003 implementation service should additionally implement
Wludzik, Jozefb2bbac72021-01-21 12:52:01 +01004 xyz.openbmc_project.Object.Delete for deletion of individual trigger.
5
6properties:
Patrick Williams8da396c2022-03-14 14:21:02 -05007 - name: Discrete
8 type: boolean
9 description: >
10 If true than trigger uses discrete thresholds as threshold conditions.
11 Otherwise numeric thresholds is used.
12 flags:
13 - const
14 - name: TriggerActions
15 type: array[enum[self.TriggerAction]]
16 description: >
17 Defines actions which are taken when threshold conditions are met.
18 flags:
19 - const
20 - name: Persistent
21 type: boolean
22 description: Defines if Trigger is stored in non volatile memory.
Michal Orzel4f9c0912022-08-01 10:20:46 +020023 - name: Reports
24 type: array[object_path]
Patrick Williams8da396c2022-03-14 14:21:02 -050025 description: >
Michal Orzel4f9c0912022-08-01 10:20:46 +020026 Collection of Report objects that are updated when threshold
27 conditions are met. List is ignored if TriggerActions property does
28 not contain 'UpdateReport' action.
Patrick Williams8da396c2022-03-14 14:21:02 -050029 - name: Sensors
Michal Orzel4f9c0912022-08-01 10:20:46 +020030 type: array[dict[object_path,string]]
Patrick Williams8da396c2022-03-14 14:21:02 -050031 description: >
Michal Orzel4f9c0912022-08-01 10:20:46 +020032 Map of sensors that is monitored within trigger. D-Bus sensor path is
33 used as map's key. Its value is a metadata that is used
34 to store user data about sensor. In Redfish, metadata will be set to
35 endpoint corresponding to that sensor.
Patrick Williams8da396c2022-03-14 14:21:02 -050036 - name: Thresholds
37 type: variant[array[struct[enum[self.Type],uint64,enum[self.Direction],double]],array[struct[string,enum[self.Severity],uint64,string]]]
38 description: >
39 First type in variant is a collection of numeric thresholds that has
40 following fields - type, dwell time, direction and threshold value.
Michal Orzel4f9c0912022-08-01 10:20:46 +020041 Second type holded by variant is a collection of discrete thresholds
42 that contains following fields - user id, severity, dwell time and
43 threshold value. Discrete value does not need to be a number. Numeric
44 threshold array is limited by Type enumeration, only 4 elements are
45 allowed. Discrete threshold array size is not limited. If discrete
46 threshold array is empty then every value change is taken into account
47 of threshold condition. Dwell time specifies for how long condition
48 has to persist to trigger an action.
49 - name: Name
50 type: string
51 description: >
52 Defines the name of trigger to be exposed over D-Bus.
Wludzik, Jozefb2bbac72021-01-21 12:52:01 +010053
54enumerations:
Patrick Williams8da396c2022-03-14 14:21:02 -050055 - name: TriggerAction
56 description: >
57 Defines a action which is taken once threshold condition is met.
58 values:
Michal Orzel4f9c0912022-08-01 10:20:46 +020059 - name: LogToJournal
Patrick Williams8da396c2022-03-14 14:21:02 -050060 description: Trigger will log to journal.
Michal Orzel4f9c0912022-08-01 10:20:46 +020061 - name: LogToRedfishEventLog
Patrick Williams8da396c2022-03-14 14:21:02 -050062 description: Trigger will log Redfish message.
63 - name: UpdateReport
64 description: >
65 Trigger will update reports. Reports that will be updated are
66 specified in ReportNames property.
67 - name: Type
68 description: >
69 Defines a context of a message that is logged when numeric threshold
70 condition is met.
71 values:
72 - name: LowerCritical
73 - name: LowerWarning
74 - name: UpperWarning
75 - name: UpperCritical
76 - name: Direction
77 description: >
Michal Orzel4f9c0912022-08-01 10:20:46 +020078 Defines in which direction threshold value is crossed to fulfill
79 numeric threshold condition.
Patrick Williams8da396c2022-03-14 14:21:02 -050080 values:
81 - name: Either
82 description: >
83 Crossing threshold value fulfill numeric threshold condition.
84 - name: Decreasing
85 description: >
Michal Orzel4f9c0912022-08-01 10:20:46 +020086 If threshold value is crossed and previous sensor value was
87 greater then threshold value then numeric threshold condition is
88 met.
Patrick Williams8da396c2022-03-14 14:21:02 -050089 - name: Increasing
90 description: >
91 If threshold value is crossed and previous sensor value was less
92 then threshold value then numeric threshold condition is met.
93 - name: Severity
94 description: >
95 Defines a context of a message that is logged when discrete threshold
96 condition is met.
97 values:
98 - name: OK
99 - name: Warning
100 - name: Critical