POST – Trigger

Rules​

1. The following properties are mandatory to create a Trigger :

   • Id

   • Name

   • MetricType

   • TriggerActions

   • NumericThresholds or (DiscreteTriggerCondition & DiscreteTriggers)

   • MetricProperties

2. If the value of the ServiceEnabled attribute available under the Telemetry Service Resource (i.e./redfish/v1/TelemetryService) is true, it signifies that the Telemetry Service is in Enabled state and the POST Request will succeed.

3. If it is false, it signifies that the Telemetry Service is in Disabled state and it will fail with an error message stating, the operation failed because this service is disabled can no longer take incoming requests.

4. Status->State and Status->Health are read-only attributes and cannot be passed in the POST Request Body.

5. Only a maximum of 5 triggers can be created.

6. For creation of Numeric Triggers, NumericThresholds attribute is mandatory. Four sub-attributes are supported under NumericThresholds attribute LowerCritical, LowerWarning, UpperCritical and UpperWarning. Not all four sub-attributes are mandatory for Numeric Triggers creation but at least one sub-attribute should be present. It is entirely left up to the Redfish User's choice to have one or more sub-attributes.

7. Under each of these four sub-attributes, we again have support for three sub attributes - Activation, DwellTime and Reading. These three attributes are mandatory for each of the four sub-attributes, if specified in the request body.

8. For creation of Discrete Triggers, if value of DiscreteTriggerCondition attribute is changed, then DiscreteTriggers attribute should not be present and if value of DiscreteTriggerCondition attribute is specified, then DiscreteTriggers attribute should be present.

9. DiscreteTriggers attribute should consist of an array of objects where each object can have the following four sub attributes - Name, Value, Severity and DwellTime. The sub-attributes Value, Severity and DwellTime are mandatory ones whereas Name is an optional one.

Request​

Create Numeric Triggers

POST https://{{ip}}/redfish/v1/TelemetryService/Triggers
Content-Type: application/json

{
    "Id": "TemperatureTrigger",
    "Name": "Temperature Trigger",
    "MetricType": "Numeric",
    "TriggerActions": [
       "LogToLogService",
       "RedfishEvent"
    ],
    "NumericThresholds": {
       "LowerCritical": {
          "Activation": "Either",
          "DwellTime": "PT1M",
          "Reading": 30
       },
       "LowerWarning": {
          "Activation": "Decreasing",
          "DwellTime": "PT1M30S",
          "Reading": 50
       },
       "UpperCritical": {
          "Activation": "Increasing",
          "DwellTime": "PT1M50S",
          "Reading": 80
       },
       "UpperWarning": {
          "Activation": "Increasing",
          "DwellTime": "PT30S",
          "Reading": 70
       }
    },
    "MetricProperties": [
       "/redfish/v1/Chassis/Self/Thermal#/Temperatures/116_0/ReadingCelsius",
       "/redfish/v1/Chassis/Self/Thermal#/Temperatures/117_0/ReadingCelsius"
    ]
}

Response​

Create Numeric Triggers

HTTP/1.1 201 Created
Location: http://<IP>/redfish/v1/TelemetryService/Triggers/TemperatureTrigger
Content-Type: application/json

{
    "@odata.context": "/redfish/v1/$metadata#TelemetryService.Triggers(Name,TriggerActions,
MetricProperties,Id,Status,Links,MetricType,NumericThresholds)",
    "@odata.etag": "\"1573457484\"",
    "@odata.id": "/redfish/v1/TelemetryService/Triggers/TemperatureTrigger",
    "@odata.type": "#Triggers.v1_1_1.Triggers",
    "Id": "TemperatureTrigger",
    "Links": [],
    "MetricProperties": [
       "/redfish/v1/Chassis/Self/Thermal#/Temperatures/116_0/ReadingCelsius",
       "/redfish/v1/Chassis/Self/Thermal#/Temperatures/117_0/ReadingCelsius"
    ],
    "MetricType": "Numeric",
    "Name": "Temperature Trigger",
    "NumericThresholds": {
       "LowerCritical": {
          "Activation": "Either",
          "DwellTime": "PT1M",
          "Reading": 30
       },
       "LowerWarning": {
          "Activation": "Decreasing",
          "DwellTime": "PT1M30S",
          "Reading": 50
       },
       "UpperCritical": {
          "Activation": "Increasing"
          "DwellTime": "PT1M50S",
          "Reading": 80
       },
       "UpperWarning": {
          "Activation": "Increasing",
          "DwellTime": "PT30S",
          "Reading": 70
       }
    },
    "Status": {
       "Health": "OK",
       "State": "Enabled"
    },
    "TriggerActions": [
       "RedfishEvent",
       "LogToLogService"
    ]
}

Request​

Create Discrete Triggers

POST https://{{ip}}/redfish/v1/TelemetryService/Triggers
Content-Type: application/json

{
    "ChassisIndicatorLED",
    "Name": "Chassis_IndicatorLED",
    "MetricType": "Discrete",
    "TriggerActions": [
       "LogToLogService",
       "RedfishEvent"
    ],
    "DiscreteTriggerCondition": "Specified",
    "DiscreteTriggers": [
       {
          "Name": "LED_Blinking",
          "Value": "Blinking",
          "Severity": "Critical",
          "DwellTime": "PT30S"
       }
    ],
    "MetricProperties": [
       "/redfish/v1/Chassis/Self#/IndicatorLED"
    ]
}

Response​

Create Discrete Triggers

HTTP/1.1 201 Created
Location: http://<IP>/redfish/v1/TelemetryService/Triggers/ChassisIndicatorLED
Content-Type: application/json

{
    "@odata.context": "/redfish/v1/$metadata#TelemetryService.Triggers(Id,Status,Links,Name,MetricProperties,
DiscreteTriggerCondition,DiscreteTriggers,TriggerActions,MetricType,Description)",
    "@odata.etag": "\"1583924493\"",
    "@odata.id": "/redfish/v1/TelemetryService/Triggers/ChassisIndicatorLED",
    "@odata.type": "#Triggers.v1_1_1.Triggers",
    "Description": "TelemetryService-Triggers-ChassisIndicatorLED",
    "DiscreteTriggerCondition": "Specified",
    "DiscreteTriggers": [
      {
        "DwellTime": "PT30S",
        "Name": "LED_Blinking",
        "Severity": "Critical",
        "Value": "Blinking"
      }
    "Id": "ChassisIndicatorLED",
    "Links": [],
    "MetricProperties": [
      "/redfish/v1/Chassis/Self#/IndicatorLED"
    ],
    "MetricType": "Discrete",
    "Name": "Chassis_IndicatorLED",
    "Status": {
      "Health": "OK",
      "State": "Enabled"
    },
    "TriggerActions": [
      "RedfishEvent",
      "LogToLogService"
    ]
}

The triggers created can be either numeric or discrete in nature. During each polling cycle of telemetry handler, the current value of each of the metric properties specified in trigger is compared with the specified trigger value.

Behavior​

Trigger conditions