blob: b637f882b69cc60b1f740308d8a5edd91b6ff4d2 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!---->
<!--################################################################################ -->
<!--# Redfish Schema: MetricReport v1.5.0 -->
<!--# -->
<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, -->
<!--# available at http://www.dmtf.org/standards/redfish -->
<!--# Copyright 2014-2023 DMTF. -->
<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
<!--################################################################################ -->
<!---->
<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
<edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
<edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
</edmx:Reference>
<edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
<edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
<edmx:Include Namespace="Resource"/>
<edmx:Include Namespace="Resource.v1_0_0"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
<edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/MetricReportDefinition_v1.xml">
<edmx:Include Namespace="MetricReportDefinition"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/MetricDefinition_v1.xml">
<edmx:Include Namespace="MetricDefinition"/>
</edmx:Reference>
<edmx:DataServices>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<EntityType Name="MetricReport" BaseType="Resource.v1_0_0.Resource" Abstract="true">
<Annotation Term="OData.Description" String="The MetricReport schema represents a set of collected metrics."/>
<Annotation Term="OData.LongDescription" String="This resource shall represent a metric report in a Redfish implementation. When a metric report is deleted, the historic metric data used to generate the report shall be deleted as well unless other metric reports are consuming the data."/>
<Annotation Term="Capabilities.InsertRestrictions">
<Record>
<PropertyValue Property="Insertable" Bool="false"/>
</Record>
</Annotation>
<Annotation Term="Capabilities.UpdateRestrictions">
<Record>
<PropertyValue Property="Updatable" Bool="false"/>
</Record>
</Annotation>
<Annotation Term="Capabilities.DeleteRestrictions">
<Record>
<PropertyValue Property="Deletable" Bool="true"/>
<Annotation Term="OData.Description" String="Metric reports can be deleted."/>
</Record>
</Annotation>
<Annotation Term="Redfish.Uris">
<Collection>
<String>/redfish/v1/TelemetryService/MetricReports/{MetricReportId}</String>
</Collection>
</Annotation>
</EntityType>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_0_0">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="Redfish.Release" String="2018.2"/>
<EntityType Name="MetricReport" BaseType="MetricReport.MetricReport">
<NavigationProperty Name="MetricReportDefinition" Type="MetricReportDefinition.MetricReportDefinition" Nullable="false">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<Annotation Term="OData.Description" String="The link to the definition of this metric report."/>
<Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type MetricReportDefinition."/>
<Annotation Term="OData.AutoExpandReferences"/>
</NavigationProperty>
<Property Name="ReportSequence" Type="Edm.String" Nullable="false">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<Annotation Term="OData.Description" String="The current sequence identifier for this metric report."/>
<Annotation Term="OData.LongDescription" String="This property shall contain the current sequence identifier for this metric report. The sequence identifier is a unique identifier assigned by the Service for serializing metric reports as they are produced."/>
<Annotation Term="Redfish.Revisions">
<Collection>
<Record>
<PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Deprecated"/>
<PropertyValue Property="Version" String="v1_3_0"/>
<PropertyValue Property="Description" String="This property has been deprecated due to specification changes with regards to Server-Sent Events."/>
</Record>
</Collection>
</Annotation>
</Property>
<Property Name="MetricValues" Type="Collection(MetricReport.v1_0_0.MetricValue)" Nullable="false">
<Annotation Term="OData.Description" String="An array of metric values for the metered items of this metric report."/>
<Annotation Term="OData.LongDescription" String="The values shall be metric values for this metric report."/>
</Property>
<Property Name="Actions" Type="MetricReport.v1_0_0.Actions" Nullable="false">
<Annotation Term="OData.Description" String="The available actions for this resource."/>
<Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
</Property>
</EntityType>
<ComplexType Name="MetricValue">
<Annotation Term="OData.AdditionalProperties" Bool="false"/>
<Annotation Term="OData.Description" String="Properties that capture a metric value and other associated information."/>
<Annotation Term="OData.LongDescription" String="This type shall contain properties that capture a metric value and other associated information."/>
<Property Name="MetricId" Type="Edm.String">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<Annotation Term="OData.Description" String="The metric definitions identifier that contains additional information for the source metric."/>
<Annotation Term="OData.LongDescription" String="This property shall contain the value of the Id property of the MetricDefinition resource that contains additional information for the source metric."/>
</Property>
<Property Name="MetricValue" Type="Edm.String">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<Annotation Term="OData.Description" String="The metric value, as a string."/>
<Annotation Term="OData.LongDescription" String="This property shall contain the metric value, as a string."/>
</Property>
<Property Name="Timestamp" Type="Edm.DateTimeOffset">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<Annotation Term="OData.Description" String="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."/>
<Annotation Term="OData.LongDescription" String="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."/>
</Property>
<Property Name="MetricProperty" Type="Edm.String">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<Annotation Term="OData.Description" String="The URI for the property from which this metric is derived."/>
<Annotation Term="OData.LongDescription" String="This property shall contain a URI following RFC6901-specified JSON pointer notation to the property from which this metric is derived. The value of MetricValue may contain additional calculations performed on the property based upon the configuration of the MetricReportDefinition."/>
<Annotation Term="OData.IsURL"/>
</Property>
<NavigationProperty Name="MetricDefinition" Type="MetricDefinition.MetricDefinition" Nullable="false">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<Annotation Term="OData.Description" String="The link to the metric definition for this metric."/>
<Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type MetricDefinition that describes what this metric value captures."/>
<Annotation Term="OData.AutoExpandReferences"/>
<Annotation Term="Redfish.Revisions">
<Collection>
<Record>
<PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Deprecated"/>
<PropertyValue Property="Version" String="v1_5_0"/>
<PropertyValue Property="Description" String="This property has been deprecated in favor of the MetricId property."/>
</Record>
</Collection>
</Annotation>
</NavigationProperty>
</ComplexType>
<ComplexType Name="Actions">
<Annotation Term="OData.AdditionalProperties" Bool="false"/>
<Annotation Term="OData.Description" String="The available actions for this resource."/>
<Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
<Property Name="Oem" Type="MetricReport.v1_0_0.OemActions" Nullable="false">
<Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
<Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
</Property>
</ComplexType>
<ComplexType Name="OemActions">
<Annotation Term="OData.AdditionalProperties" Bool="true"/>
<Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
<Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
</ComplexType>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_0_1">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to clarify descriptions of several properties."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_0_0.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_0_2">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format, and to add a missing term to MetricValues to disallow it from being null."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_0_1.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_0_3">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_0_2.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_0_4">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to no longer make ReportSequence required."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_0_3.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_0_5">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_0_4.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_0_6">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to clarify behavior for when a metric report is deleted."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_0_5.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_0_7">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to correct various description to use proper normative terminology."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_0_6.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_0_8">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to clarify the usage of MetricId and MetricProperty."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_0_7.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_1_0">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="Redfish.Release" String="2018.3"/>
<Annotation Term="OData.Description" String="This version was created to add a Timestamp property for the metric report in its entirety."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_0_1.MetricReport">
<Property Name="Timestamp" Type="Edm.DateTimeOffset">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<Annotation Term="OData.Description" String="The time associated with the metric report in its entirety. The time of the metric report can be relevant when the time of individual metrics are minimally different."/>
<Annotation Term="OData.LongDescription" String="This property shall contain the time when the metric report was generated."/>
</Property>
</EntityType>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_1_1">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format, and to add a missing term to MetricValues to disallow it from being null."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_1_0.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_1_2">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_1_1.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_1_3">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to no longer make ReportSequence required."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_1_2.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_1_4">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_1_3.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_1_5">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to clarify behavior for when a metric report is deleted."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_1_4.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_1_6">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to correct various description to use proper normative terminology."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_1_5.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_1_7">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to clarify the usage of MetricId and MetricProperty."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_1_6.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_2_0">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="Redfish.Release" String="2019.2"/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_1_2.MetricReport"/>
<ComplexType Name="MetricValue" BaseType="MetricReport.v1_0_0.MetricValue">
<Property Name="Oem" Type="Resource.Oem" Nullable="false">
<Annotation Term="OData.Description" String="The OEM extension property."/>
<Annotation Term="OData.LongDescription" String="This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements."/>
</Property>
</ComplexType>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_2_1">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to no longer make ReportSequence required."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_2_0.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_2_2">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_2_1.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_2_3">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to clarify behavior for when a metric report is deleted."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_2_2.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_2_4">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to correct various description to use proper normative terminology."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_2_3.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_2_5">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to clarify the usage of MetricId and MetricProperty."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_2_4.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_3_0">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="Redfish.Release" String="2019.4"/>
<Annotation Term="OData.Description" String="This version was created to deprecate ReportSequence."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_2_1.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_3_1">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_3_0.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_3_2">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to clarify behavior for when a metric report is deleted."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_3_1.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_3_4">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to correct various description to use proper normative terminology."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_3_2.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_3_5">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to clarify the usage of MetricId and MetricProperty."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_3_4.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_4_0">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="Redfish.Release" String="2020.2"/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_3_1.MetricReport">
<Property Name="Context" Type="Edm.String" Nullable="false">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<Annotation Term="OData.Description" String="A context can be supplied at subscription time. This property is the context value supplied by the subscriber."/>
<Annotation Term="OData.LongDescription" String="This property shall contain a client supplied context for the event destination to which this event is being sent. This property shall only be present when sent as a payload in an event."/>
</Property>
</EntityType>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_4_1">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to clarify behavior for when a metric report is deleted."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_4_0.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_4_2">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to correct various description to use proper normative terminology."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_4_1.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_4_3">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to clarify the usage of MetricId and MetricProperty."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_4_2.MetricReport"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_5_0">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="Redfish.Release" String="2022.2"/>
<Annotation Term="OData.Description" String="This version was created to deprecate MetricDefinition in favor of MetricId."/>
<EntityType Name="MetricReport" BaseType="MetricReport.v1_4_3.MetricReport"/>
</Schema>
</edmx:DataServices>
</edmx:Edmx>