components:
  schemas:
    MetricReportDefinition_v1_1_4_Actions:
      additionalProperties: false
      description: The available actions for this resource.
      properties:
        Oem:
          $ref: '#/components/schemas/MetricReportDefinition_v1_1_4_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.
    MetricReportDefinition_v1_1_4_CalculationAlgorithmEnum:
      description: The function to apply to the list of metric properties.
      enum:
      - Average
      - Maximum
      - Minimum
      - Summation
      type: string
      x-enumDescriptions:
        Average: The metric is calculated as the average metric reading over a duration.
        Maximum: The metric is calculated as the maximum metric reading over a duration.
        Minimum: The metric is calculated as the minimum metric reading over a duration.
        Summation: The metric is calculated as the sum of the values over a duration.
      x-enumLongDescriptions:
        Average: This value shall indicate the metric is calculated as the average
          metric reading over a duration.  The duration shall be the CollectionDuration
          property value.
        Maximum: This value shall indicate the metric is calculated as the maximum
          metric reading over a duration.  The duration shall be the CollectionDuration
          property value.
        Minimum: This value shall indicate the metric is calculated as the minimum
          metric reading over a duration.  The duration shall be the CollectionDuration
          property value.
        Summation: This value shall indicate the metric is calculated as the sum of
          the specified metric reading over a duration.  The duration shall be the
          CollectionDuration property value.
      x-longDescription: This type shall specify the function to apply to the list
        of metric properties.
    MetricReportDefinition_v1_1_4_CollectionTimeScope:
      description: The time scope of the related metric values.
      enum:
      - Point
      - Interval
      - StartupInterval
      type: string
      x-enumDescriptions:
        Interval: The corresponding metric values apply to a time interval.  On the
          corresponding metric value instances, the Timestamp property value in the
          metric report specifies the end of the time interval and the CollectionDuration
          property specifies its duration.
        Point: The corresponding metric values apply to a point in time.  On the corresponding
          metric value instances, the Timestamp property value in the metric report
          specifies the point in time.
        StartupInterval: The corresponding metric values apply to a time interval
          that began at the startup of the measured resource.  On the corresponding
          metric value instances, the Timestamp property value in the metric report
          shall specifies the end of the time interval.  The CollectionDuration property
          value specifies the duration between the startup of resource and timestamp.
      x-enumLongDescriptions:
        Interval: This value shall indicate the corresponding metric values apply
          to a time interval.  On the corresponding metric value instances, the Timestamp
          property value in the metric report shall specify the end of the time interval
          and the CollectionDuration property shall specify its duration.
        Point: This value shall indicate the corresponding metric values apply to
          a point in time.  On the corresponding metric value instances, the Timestamp
          property value in the metric report shall specify the point in time.
        StartupInterval: This value shall indicate the corresponding metric values
          apply to a time interval that began at the startup of the measured resource.  On
          the corresponding metric value instances, the Timestamp property value in
          the metric report shall specify the end of the time interval.  The CollectionDuration
          property value shall specify the duration between the startup of resource
          and timestamp.
      x-longDescription: This type shall specify the time scope of the corresponding
        metric values.
    MetricReportDefinition_v1_1_4_Metric:
      additionalProperties: false
      description: Specifies a metric to include in the metric report.  The metrics
        are derived by applying a calculation on each of the listed metric properties.
      properties:
        CollectionDuration:
          description: The duration over which the function is computed.
          nullable: true
          pattern: -?P(\d+D)?(T(\d+H)?(\d+M)?(\d+(.\d+)?S)?)?
          readOnly: false
          type: string
          x-longDescription: This property shall specify the duration over which the
            function is computed.
        CollectionFunction:
          $ref: '#/components/schemas/MetricReportDefinition_v1_1_4_CalculationAlgorithmEnum'
          description: Specifies the function to perform on each of the metric properties
            listed in the MetricProperties property.
          nullable: true
          readOnly: false
          x-longDescription: The property shall specify the function to perform on
            each of the metric properties listed in the MetricProperties property.
        CollectionTimeScope:
          $ref: '#/components/schemas/MetricReportDefinition_v1_1_4_CollectionTimeScope'
          description: The scope of time over which the function is applied.
          nullable: true
          readOnly: false
          x-longDescription: This property shall specify the scope of time over which
            the function is applied.
        MetricId:
          description: The label for the metric definition that is derived by applying
            the collectionFunction to the metric property.  It matches the Id property
            of the corresponding metric definition.
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall specify the label for the metric
            definition that is derived by applying the algorithm specified in the
            CollectionFunction property to the metric property.  This property shall
            match the Id property of the corresponding metric definition.
        MetricProperties:
          description: The set of URIs for the properties on which this metric is
            collected.
          format: uri-reference
          items:
            nullable: true
            type: string
          readOnly: false
          type: array
          x-longDescription: Each value can contain one or more wildcard names enclosed
            in curly braces.  Wildcard value entries shall be substituted for each
            Wildcard name found.  If two or more wild names are found, the same wildcard
            index is used for each in one substitution pass.  After substituting the
            wildcard values entries, each value shall contain a URI for a property
            in a resource that matches a property declaration in the corresponding
            metric definition.
      type: object
      x-longDescription: The properties shall specify a metric to include in the metric
        report.  The metrics shall be derived by applying the algorithm specified
        in the CollectionFunction property to each of the metric properties listed
        in the MetricProperties property.
      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.
    MetricReportDefinition_v1_1_4_MetricReportDefinition:
      additionalProperties: false
      description: The MetricReportDefinition schema describes set of metrics that
        are collected into a metric report.
      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/MetricReportDefinition_v1_1_4_Actions'
          description: The available actions for this resource.
          x-longDescription: This property shall contain the available actions for
            this resource.
        AppendLimit:
          description: The maximum number of entries that can be appended to a metric
            report.  When the metric report reaches its limit, its behavior is dictated
            by the ReportUpdates property.
          minimum: 0
          readOnly: true
          type: integer
          x-longDescription: This property shall contain a number that indicates the
            maximum number of entries that can be appended to a metric report.  When
            the metric report reaches its limit, its behavior shall be dictated by
            the ReportUpdates property.  This property shall be required if ReportUpdates
            is either AppendWrapsWhenFull or AppendStopsWhenFull.
        Description:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Description
          nullable: true
          readOnly: true
        Id:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Id
          readOnly: true
        MetricProperties:
          description: The list of URIs with wildcards and property identifiers to
            include in the metric report.  If a URI has wildcards, the wildcards are
            substituted as specified in the Wildcards property.
          format: uri-reference
          items:
            nullable: true
            type: string
          readOnly: false
          type: array
          x-longDescription: This property shall contain a list of URIs with wildcards
            and property identifiers to include in the metric report.  A set of curly
            braces shall delimit each wildcard in the URI.  The corresponding entry
            in the Wildcard property shall replace each wildcard.  After a URI with
            wildcards replaces each wildcard, it shall describe a resource property
            to include in the metric report.  The property identifiers portion of
            the URI shall follow RFC6901-specified JSON fragment notation rules.
        MetricReport:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: The location where the resultant metric report is placed.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource of type
            MetricReport where the resultant metric report is placed.
        MetricReportDefinitionType:
          $ref: '#/components/schemas/MetricReportDefinition_v1_1_4_MetricReportDefinitionType'
          description: Specifies when the metric report is generated.
          nullable: true
          readOnly: false
          x-longDescription: This property shall specify when the metric report is
            generated.  If the value is `Periodic`, the Schedule property shall be
            present.
        Metrics:
          description: The list of metrics to include in the metric report.  The metrics
            might include metric properties or calculations applied to a metric property.
          items:
            $ref: '#/components/schemas/MetricReportDefinition_v1_1_4_Metric'
          type: array
          x-longDescription: The property shall contain a list of metrics to include
            in the metric report.  The metrics might include metric properties or
            calculations that are applied to a metric property.
        Name:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Name
          readOnly: true
        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.
        ReportActions:
          description: The set of actions to perform when a metric report is generated.
          items:
            $ref: '#/components/schemas/MetricReportDefinition_v1_1_4_ReportActionsEnum'
          readOnly: true
          type: array
          x-longDescription: This property shall contain the set of actions to perform
            when the metric report is generated.  This property should be ignored
            if MetricReportDefinitionType contains the value `OnRequest`.
        ReportUpdates:
          $ref: '#/components/schemas/MetricReportDefinition_v1_1_4_ReportUpdatesEnum'
          description: The behavior for how subsequent metric reports are handled
            in relationship to an existing metric report created from the metric report
            definition.  Namely, whether to overwrite, append, or create a report
            resource.
          readOnly: true
          x-longDescription: This property shall contain the behavior for how subsequent
            metric reports are handled in relationship to an existing metric report
            created from the metric report definition.  This property should be ignored
            if MetricReportDefinitionType contains the value `OnRequest`.
        Schedule:
          $ref: http://redfish.dmtf.org/schemas/v1/Schedule.yaml#/components/schemas/Schedule_Schedule
          description: The schedule for generating the metric report.
          x-longDescription: This property shall contain the schedule of the metric
            report.  The metric report shall be generated at an interval specified
            by the RecurrenceInterval property within Schedule.  If MaxOccurrences
            property within Schedule is specified, the metric report shall no longer
            be generated after the specified number of occurrences.  The State property
            within Status should be set to `Disabled` and the MetricReportDefinitionEnabled
            property should be set to `false` when the specified number of occurrences
            is reached.
        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.
        Wildcards:
          description: The set of wildcards and their substitution values for the
            entries in the MetricProperties property.
          items:
            $ref: '#/components/schemas/MetricReportDefinition_v1_1_4_Wildcard'
          type: array
          x-longDescription: The property shall contain a set of wildcards and their
            replacement strings, which are applied to the MetricProperties property.  Each
            wildcard expressed in the MetricProperties property shall have a corresponding
            entry in this property.
      required:
      - '@odata.id'
      - '@odata.type'
      - Id
      - Name
      type: object
      x-longDescription: This resource shall specify a set of metrics that shall be
        collected into a metric report in a Redfish implementation.
      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.
    MetricReportDefinition_v1_1_4_MetricReportDefinitionType:
      description: Indicates when the metric report is generated.
      enum:
      - Periodic
      - OnChange
      - OnRequest
      type: string
      x-enumDescriptions:
        OnChange: The metric report is generated when any of the metric values change.
        OnRequest: The metric report is generated when a HTTP GET is performed on
          the specified metric report.
        Periodic: The metric report is generated at a periodic time interval, specified
          in the Schedule property.
      x-longDescription: This type shall specify when the metric report is generated.
    MetricReportDefinition_v1_1_4_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.
    MetricReportDefinition_v1_1_4_ReportActionsEnum:
      description: Actions to perform when a metric report is generated.
      enum:
      - LogToMetricReportsCollection
      - RedfishEvent
      type: string
      x-enumDescriptions:
        LogToMetricReportsCollection: Record the occurrence to the metric report collection.
        RedfishEvent: Send a Redfish event message containing the metric report.
      x-enumLongDescriptions:
        LogToMetricReportsCollection: This value shall indicate the service records
          the occurrence to the metric report collection found under the telemetry
          service.  The service shall update the metric report based on the setting
          of the ReportUpdates property.
        RedfishEvent: This value shall indicate the service sends a Redfish event
          of type MetricReport to subscribers in the event subscription collection
          of the event service.
      x-longDescription: This type shall specify the actions to perform when a metric
        report is generated.
    MetricReportDefinition_v1_1_4_ReportUpdatesEnum:
      description: Handling of subsequent metric reports when a metric report exists.
      enum:
      - Overwrite
      - AppendWrapsWhenFull
      - AppendStopsWhenFull
      - NewReport
      type: string
      x-enumDescriptions:
        AppendStopsWhenFull: New information is appended to the metric report.  The
          service stops adding entries when the metric report has reached its maximum
          capacity.
        AppendWrapsWhenFull: New information is appended to the metric report.  The
          metric report entries are overwritten with new entries when the metric report
          has reached its maximum capacity.
        NewReport: A new metric report is created, whose resource name is the metric
          report resource name concatenated with the timestamp.
        Overwrite: Overwrite the metric report.
      x-enumLongDescriptions:
        AppendStopsWhenFull: This value shall indicate the service appends new information
          to the metric report referenced by the MetricReport property.  The service
          shall stop adding entries when the metric report has reached its maximum
          capacity.  The State property within Status should be set to `Disabled`
          and the MetricReportDefinitionEnabled property should be set to `false`
          when the append limit is reached.
        AppendWrapsWhenFull: This value shall indicate the service appends new information
          to the metric report referenced by the MetricReport property.  The service
          shall overwrite entries in the metric report with new entries when the metric
          report has reached its maximum capacity.
        NewReport: This value shall indicate the service creates a new metric report
          resource, whose resource name is the metric report resource name concatenated
          with the timestamp.
        Overwrite: This value shall indicate the service overwrites the metric report
          referenced by the MetricReport property.
      x-longDescription: This type shall indicate how the service handles subsequent
        metric reports when a metric report exists.
    MetricReportDefinition_v1_1_4_Wildcard:
      additionalProperties: false
      description: The wildcard and its substitution values.
      properties:
        Keys:
          deprecated: true
          description: An array of values to substitute for the wildcard.
          items:
            nullable: true
            type: string
          readOnly: true
          type: array
          x-deprecatedReason: This property has been deprecated in favor of using
            the property Values.
          x-longDescription: This property shall contain the list of values to substitute
            for the wildcard.
          x-versionDeprecated: v1_1_0
        Name:
          description: The string used as a 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 property shall contain the list of values to substitute
            for the wildcard.
          x-versionAdded: v1_1_0
      type: object
      x-longDescription: This type 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: '#MetricReportDefinition.v1_1_4.MetricReportDefinition'
x-copyright: Copyright 2014-2020 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright
x-owningEntity: DMTF
x-release: '2018.3'
