Update Telemetry service interfaces
This change updates description of interfaces utilized by Telemetry
service, so that its contents mirror the desired implementation.
Change-Id: I7207c4889912e848a058279b9d89f643a7e0b6b8
Signed-off-by: Michal Orzel <michalx.orzel@intel.com>
diff --git a/yaml/xyz/openbmc_project/Telemetry/TriggerManager.interface.yaml b/yaml/xyz/openbmc_project/Telemetry/TriggerManager.interface.yaml
index e92d269..b6965fa 100644
--- a/yaml/xyz/openbmc_project/Telemetry/TriggerManager.interface.yaml
+++ b/yaml/xyz/openbmc_project/Telemetry/TriggerManager.interface.yaml
@@ -3,28 +3,37 @@
methods:
- name: AddTrigger
- description: Create new object that represent Trigger with
+ description: >
+ Create new object that represents Trigger with
xyz.openbmc_project.Telemetry.Trigger interface stored in path
- /xyz/openbmc_project/Telemetry/Triggers/{Domain}/{Name} where
- Domain and Name are parameters of this method.
+ /xyz/openbmc_project/Telemetry/Triggers/{id} where id is parameter of
+ this method.
parameters:
+ - name: id
+ type: string
+ description: >
+ Defines unique identifier of created Trigger object to be
+ exposed over D-Bus. Acceptable formats are: "{Id}",
+ "{Prefix}/{SubId}", "{Prefix}/". If the last variant is used,
+ service will generate unique SubId value by itself.
- name: name
type: string
description: >
- Defines the name of report to be exposed over D-Bus. Service allows
- to use separator '/' in name to group reports in directory.
+ Defines user friendly name of created Trigger object.
- name: triggerActions
type: array[enum[xyz.openbmc_project.Telemetry.Trigger.TriggerAction]]
description: >
- Defines which actions are taken when threshold conditions are met.
+ Defines which actions are taken when threshold conditions are
+ met.
- name: sensors
- type: array[struct[object_path,string]]
+ type: array[dict[object_path,string]]
description: >
- Array of sensors that is monitored within trigger. Object path
- points to a sensor in DBus envrionment. String is used as user
- metadata.
- - name: reportNames
- type: array[string]
+ Map of sensors that is monitored within trigger. D-Bus sensor
+ path is used as map's key. Its value is a metadata that is used
+ to store user data about sensor. In Redfish, metadata will be
+ set to endpoint corresponding to that sensor.
+ - name: reports
+ type: array[object_path]
description: >
Collection of report names that are updated when threshold
conditions are met. This parameter is ignored if triggerActions
@@ -32,11 +41,11 @@
- name: thresholds
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]]]
description: >
- Contains array of numeric or discrete thresholds that are described
- in xyz.openbmc_project.Telemetry.Trigger interface.
+ Contains array of numeric or discrete thresholds that are
+ described in xyz.openbmc_project.Telemetry.Trigger interface.
returns:
- name: triggerPath
type: object_path
description: >
Path to new trigger ->
- /xyz/openbmc_project/Telemetry/Triggers/{name}.
+ /xyz/openbmc_project/Telemetry/Triggers/{id}.