blob: 51af5d3ab13bce79651a5a93ad89a0c6394a8226 [file] [log] [blame]
Ed Tanous530520e2019-01-02 13:41:37 -08001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
4<!--# Redfish Schema: MetricReport v1.0.0-->
5<!--# -->
6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, -->
7<!--# available at http://www.dmtf.org/standards/redfish -->
8<!--# Copyright 2014-2018 DMTF. -->
9<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
10<!--################################################################################ -->
11<!---->
12<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
13
14 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
15 <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
16 </edmx:Reference>
17 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
18 <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
19 </edmx:Reference>
20 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
21 <edmx:Include Namespace="Resource.v1_0_0"/>
22 </edmx:Reference>
23 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
24 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
25 </edmx:Reference>
26 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/MetricReportDefinition_v1.xml">
27 <edmx:Include Namespace="MetricReportDefinition"/>
28 </edmx:Reference>
29 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/MetricDefinition_v1.xml">
30 <edmx:Include Namespace="MetricDefinition"/>
31 </edmx:Reference>
32
33 <edmx:DataServices>
34
35 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport">
36 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
37
38 <EntityType Name="MetricReport" BaseType="Resource.v1_0_0.Resource" Abstract="true">
39 <Annotation Term="OData.Description" String="The metric definitions used to create a metric report."/>
40 <Annotation Term="OData.LongDescription" String="The value shall be reference to the definition for this metric report."/>
41 <Annotation Term="Capabilities.InsertRestrictions">
42 <Record>
43 <PropertyValue Property="Insertable" Bool="false"/>
44 </Record>
45 </Annotation>
46 <Annotation Term="Capabilities.UpdateRestrictions">
47 <Record>
48 <PropertyValue Property="Updatable" Bool="false"/>
49 </Record>
50 </Annotation>
51 <Annotation Term="Capabilities.DeleteRestrictions">
52 <Record>
53 <PropertyValue Property="Deletable" Bool="true"/>
54 </Record>
55 </Annotation>
56 <Annotation Term="Redfish.Uris">
57 <Collection>
58 <String>/redfish/v1/TelemetryService/MetricReports/{MetricReportId}</String>
59 </Collection>
60 </Annotation>
61 </EntityType>
62 </Schema>
63
64 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_0_0">
65 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
66
67 <EntityType Name="MetricReport" BaseType="MetricReport.MetricReport">
68 <NavigationProperty Name="MetricReportDefinition" Type="MetricReportDefinition.MetricReportDefinition" Nullable="false">
69 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
70 <Annotation Term="OData.Description" String="The metric definitions used to create a metric report."/>
71 <Annotation Term="OData.LongDescription" String="The value shall be reference to the definition for this metric report."/>
72 <Annotation Term="OData.AutoExpandReferences"/>
73 </NavigationProperty>
74 <Property Name="ReportSequence" Type="Edm.String" Nullable="false">
75 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
76 <Annotation Term="OData.Description" String="The current sequence identifier for this metric report."/>
77 <Annotation Term="OData.LongDescription" String="The value shall be the current sequence identifier for this metric report."/>
78 <Annotation Term="Redfish.Required"/>
79 </Property>
80 <Property Name="MetricValues" Type="Collection(MetricReport.v1_0_0.MetricValue)">
81 <Annotation Term="OData.Description" String="An array of metric values for the metered items of this Metric."/>
82 <Annotation Term="OData.LongDescription" String="The values shall be metric values for this MetricReport."/>
83 </Property>
84 <Property Name="Actions" Type="MetricReport.v1_0_0.Actions" Nullable="false">
85 <Annotation Term="OData.Description" String="The available actions for this resource."/>
86 <Annotation Term="OData.LongDescription" String="The Actions property shall contain the available actions for this resource."/>
87 </Property>
88 </EntityType>
89
90 <ComplexType Name="MetricValue">
91 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
92 <Annotation Term="OData.Description" String="A metric Value."/>
93 <Annotation Term="OData.LongDescription" String="A metric value in the context of a Metric."/>
94 <Property Name="MetricId" Type="Edm.String">
95 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
96 <Annotation Term="OData.Description" String="The metric definitions identifier for this metric."/>
97 <Annotation Term="OData.LongDescription" String="The value shall be the same as the Id property of the source metric within the associated MetricDefinition."/>
98 </Property>
99 <Property Name="MetricValue" Type="Edm.String">
100 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
101 <Annotation Term="OData.Description" String="The value identifies this resource."/>
102 <Annotation Term="OData.LongDescription" String="The value of the metric represented as a string."/>
103 </Property>
104 <Property Name="Timestamp" Type="Edm.DateTimeOffset">
105 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
106 <Annotation Term="OData.Description" String="The time when the value of the metric is obtained."/>
107 <Annotation Term="OData.LongDescription" String="The value shall time when the metric value was obtained. Note that this may be different from the time when this instance is created. If Volatile is true for a given metric value instance, the Timestamp changes whenever a new measurement snapshot is taken. A management application may establish a time series of metric data by retrieving the instances of metric value and sorting them according to their Timestamp."/>
108 </Property>
109 <Property Name="MetricProperty" Type="Edm.String">
110 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
111 <Annotation Term="OData.Description" String="The URI for the property from which this metric is derived."/>
112 <Annotation Term="OData.LongDescription" String="The value shall be URI to the a property following the JSON fragment notation, as defined by RFC6901, to identify an individual property in a Redfish resource."/>
113 <Annotation Term="OData.IsURL"/>
114 </Property>
115 <NavigationProperty Name="MetricDefinition" Type="MetricDefinition.MetricDefinition" Nullable="false">
116 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
117 <Annotation Term="OData.Description" String="A link to the Metric Definition."/>
118 <Annotation Term="OData.LongDescription" String="The value shall be reference to the Metric Definition resource that describes what this Metric Report is capturing."/>
119 <Annotation Term="OData.AutoExpandReferences"/>
120 </NavigationProperty>
121 </ComplexType>
122
123 <ComplexType Name="Actions">
124 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
125 <Annotation Term="OData.Description" String="The available actions for this resource."/>
126 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
127 <Property Name="Oem" Type="MetricReport.v1_0_0.OemActions" Nullable="false">
128 <Annotation Term="OData.Description" String="This property contains the available OEM specific actions for this resource."/>
129 <Annotation Term="OData.LongDescription" String="This property shall contain any additional OEM actions for this resource."/>
130 </Property>
131 </ComplexType>
132
133 <ComplexType Name="OemActions">
134 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
135 <Annotation Term="OData.Description" String="The available OEM specific actions for this resource."/>
136 <Annotation Term="OData.LongDescription" String="This type shall contain any additional OEM actions for this resource."/>
137 </ComplexType>
138 </Schema>
139
140 </edmx:DataServices>
141</edmx:Edmx>