components:
  schemas:
    TelemetryService_v1_3_1_Actions:
      additionalProperties: false
      description: The available actions for this resource.
      properties:
        '#TelemetryService.ClearMetricReports':
          $ref: '#/components/schemas/TelemetryService_v1_3_1_ClearMetricReports'
        '#TelemetryService.ResetMetricReportDefinitionsToDefaults':
          $ref: '#/components/schemas/TelemetryService_v1_3_1_ResetMetricReportDefinitionsToDefaults'
        '#TelemetryService.ResetTriggersToDefaults':
          $ref: '#/components/schemas/TelemetryService_v1_3_1_ResetTriggersToDefaults'
        '#TelemetryService.SubmitTestMetricReport':
          $ref: '#/components/schemas/TelemetryService_v1_3_1_SubmitTestMetricReport'
        Oem:
          $ref: '#/components/schemas/TelemetryService_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.
    TelemetryService_v1_3_1_ClearMetricReports:
      additionalProperties: false
      description: The action to clear the metric reports for this telemetry service.
      properties:
        target:
          description: Link to invoke action
          format: uri-reference
          type: string
        title:
          description: Friendly action name
          type: string
      type: object
      x-longDescription: This action shall delete all entries found in the metric
        report collection for this telemetry service.
      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.
      x-versionAdded: v1_3_0
    TelemetryService_v1_3_1_ClearMetricReportsRequestBody:
      additionalProperties: false
      description: The action to clear the metric reports for this telemetry service.
      properties: {}
      type: object
      x-longDescription: This action shall delete all entries found in the metric
        report collection for this telemetry service.
    TelemetryService_v1_3_1_CollectionFunction:
      description: An operation to perform over the sample.
      enum:
      - Average
      - Maximum
      - Minimum
      - Summation
      type: string
      x-enumDescriptions:
        Average: An averaging function.
        Maximum: A maximum function.
        Minimum: A minimum function.
        Summation: A summation function.
      x-longDescription: If present, the metric value shall be computed according
        to this function.
    TelemetryService_v1_3_1_MetricValue:
      additionalProperties: false
      description: Properties that capture a metric value and other associated information.
      properties:
        MetricDefinition:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: The link to the metric definition for this metric.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource of type
            MetricDefinition that describes what this metric value captures.
          x-versionAdded: v1_1_0
        MetricId:
          description: The metric definitions identifier for this metric.
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall contain the same value as the Id
            property of the source metric within the associated metric definition.
          x-versionAdded: v1_1_0
        MetricProperty:
          description: The URI for the property from which this metric is derived.
          format: uri-reference
          nullable: true
          readOnly: true
          type: string
          x-longDescription: The value shall be URI to the property following the
            JSON fragment notation, as defined by RFC6901, to identify an individual
            property in a Redfish resource.
          x-versionAdded: v1_1_0
        MetricValue:
          description: The metric value, as a string.
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall contain the metric value, as a string.
          x-versionAdded: v1_1_0
        Timestamp:
          description: The date and time when the metric is obtained.  A management
            application can establish a time series of metric data by retrieving the
            instances of metric value and sorting them according to their timestamp.
          format: date-time
          nullable: true
          readOnly: true
          type: string
          x-longDescription: The value shall time when the metric value was obtained.  Note
            that this value may be different from the time when this instance is created.
          x-versionAdded: v1_1_0
      type: object
      x-longDescription: This type shall contain properties that capture a metric
        value and other associated information.
      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.
    TelemetryService_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.
    TelemetryService_v1_3_1_ResetMetricReportDefinitionsToDefaults:
      additionalProperties: false
      description: The action to reset the metric report definitions to factory defaults.
      properties:
        target:
          description: Link to invoke action
          format: uri-reference
          type: string
        title:
          description: Friendly action name
          type: string
      type: object
      x-longDescription: This action shall reset all entries found in the metric report
        definition collection to factory defaults.  This action may delete members
        of the metric report definition collection.
      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.
      x-versionAdded: v1_3_0
    TelemetryService_v1_3_1_ResetMetricReportDefinitionsToDefaultsRequestBody:
      additionalProperties: false
      description: The action to reset the metric report definitions to factory defaults.
      properties: {}
      type: object
      x-longDescription: This action shall reset all entries found in the metric report
        definition collection to factory defaults.  This action may delete members
        of the metric report definition collection.
    TelemetryService_v1_3_1_ResetTriggersToDefaults:
      additionalProperties: false
      description: The action to reset the triggers to factory defaults.
      properties:
        target:
          description: Link to invoke action
          format: uri-reference
          type: string
        title:
          description: Friendly action name
          type: string
      type: object
      x-longDescription: This action shall reset all entries found in the triggers
        collection to factory defaults.  This action may delete members of the triggers
        collection.
      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.
      x-versionAdded: v1_3_0
    TelemetryService_v1_3_1_ResetTriggersToDefaultsRequestBody:
      additionalProperties: false
      description: The action to reset the triggers to factory defaults.
      properties: {}
      type: object
      x-longDescription: This action shall reset all entries found in the triggers
        collection to factory defaults.  This action may delete members of the triggers
        collection.
    TelemetryService_v1_3_1_SubmitTestMetricReport:
      additionalProperties: false
      description: This action generates a metric report.
      properties:
        target:
          description: Link to invoke action
          format: uri-reference
          type: string
        title:
          description: Friendly action name
          type: string
      type: object
      x-longDescription: This action shall cause the Event Service to immediately
        generate the metric report as an alert event.  Then, this message should be
        sent to any appropriate event destinations.
      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.
    TelemetryService_v1_3_1_SubmitTestMetricReportRequestBody:
      additionalProperties: false
      description: This action generates a metric report.
      properties:
        GeneratedMetricReportValues:
          description: The content of the MetricReportValues in the generated metric
            report.
          items:
            $ref: '#/components/schemas/TelemetryService_v1_3_1_MetricValue'
          type: array
          x-longDescription: This parameter shall contain the contents of the MetricReportValues
            array property in the generated metric report.
          x-versionAdded: v1_1_0
        MetricReportName:
          description: The name of the metric report in generated metric report.
          type: string
          x-longDescription: This parameter shall contain the name of the generated
            metric report.
        MetricReportValues:
          deprecated: true
          description: The contents of MetricReportValues array in the generated metric
            report.
          type: string
          x-deprecatedReason: This property has been deprecated in favor of using
            the property 'GeneratedMetricReportValues'.
          x-longDescription: This parameter shall contain the contents of the MetricReportValues
            array property in the generated metric report.
          x-versionDeprecated: v1_1_0
      required:
      - GeneratedMetricReportValues
      - MetricReportName
      type: object
      x-longDescription: This action shall cause the Event Service to immediately
        generate the metric report as an alert event.  Then, this message should be
        sent to any appropriate event destinations.
    TelemetryService_v1_3_1_TelemetryService:
      additionalProperties: false
      description: The TelemetryService schema describes a telemetry service.  The
        telemetry service is used to for collecting and reporting metric data within
        the Redfish Service.
      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/TelemetryService_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
        Id:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Id
          readOnly: true
        LogService:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: The link to a log service that the telemetry service uses.  This
            service can be a dedicated log service or a pointer a log service under
            another resource, such as a manager.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource of type
            LogService that this telemetry service uses.
        MaxReports:
          description: The maximum number of metric reports that this service supports.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the maximum number of metric
            reports that this service supports.
        MetricDefinitions:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: The link to the collection of metric definitions.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource collection
            of type MetricDefinitionCollection.
        MetricReportDefinitions:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: The link to the collection of metric report definitions.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource collection
            of type MetricReportDefinitionCollection.
        MetricReports:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: The link to the collection of metric reports.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource collection
            of type MetricReportCollection.
        MinCollectionInterval:
          description: The minimum time interval between gathering metric data that
            this service allows.
          nullable: true
          pattern: -?P(\d+D)?(T(\d+H)?(\d+M)?(\d+(.\d+)?S)?)?
          readOnly: true
          type: string
          x-longDescription: This property shall contain the minimum time interval
            between gathering metric data that this service allows.
        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.
        ServiceEnabled:
          description: An indication of whether this service is enabled.
          nullable: true
          readOnly: false
          type: boolean
          x-longDescription: This property shall indicate whether this service is
            enabled.
          x-versionAdded: v1_2_0
        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.
        SupportedCollectionFunctions:
          description: The functions that can be performed over each metric.
          items:
            $ref: '#/components/schemas/TelemetryService_v1_3_1_CollectionFunction'
            nullable: true
          readOnly: false
          type: array
          x-longDescription: This property shall contain the function to apply over
            the collection duration.
        Triggers:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: The link to the collection of triggers that apply to metrics.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource collection
            of type TriggersCollection.
      required:
      - '@odata.id'
      - '@odata.type'
      - Id
      - Name
      type: object
      x-longDescription: This resource contains a telemetry service for 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.
title: '#TelemetryService.v1_3_1.TelemetryService'
x-copyright: Copyright 2014-2021 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright
x-owningEntity: DMTF
x-release: '2020.4'
