components:
  schemas:
    Triggers_v1_3_1_Actions:
      additionalProperties: false
      description: The available actions for this resource.
      properties:
        Oem:
          $ref: '#/components/schemas/Triggers_v1_3_1_OemActions'
          description: The available OEM-specific actions for this resource.
          x-longDescription: This property shall contain the available OEM-specific
            actions for this resource.
      type: object
      x-longDescription: This type shall contain the available actions for this resource.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    Triggers_v1_3_1_DirectionOfCrossingEnum:
      description: The direction of crossing that corresponds to a trigger.
      enum:
      - Increasing
      - Decreasing
      type: string
      x-enumDescriptions:
        Decreasing: A trigger is met when the metric value crosses the trigger value
          while decreasing.
        Increasing: A trigger condition is met when the metric value crosses the trigger
          value while increasing.
      x-longDescription: The value shall indicate the direction of crossing that corresponds
        to a trigger.
    Triggers_v1_3_1_DiscreteTrigger:
      additionalProperties: false
      description: The characteristics of the discrete trigger.
      properties:
        DwellTime:
          description: The amount of time that a trigger event persists before the
            metric action is performed.
          nullable: true
          pattern: ^P(\d+D)?(T(\d+H)?(\d+M)?(\d+(.\d+)?S)?)?$
          readOnly: false
          type: string
          x-longDescription: This property shall contain the amount of time that a
            trigger event persists before the TriggerActions are performed.
        Name:
          description: The name of trigger.
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall contain a name for the trigger.
        Severity:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Health
          description: The severity of the event message.
          nullable: true
          readOnly: false
          x-longDescription: This property shall contain the Severity property to
            be used in the event message.
        Value:
          description: The discrete metric value that constitutes a trigger event.
          nullable: true
          readOnly: false
          type: string
          x-longDescription: This property shall contain the value discrete metric
            that constitutes a trigger event.  The DwellTime shall be measured from
            this point in time.
      type: object
      x-longDescription: This object shall contain the characteristics of the discrete
        trigger.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    Triggers_v1_3_1_DiscreteTriggerConditionEnum:
      description: The condition, in relationship to the discrete trigger values,
        which constitutes a trigger.
      enum:
      - Specified
      - Changed
      type: string
      x-enumDescriptions:
        Changed: A discrete trigger condition is met whenever the metric value changes.
        Specified: A discrete trigger condition is met when the metric value becomes
          one of the values that the DiscreteTriggers property lists.
      x-longDescription: This type shall specify the condition, in relationship to
        the discrete trigger values, which constitutes a trigger.
    Triggers_v1_3_1_Links:
      additionalProperties: false
      description: The links to other resources that are related to this resource.
      properties:
        MetricReportDefinitions:
          description: The metric report definitions that generate new metric reports
            when a trigger condition is met and when the TriggerActions property contains
            `RedfishMetricReport`.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          readOnly: false
          type: array
          x-longDescription: This property shall contain a set of links to metric
            report definitions that generate new metric reports when a trigger condition
            is met and when the TriggerActions property contains `RedfishMetricReport`.
          x-versionAdded: v1_1_0
        MetricReportDefinitions@odata.count:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_count
        Oem:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Oem
          description: The OEM extension property.
          x-longDescription: This property shall contain the OEM extensions.  All
            values for properties contained in this object shall conform to the Redfish
            Specification-described requirements.
      type: object
      x-longDescription: This Redfish Specification-described type shall contain links
        to resources that are related to but are not contained by, or subordinate
        to, this resource.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    Triggers_v1_3_1_MetricTypeEnum:
      description: The type of metric for which the trigger is configured.
      enum:
      - Numeric
      - Discrete
      type: string
      x-enumDescriptions:
        Discrete: The trigger is for a discrete sensor.
        Numeric: The trigger is for numeric sensor.
      x-longDescription: This type shall specify the type of metric for which the
        trigger is configured.
    Triggers_v1_3_1_OemActions:
      additionalProperties: true
      description: The available OEM-specific actions for this resource.
      properties: {}
      type: object
      x-longDescription: This type shall contain the available OEM-specific actions
        for this resource.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    Triggers_v1_3_1_Threshold:
      additionalProperties: false
      description: A threshold definition for a sensor.
      properties:
        Activation:
          $ref: '#/components/schemas/Triggers_v1_3_1_ThresholdActivation'
          description: The direction of crossing that activates this threshold.
          nullable: true
          readOnly: false
          x-longDescription: This property shall indicate the direction of crossing
            of the reading for this sensor that activates the threshold.
        DwellTime:
          description: The duration the sensor value must violate the threshold before
            the threshold is activated.
          nullable: true
          pattern: ^P(\d+D)?(T(\d+H)?(\d+M)?(\d+(.\d+)?S)?)?$
          readOnly: false
          type: string
          x-longDescription: This property shall indicate the duration the sensor
            value violates the threshold before the threshold is activated.
        Reading:
          description: The threshold value.
          nullable: true
          readOnly: false
          type: number
          x-longDescription: This property shall indicate the reading for this sensor
            that activates the threshold.  The value of the property shall use the
            same units as the MetricProperties property.
      type: object
      x-longDescription: This type shall contain the properties for an individual
        threshold for this sensor.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    Triggers_v1_3_1_ThresholdActivation:
      enum:
      - Increasing
      - Decreasing
      - Either
      - Disabled
      type: string
      x-enumDescriptions:
        Decreasing: Value decreases below the threshold.
        Disabled: The threshold is disabled.
        Either: Value crosses the threshold in either direction.
        Increasing: Value increases above the threshold.
      x-enumLongDescriptions:
        Decreasing: This threshold is activated when the reading changes from a value
          higher than the threshold to a value lower than the threshold.
        Disabled: This value shall indicate the threshold is disabled and no actions
          shall be taken as a result of the reading crossing the threshold value.
        Either: This threshold is activated when either the Increasing or Decreasing
          conditions are met.
        Increasing: This threshold is activated when the reading changes from a value
          lower than the threshold to a value higher than the threshold.
      x-enumVersionAdded:
        Disabled: v1_3_0
    Triggers_v1_3_1_Thresholds:
      additionalProperties: false
      description: The set of thresholds for a sensor.
      properties:
        LowerCritical:
          $ref: '#/components/schemas/Triggers_v1_3_1_Threshold'
          description: The value at which the reading is below normal range and requires
            attention.
          x-longDescription: This property shall contain the value at which the MetricProperties
            property is below the normal range and may require attention.  The value
            of the property shall use the same units as the MetricProperties property.
        LowerWarning:
          $ref: '#/components/schemas/Triggers_v1_3_1_Threshold'
          description: The value at which the reading is below normal range.
          x-longDescription: This property shall contain the value at which the MetricProperties
            property is below the normal range.  The value of the property shall use
            the same units as the MetricProperties property.
        UpperCritical:
          $ref: '#/components/schemas/Triggers_v1_3_1_Threshold'
          description: The value at which the reading is above normal range and requires
            attention.
          x-longDescription: This property shall contain the value at which the MetricProperties
            property is above the normal range and may require attention.  The value
            of the property shall use the same units as the MetricProperties property.
        UpperWarning:
          $ref: '#/components/schemas/Triggers_v1_3_1_Threshold'
          description: The value at which the reading is above normal range.
          x-longDescription: This property shall contain the value at which the MetricProperties
            property is above the normal range.  The value of the property shall use
            the same units as the MetricProperties property.
      type: object
      x-longDescription: This type shall contain a set of thresholds for a sensor.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    Triggers_v1_3_1_TriggerActionEnum:
      description: The actions to perform when a trigger condition is met.
      enum:
      - LogToLogService
      - RedfishEvent
      - RedfishMetricReport
      type: string
      x-enumDescriptions:
        LogToLogService: When a trigger condition is met, record in a log.
        RedfishEvent: When a trigger condition is met, the service sends an event
          to subscribers.
        RedfishMetricReport: When a trigger condition is met, force an update of the
          specified metric reports.
      x-enumLongDescriptions:
        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 telemetry service resource describes.
        RedfishEvent: This value indicates that when a trigger condition is met, the
          service shall send an event to subscribers.
        RedfishMetricReport: This value indicates that when a trigger condition is
          met, the service shall force the metric reports managed by the MetricReportDefinitions
          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.
      x-enumVersionAdded:
        RedfishMetricReport: v1_1_0
      x-longDescription: This type shall specify the actions to perform when a trigger
        condition is met.
    Triggers_v1_3_1_Triggers:
      additionalProperties: false
      description: The Triggers schema describes a trigger that applies to metrics.
      properties:
        '@odata.context':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_context
        '@odata.etag':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_etag
        '@odata.id':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_id
        '@odata.type':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_type
        Actions:
          $ref: '#/components/schemas/Triggers_v1_3_1_Actions'
          description: The available actions for this resource.
          x-longDescription: This property shall contain the available actions for
            this resource.
        Description:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Description
          nullable: true
          readOnly: true
        DiscreteTriggerCondition:
          $ref: '#/components/schemas/Triggers_v1_3_1_DiscreteTriggerConditionEnum'
          description: The conditions when a discrete metric triggers.
          nullable: true
          readOnly: true
          x-longDescription: This property shall contain the conditions when a discrete
            metric triggers.
        DiscreteTriggers:
          description: The list of discrete triggers.
          items:
            $ref: '#/components/schemas/Triggers_v1_3_1_DiscreteTrigger'
          type: array
          x-longDescription: This property shall contain a list of values to which
            to compare a metric reading.  This property shall be present when the
            DiscreteTriggerCondition property is `Specified`.
        EventTriggers:
          description: The array of MessageIds that specify when a trigger condition
            is met based on an event.
          items:
            nullable: true
            type: string
          pattern: ^[A-Za-z0-9]+\.\d+\.\d+\.[A-Za-z0-9.]+$
          readOnly: false
          type: array
          x-longDescription: This property shall contain an array of MessageIds that
            specify when a trigger condition is met based on an event.  When the service
            generates an event and if it contains a MessageId within this array, a
            trigger condition shall be met.  The MetricType property should not be
            present if this resource is configured for event-based triggers.
          x-versionAdded: v1_1_0
        HysteresisDuration:
          description: The duration the sensor value must not violate the threshold
            before the threshold is deactivated.
          nullable: true
          pattern: ^P(\d+D)?(T(\d+H)?(\d+M)?(\d+(.\d+)?S)?)?$
          readOnly: false
          type: string
          x-longDescription: This property shall indicate the duration the sensor
            value no longer violates the threshold before the threshold is deactivated.  A
            duration of zero seconds, or if the property is not present in the resource,
            shall indicate the threshold is deactivated immediately once the sensor
            value no longer violates the threshold.  The threshold shall not deactivate
            until the conditions of both HysteresisReading and HysteresisDuration
            are met.
          x-versionAdded: v1_3_0
        HysteresisReading:
          description: The reading offset from the threshold value required to clear
            the threshold.
          nullable: true
          readOnly: false
          type: number
          x-longDescription: This property shall indicate the offset from the reading
            for this sensor and the threshold value that deactivates the threshold.  For
            example, a value of `-2` indicates the sensor reading shall fall 2 units
            below an upper threshold value to deactivate the threshold.  The value
            of the property shall use the same units as the Reading property.  A value
            of `0`, or if the property is not present in the resource, shall indicate
            the threshold is deactivated when the sensor value no longer violates
            the threshold.  The threshold shall not deactivate until the conditions
            of both HysteresisReading and HysteresisDuration are met.
          x-versionAdded: v1_3_0
        Id:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Id
          readOnly: true
        Links:
          $ref: '#/components/schemas/Triggers_v1_3_1_Links'
          description: The links to other resources that are related to this resource.
          x-longDescription: This property shall contain links to resources that are
            related to but are not contained by, or subordinate to, this resource.
          x-versionAdded: v1_1_0
        MetricIds:
          description: The label for the metric definitions that contain the property
            identifiers for this trigger.  It matches the Id property of the corresponding
            metric definition.
          items:
            nullable: true
            type: string
          readOnly: false
          type: array
          x-longDescription: This property shall contain the labels for the metric
            definitions that contain the property identifiers for this trigger.  This
            property shall match the value of the Id property of the corresponding
            metric definitions.
          x-versionAdded: v1_2_0
        MetricProperties:
          description: An array of URIs with wildcards and property identifiers for
            this trigger.  Each wildcard shall be replaced with its corresponding
            entry in the Wildcard array property.
          format: uri-reference
          items:
            nullable: true
            type: string
          readOnly: false
          type: array
          x-longDescription: This property shall contain an array of URIs with wildcards
            and property identifiers for this trigger.  Use a set of curly braces
            to delimit each wildcard in the URI.  Replace each wildcard with its corresponding
            entry in the Wildcard array property.  A URI that contains wildcards shall
            link to a resource property to which the metric definition applies after
            all wildcards are replaced with their corresponding entries in the Wildcard
            array property.  The property identifiers portion of the URI shall follow
            the RFC6901-defined JSON fragment notation rules.
        MetricType:
          $ref: '#/components/schemas/Triggers_v1_3_1_MetricTypeEnum'
          description: The metric type of the trigger.
          nullable: true
          readOnly: true
          x-longDescription: This property shall contain the metric type of the trigger.
        Name:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Name
          readOnly: true
        NumericThresholds:
          $ref: '#/components/schemas/Triggers_v1_3_1_Thresholds'
          description: The thresholds when a numeric metric triggers.
          x-longDescription: This property shall contain the list of thresholds to
            which to compare a numeric metric value.
        Oem:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Oem
          description: The OEM extension property.
          x-longDescription: This property shall contain the OEM extensions.  All
            values for properties that this object contains shall conform to the Redfish
            Specification-described requirements.
        Status:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Status
          description: The status and health of the resource and its subordinate or
            dependent resources.
          x-longDescription: This property shall contain any status or health properties
            of the resource.
        TriggerActions:
          description: The actions that the trigger initiates.
          items:
            $ref: '#/components/schemas/Triggers_v1_3_1_TriggerActionEnum'
          readOnly: true
          type: array
          x-longDescription: This property shall contain the actions that the trigger
            initiates.
        Wildcards:
          description: The wildcards and their substitution values for the entries
            in the MetricProperties array property.
          items:
            $ref: '#/components/schemas/Triggers_v1_3_1_Wildcard'
          type: array
          x-longDescription: This property shall contain the wildcards and their substitution
            values for the entries in the MetricProperties array property.  Each wildcard
            shall have a corresponding entry in this array property.
      required:
      - '@odata.id'
      - '@odata.type'
      - Id
      - Name
      type: object
      x-longDescription: This resource shall contain a trigger that applies to metrics.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    Triggers_v1_3_1_Wildcard:
      additionalProperties: false
      description: The wildcard and its substitution values.
      properties:
        Name:
          description: The wildcard.
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall contain the string used as a wildcard.
        Values:
          description: An array of values to substitute for the wildcard.
          items:
            nullable: true
            type: string
          readOnly: true
          type: array
          x-longDescription: This array property shall contain the list of values
            to substitute for the wildcard.
      type: object
      x-longDescription: This property shall contain a wildcard and its substitution
        values.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
title: '#Triggers.v1_3_1.Triggers'
x-copyright: Copyright 2014-2023 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright
x-owningEntity: DMTF
x-release: '2023.1'
