| <?xml version="1.0" encoding="UTF-8"?> |
| <!----> |
| <!--################################################################################ --> |
| <!--# Redfish Schema: MetricDefinition v1.0.4 --> |
| <!--# --> |
| <!--# For a detailed change log, see the README file contained in the DSP8010 bundle, --> |
| <!--# available at http://www.dmtf.org/standards/redfish --> |
| <!--# Copyright 2014-2020 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.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/PhysicalContext_v1.xml"> |
| <edmx:Include Namespace="PhysicalContext"/> |
| </edmx:Reference> |
| |
| <edmx:DataServices> |
| |
| <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricDefinition"> |
| <Annotation Term="Redfish.OwningEntity" String="DMTF"/> |
| |
| <EntityType Name="MetricDefinition" BaseType="Resource.v1_0_0.Resource" Abstract="true"> |
| <Annotation Term="OData.Description" String="The MetricDefinition schema describes the metadata information for a metric."/> |
| <Annotation Term="OData.LongDescription" String="This resource shall contain the metadata information for a metric in a Redfish implementation."/> |
| <Annotation Term="Capabilities.InsertRestrictions"> |
| <Record> |
| <PropertyValue Property="Insertable" Bool="false"/> |
| </Record> |
| </Annotation> |
| <Annotation Term="Capabilities.UpdateRestrictions"> |
| <Record> |
| <PropertyValue Property="Updatable" Bool="true"/> |
| <Annotation Term="OData.Description" String="Any writable properties can be updated for metric definitions."/> |
| </Record> |
| </Annotation> |
| <Annotation Term="Capabilities.DeleteRestrictions"> |
| <Record> |
| <PropertyValue Property="Deletable" Bool="true"/> |
| <Annotation Term="OData.Description" String="The metric definitions can be deleted."/> |
| </Record> |
| </Annotation> |
| <Annotation Term="Redfish.Uris"> |
| <Collection> |
| <String>/redfish/v1/TelemetryService/MetricDefinitions/{MetricDefinitionId}</String> |
| </Collection> |
| </Annotation> |
| </EntityType> |
| </Schema> |
| |
| <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricDefinition.v1_0_0"> |
| <Annotation Term="Redfish.OwningEntity" String="DMTF"/> |
| <Annotation Term="Redfish.Release" String="2018.2"/> |
| |
| <EnumType Name="MetricType"> |
| <Annotation Term="OData.Description" String="The type of metric. Provides information to the client on how the metric can be handled."/> |
| <Annotation Term="OData.LongDescription" String="This property shall contain the type of metric."/> |
| <Member Name="Numeric"> |
| <Annotation Term="OData.Description" String="The metric is a numeric metric. The metric value is any real number."/> |
| </Member> |
| <Member Name="Discrete"> |
| <Annotation Term="OData.Description" String="The metric is a discrete metric. The metric value is discrete. The possible values are listed in the DiscreteValues property."/> |
| <Annotation Term="OData.LongDescription" String="The metric values shall indicate discrete states."/> |
| </Member> |
| <Member Name="Gauge"> |
| <Annotation Term="OData.Description" String="The metric is a gauge metric. The metric value is a real number. When the metric value reaches the gauges extrema, it stays at that value, until the reading falls within the extrema."/> |
| </Member> |
| <Member Name="Counter"> |
| <Annotation Term="OData.Description" String="The metric is a counter metric. The metric reading is a non-negative integer that increases monotonically. When a counter reaches its maximum, the value resets to 0 and resumes counting."/> |
| </Member> |
| <Member Name="Countdown"> |
| <Annotation Term="OData.Description" String="The metric is a countdown metric. The metric reading is a non-negative integer that decreases monotonically. When a counter reaches its minimum, the value resets to preset value and resumes counting down."/> |
| </Member> |
| </EnumType> |
| |
| <EnumType Name="ImplementationType"> |
| <Member Name="PhysicalSensor"> |
| <Annotation Term="OData.Description" String="The metric is implemented as a physical sensor."/> |
| </Member> |
| <Member Name="Calculated"> |
| <Annotation Term="OData.Description" String="The metric is implemented by applying a calculation on another metric property. The calculation is specified in the CalculationAlgorithm property."/> |
| </Member> |
| <Member Name="Synthesized"> |
| <Annotation Term="OData.Description" String="The metric is implemented by applying a calculation on one or more metric properties. The calculation is not provided."/> |
| </Member> |
| <Member Name="DigitalMeter"> |
| <Annotation Term="OData.Description" String="The metric is implemented as digital meter."/> |
| </Member> |
| </EnumType> |
| |
| <EnumType Name="MetricDataType"> |
| <Annotation Term="OData.Description" String="The data type of the related metric values. Provides information to the client on the nature of the metric reading."/> |
| <Annotation Term="OData.LongDescription" String="This type shall describe the data type of the related metric values as defined by JSON data types."/> |
| <Member Name="Boolean"> |
| <Annotation Term="OData.Description" String="The JSON boolean definition."/> |
| </Member> |
| <Member Name="DateTime"> |
| <Annotation Term="OData.Description" String="The JSON string definition with the date-time format."/> |
| </Member> |
| <Member Name="Decimal"> |
| <Annotation Term="OData.Description" String="The JSON decimal definition."/> |
| </Member> |
| <Member Name="Integer"> |
| <Annotation Term="OData.Description" String="The JSON integer definition."/> |
| </Member> |
| <Member Name="String"> |
| <Annotation Term="OData.Description" String="The JSON string definition."/> |
| </Member> |
| <Member Name="Enumeration"> |
| <Annotation Term="OData.Description" String="The JSON string definition with a set of defined enumerations."/> |
| </Member> |
| </EnumType> |
| |
| <EnumType Name="Calculable"> |
| <Annotation Term="OData.Description" String="The types of calculations that can be applied to the metric reading. Provides information to the client on the suitability of calculation using the metric reading."/> |
| <Annotation Term="OData.LongDescription" String="The type shall describe the types of calculations that can be applied to the metric reading."/> |
| <Member Name="NonCalculatable"> |
| <Annotation Term="OData.Description" String="No calculations should be performed on the metric reading."/> |
| </Member> |
| <Member Name="Summable"> |
| <Annotation Term="OData.Description" String="The sum of the metric reading across multiple instances is meaningful."/> |
| </Member> |
| <Member Name="NonSummable"> |
| <Annotation Term="OData.Description" String="The sum of the metric reading across multiple instances is not meaningful."/> |
| </Member> |
| </EnumType> |
| |
| <EntityType Name="MetricDefinition" BaseType="MetricDefinition.MetricDefinition"> |
| <Property Name="MetricType" Type="MetricDefinition.v1_0_0.MetricType"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> |
| <Annotation Term="OData.Description" String="The type of metric."/> |
| <Annotation Term="OData.LongDescription" String="This property shall specify the type of metric."/> |
| </Property> |
| <Property Name="MetricDataType" Type="MetricDefinition.v1_0_0.MetricDataType"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> |
| <Annotation Term="OData.Description" String="The data type of the metric."/> |
| <Annotation Term="OData.LongDescription" String="This property shall specify the data-type of the metric."/> |
| </Property> |
| <Property Name="Units" Type="Edm.String"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> |
| <Annotation Term="OData.Description" String="The units of measure for this metric."/> |
| <Annotation Term="OData.LongDescription" String="This property shall specify the units of the metric. This property shall be consistent with the case-sensitive ('C/s' column) Unified Code for Units of Measure. Note: Not all units of measured are covered by UCUM."/> |
| </Property> |
| <Property Name="Implementation" Type="MetricDefinition.v1_0_0.ImplementationType"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> |
| <Annotation Term="OData.Description" String="The implementation of the metric."/> |
| <Annotation Term="OData.LongDescription" String="This property shall specify the implementation of the metric."/> |
| </Property> |
| <Property Name="Calculable" Type="MetricDefinition.v1_0_0.Calculable"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> |
| <Annotation Term="OData.Description" String="An indication of whether the metric can be used in a calculation."/> |
| <Annotation Term="OData.LongDescription" String="This property shall specify whether the metric can be used in a calculation."/> |
| </Property> |
| <Property Name="IsLinear" Type="Edm.Boolean"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> |
| <Annotation Term="OData.Description" String="An indication of whether the metric values are linear versus non-linear."/> |
| <Annotation Term="OData.LongDescription" String="This property shall indicate whether the metric values are linear versus non-linear. Linear metrics can use a greater than relation to compared them. An example of linear metrics include performance metrics. Examples of non-linear metrics include error codes."/> |
| </Property> |
| <Property Name="Wildcards" Type="Collection(MetricDefinition.v1_0_0.Wildcard)" Nullable="false"> |
| <Annotation Term="OData.Description" String="The wildcards and their substitution values for the entries in the MetricProperties array property."/> |
| <Annotation Term="OData.LongDescription" String="The property shall contain a list of wildcards and their replacement strings, which are applied to the MetricProperties array property. Each wildcard shall have a corresponding entry in this array property."/> |
| </Property> |
| <Property Name="MetricProperties" Type="Collection(Edm.String)"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> |
| <Annotation Term="OData.Description" String="The list of URIs with wildcards and property identifiers that this metric definition defines. If a URI has wildcards, the wildcards are substituted as specified in the Wildcards array property."/> |
| <Annotation Term="OData.LongDescription" String="This array property shall list the URIs with wildcards and property identifiers that this metric defines. 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 its wildcards, it shall identify a resource property to which the metric definition applies. The property identifiers portion of the URI shall follow RFC6901-defined JSON fragment notation rules."/> |
| <Annotation Term="OData.IsURL"/> |
| </Property> |
| |
| <Property Name="CalculationParameters" Type="Collection(MetricDefinition.v1_0_0.CalculationParamsType)"> |
| <Annotation Term="OData.Description" String="The metric properties that are part of the synthesis calculation. This property is present when the MetricType property is `Synthesized`."/> |
| <Annotation Term="OData.LongDescription" String="This property shall list the metric properties that are part of the synthesis calculation. When MetricType=Synthesis, this property can be present."/> |
| </Property> |
| |
| <Property Name="PhysicalContext" Type="PhysicalContext.PhysicalContext"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> |
| <Annotation Term="OData.Description" String="The physical context of the metric."/> |
| <Annotation Term="OData.LongDescription" String="This property shall contain the physical context of the metric."/> |
| </Property> |
| <Property Name="SensingInterval" Type="Edm.Duration"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> |
| <Annotation Term="OData.Description" String="The time interval between when a metric is updated."/> |
| <Annotation Term="OData.LongDescription" String="This property shall specify the time interval between when a metric is updated."/> |
| </Property> |
| <Property Name="DiscreteValues" Type="Collection(Edm.String)"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> |
| <Annotation Term="OData.Description" String="This array property specifies possible values of a discrete metric."/> |
| <Annotation Term="OData.LongDescription" String="The values of the property shall specify the possible values of the discrete metic. This property shall have values when the MetricType property is `Discrete`."/> |
| </Property> |
| |
| <Property Name="Precision" Type="Edm.Int64"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> |
| <Annotation Term="OData.Description" String="Number of significant digits in the metric reading."/> |
| <Annotation Term="OData.LongDescription" String="This property shall specify the number of significant digits in the metric reading. The property is not meaningful when the MetricType property is `Discrete`."/> |
| </Property> |
| <Property Name="Accuracy" Type="Edm.Decimal"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> |
| <Annotation Term="OData.Description" String="The estimated percent error of measured versus actual values."/> |
| <Annotation Term="OData.LongDescription" String="This property shall contain the percent error +/- of the measured versus actual values. The property is not meaningful when the MetricType property is `Discrete`."/> |
| </Property> |
| <Property Name="Calibration" Type="Edm.Decimal"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> |
| <Annotation Term="OData.Description" String="The calibration offset added to the metric reading."/> |
| <Annotation Term="OData.LongDescription" String="This property shall contain the calibration offset added to the metric reading. The value shall have the units specified in the Units property. The property is not meaningful when the MetricType property is `Discrete`."/> |
| </Property> |
| <Property Name="TimestampAccuracy" Type="Edm.Duration"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> |
| <Annotation Term="OData.Description" String="The accuracy of the timestamp."/> |
| <Annotation Term="OData.LongDescription" String="This property shall specify the expected + or - variability of the timestamp."/> |
| </Property> |
| <Property Name="MinReadingRange" Type="Edm.Decimal"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> |
| <Annotation Term="OData.Description" String="Minimum value for metric reading."/> |
| <Annotation Term="OData.LongDescription" String="This property shall contain the lowest possible value for the metric reading. The value shall have the units specified in the property Units. The property is not meaningful when the MetricType property is `Discrete`."/> |
| </Property> |
| <Property Name="MaxReadingRange" Type="Edm.Decimal"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> |
| <Annotation Term="OData.Description" String="Maximum value for metric reading."/> |
| <Annotation Term="OData.LongDescription" String="The value shall indicate the highest possible value for a related MetricValue. The value shall have the units specified in the property Units. The property is not meaningful when the MetricType property is `Discrete`."/> |
| </Property> |
| <Property Name="CalculationAlgorithm" Type="MetricDefinition.v1_0_0.CalculationAlgorithmEnum"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> |
| <Annotation Term="OData.Description" String="The calculation that is performed on a source metric to obtain the metric being defined."/> |
| <Annotation Term="OData.LongDescription" String="This property shall contain the calculation performed to obtain the metric."/> |
| </Property> |
| <Property Name="CalculationTimeInterval" Type="Edm.Duration"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> |
| <Annotation Term="OData.Description" String="The time interval over which the metric calculation is performed."/> |
| <Annotation Term="OData.LongDescription" String="This property shall specify the time interval over the metric calculation is performed."/> |
| </Property> |
| <Property Name="Actions" Type="MetricDefinition.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="CalculationParamsType"> |
| <Annotation Term="OData.AdditionalProperties" Bool="false"/> |
| <Annotation Term="OData.Description" String="The usage of the parameter in the calculation."/> |
| <Annotation Term="OData.LongDescription" String="The list element shall contain the usage of the parameter in the calculation. This property is present when the MetricType property is `Synthesized`."/> |
| <Property Name="SourceMetric" Type="Edm.String"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> |
| <Annotation Term="OData.Description" String="The metric property used as the input into the calculation."/> |
| <Annotation Term="OData.LongDescription" String="This property shall contain a link to a metric property used in a calcuation."/> |
| </Property> |
| <Property Name="ResultMetric" Type="Edm.String"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> |
| <Annotation Term="OData.Description" String="The link to a metric property that stores the result of the calculation."/> |
| <Annotation Term="OData.LongDescription" String="This property shall contain a link to a metric property that stores the result of the calcuation."/> |
| </Property> |
| </ComplexType> |
| |
| <ComplexType Name="Wildcard"> |
| <Annotation Term="OData.AdditionalProperties" Bool="false"/> |
| <Annotation Term="OData.Description" String="The wildcard and its substitution values."/> |
| <Annotation Term="OData.LongDescription" String="This property shall contain a wildcard and its substitution values."/> |
| <Property Name="Name" Type="Edm.String"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> |
| <Annotation Term="OData.Description" String="The string used as a wildcard."/> |
| <Annotation Term="OData.LongDescription" String="This property shall contain the string used as a wildcard."/> |
| </Property> |
| <Property Name="Values" Type="Collection(Edm.String)"> |
| <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> |
| <Annotation Term="OData.Description" String="An array of values to substitute for the wildcard."/> |
| <Annotation Term="OData.LongDescription" String="This property shall contain the list of values to substitute for the wildcard."/> |
| </Property> |
| </ComplexType> |
| |
| <EnumType Name="CalculationAlgorithmEnum"> |
| <Member Name="Average"> |
| <Annotation Term="OData.Description" String="The metric is calculated as the average metric reading over a sliding time interval."/> |
| <Annotation Term="OData.LongDescription" String="The metric shall be calculated as the average metric reading over a sliding time interval. The time interval shall contain the CalculationTimeInterval property value."/> |
| </Member> |
| <Member Name="Maximum"> |
| <Annotation Term="OData.Description" String="The metric is calculated as the maximum metric reading over during a time interval."/> |
| <Annotation Term="OData.LongDescription" String="The metric shall be calculated as the maximum metric reading over a sliding time interval. The time interval shall contain the CalculationTimeInterval property value."/> |
| </Member> |
| <Member Name="Minimum"> |
| <Annotation Term="OData.Description" String="The metric is calculated as the minimum metric reading over a sliding time interval."/> |
| <Annotation Term="OData.LongDescription" String="The metric shall be calculated as the minimum metric reading over a sliding time interval. The time interval shall contain the CalculationTimeInterval property value."/> |
| </Member> |
| </EnumType> |
| |
| <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="MetricDefinition.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="MetricDefinition.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="MetricDefinition" BaseType="MetricDefinition.v1_0_0.MetricDefinition"/> |
| </Schema> |
| |
| <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricDefinition.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 several properties to disallow them from being null."/> |
| <EntityType Name="MetricDefinition" BaseType="MetricDefinition.v1_0_1.MetricDefinition"/> |
| </Schema> |
| |
| <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricDefinition.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="MetricDefinition" BaseType="MetricDefinition.v1_0_2.MetricDefinition"/> |
| </Schema> |
| |
| <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricDefinition.v1_0_4"> |
| <Annotation Term="Redfish.OwningEntity" String="DMTF"/> |
| <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/> |
| <EntityType Name="MetricDefinition" BaseType="MetricDefinition.v1_0_3.MetricDefinition"/> |
| </Schema> |
| |
| </edmx:DataServices> |
| </edmx:Edmx> |