Skip to main content

GET – Trigger Instance

Request​

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

It displays a trigger instance which can be either a numeric or a discrete one.

Response​

The response of the request will be in JSON format. The properties are mentioned in the following table.

Table 1. Trigger Instance Properties

Name

Type

Read only

Description

(OData Attributes)  

Refer to OData Support

Id(M)

String

True

Refer to Resource Type Definitions

Name(M)

String

True

Description

String

True

MetricType

String

True

  1. The value of this property shall specific the type of trigger and should be any one of the Enum values Numeric, Discrete.

  2. When value of MetricType is "Numeric", DiscreteTriggerCondition and DiscreteTriggers attributes are not allowed.

  3. When value of MetricType is "Discrete", NumericThresholds attribute is not allowed.

TriggerActions

Array

True

  1. This property denotes the actions to be performed when a trigger condition is met. Supported Values are "LogToLogService","RedfishEvent", "RedfishMetricReport".

  2. LogToLogService: This value indicates that when a trigger condition is met, the Service shall log the occurrence of the condition to the log that the LogService property in the TelemetryService Resource describes.

  3. RedfishEvent: This value indicates that when a trigger condition is met, the Service shall send an event to subscribers.

  4. RedfishMetricReport: This value indicates that when a trigger condition is met, the Service shall force the metric reports specified by the MetricReportDefinitions property to be updated, regardless of the MetricReportDefinitionType property value. The actions specified in the ReportActions property of each MetricReportDefinition shall be performed.

NumericThresholdsObjectTrue
This property shall contain list of triggers to which a sensor reading will be compared.

Name

Type

Read only

Description

LowerCritical

Object

True

  1. The value of this property shall indicate the Reading is below the normal range and may require attention.

  2. The units shall be the same units as the Reading.

  3. Refer to Numeric Thresholds Sub-Attributes under this property.

LowerWarning

Object

True

  1. The value of this property shall indicate the Reading is below the normal range.

  2. The units shall be the same units as the Reading.

  3. Refer to Numeric Thresholds Sub-Attributes under this property.

UpperCritical

Object

True

  1. The value of this property shall indicate the Reading is above the normal range and may require attention.

  2. The units shall be the same units as the Reading.

  3. Refer to Numeric Thresholds Sub-Attributes under this property.

UpperWarning

Object

True

  1. The value of this property shall indicate the Reading is above the normal range.

  2. The units shall be the same units as the Reading.

  3. Refer to Numeric Thresholds Sub-Attributes under this property.

LinksObjectTrue
The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.

Name

Type

Read only

Description

Oem

Object

 Refer to Resource Complex Types.

MetricReportDefinitions

Array

True

The value shall be a set of references to existing MetricReportDefinitions that will generate new metric reports when the TriggerActions property contains the value

RedfishMetricReport and a trigger condition is met.

MetricReportDefinitions@odata.count

Integer

True

An integer representing the number of items in a collection.

DiscreteTriggerCondition

String

True

  1. This property shall contain the conditions when a discrete metric needs to trigger. Supported Values are "Specified" and "Changed".

  2. Changed: A discrete trigger condition is met whenever the metric value changes.

  3. Specified: A discrete trigger condition is met when the metric value becomes one of the values that the DiscreteTriggers property lists.

  4. If the value for this attribute is "Changed", then the attribute "DiscreteTriggers" itself should not be present.

Status

Object

True

Refer to Resource Complex Types.

Metricproperties

Array

True

  1. A collection of URI for the properties on which this metric definition is defined.

  2. In the case of Numeric Triggers, MetricProperties only support the values defined under the Members of MetricDefinitions URI “/redfish/v1/TelemetryService/MetricDefinitions”.

  3. In the case of DiscreteTriggers, MetricProperties can support URI properties with value type "string".

DiscreteTriggersArrayTrue

  1. This property shall contain list of triggers to which a sensor reading will be compared. The list of triggers is limited to a maximum count of 10 (i.e. the DiscreteTriggers Array can have a maximum count of 10 values).

  2. If the value for "DiscreteTriggerCondition" attribute is "Specified", then the attribute "DiscreteTriggers" should be present. If the value for "DiscreteTriggerCondition" attribute is "Changed", then the attribute "DiscreteTriggers" should not be present.

Name

Type

Read only

Description

Name

String

True

Name of discrete trigger

Value

String

True

  1. This property shall contain the discrete metric value that constitutes a trigger event.

  2. The DwellTime shall be measured from this point in time.

  3. This attribute is mandatory for Specified Discrete Trigger creation.

Severity

ResourceHealth

True

  1. The value of this property is used for the Severity property in the Event message

  2. This attribute is mandatory for Specified Discrete Trigger creation.

DwellTime

Number

True

  1. This property shall contain the amount of time that a trigger event persists before the MetricAction is performed.

  2. Supported format for DwellTime is

"-?(P)(T(\\d+H)?(\\d+M)?(\\d+(.\\d+)?S)?)?"

  1. This attribute is mandatory for Specified Discrete Trigger creation. In the current implementation for DwellTime, Days(D) are not supported and Hours(H), Minutes(M) and Seconds(S) alone are supported.

Table 2. Numeric Thresholds Sub-Attributes

Name

Type

Read only

Description

Reading

String

False

  1. This property shall indicate the Reading value of this Sensor that triggers the threshold.

  2. The units of this property shall follow the same units as the property described by MetricProperties.

  3. This attribute is mandatory for Numeric Trigger creation.

DwellTime

String

False

  1. This property shall indicate the time interval over which the sensor reading must have passed through this Threshold value before the threshold is violated.

  2. This attribute is mandatory for Numeric Trigger creation.

  3. In the current implementation for DwellTime, Days(D) are not supported and Hours(H), Minutes(M) and Seconds(S) alone are supported.

Activation

String

False

  1. This property shall indicate the direction of crossing of the Reading value for this Sensor that triggers the threshold. Supported Values can be either of these: "Increasing", "Decreasing" or "Either" .

  2. Decreasing: This threshold is activated when the reading changes from a value higher than the threshold to a value lower than the threshold.

  3. Either: This threshold is activated when either the Increasing or Decreasing conditions are met.

  4. Increasing: This threshold is activated when the reading changes from a value lower than the threshold to a value higher than the threshold.

  5. This attribute is mandatory for Numeric Trigger creation.

Request​

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

Response​

{
    "@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"
    ]
}