blob: 9ddf00ab3bd2765b49f31f692f232916035d33f2 [file] [log] [blame]
Ed Tanous530520e2019-01-02 13:41:37 -08001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
Gunnar Mills262d7d42021-01-20 16:28:41 -06004<!--# Redfish Schema: MetricReport v1.4.1 -->
Ed Tanous530520e2019-01-02 13:41:37 -08005<!--# -->
6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, -->
7<!--# available at http://www.dmtf.org/standards/redfish -->
Gunnar Millsa778c022020-05-12 12:20:36 -05008<!--# Copyright 2014-2020 DMTF. -->
Ed Tanous530520e2019-01-02 13:41:37 -08009<!--# 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">
Ed Tanouscb103132019-10-08 11:34:22 -070021 <edmx:Include Namespace="Resource"/>
Ed Tanous530520e2019-01-02 13:41:37 -080022 <edmx:Include Namespace="Resource.v1_0_0"/>
23 </edmx:Reference>
24 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
25 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
26 </edmx:Reference>
27 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/MetricReportDefinition_v1.xml">
28 <edmx:Include Namespace="MetricReportDefinition"/>
29 </edmx:Reference>
30 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/MetricDefinition_v1.xml">
31 <edmx:Include Namespace="MetricDefinition"/>
32 </edmx:Reference>
33
34 <edmx:DataServices>
35
36 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport">
37 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
38
39 <EntityType Name="MetricReport" BaseType="Resource.v1_0_0.Resource" Abstract="true">
Gunnar Mills262d7d42021-01-20 16:28:41 -060040 <Annotation Term="OData.Description" String="The MetricReport schema represents a set of collected metrics."/>
41 <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."/>
Ed Tanous530520e2019-01-02 13:41:37 -080042 <Annotation Term="Capabilities.InsertRestrictions">
43 <Record>
44 <PropertyValue Property="Insertable" Bool="false"/>
45 </Record>
46 </Annotation>
47 <Annotation Term="Capabilities.UpdateRestrictions">
48 <Record>
49 <PropertyValue Property="Updatable" Bool="false"/>
50 </Record>
51 </Annotation>
52 <Annotation Term="Capabilities.DeleteRestrictions">
53 <Record>
54 <PropertyValue Property="Deletable" Bool="true"/>
Ed Tanouscb103132019-10-08 11:34:22 -070055 <Annotation Term="OData.Description" String="Metric reports can be deleted."/>
Ed Tanous530520e2019-01-02 13:41:37 -080056 </Record>
57 </Annotation>
58 <Annotation Term="Redfish.Uris">
59 <Collection>
60 <String>/redfish/v1/TelemetryService/MetricReports/{MetricReportId}</String>
61 </Collection>
62 </Annotation>
63 </EntityType>
64 </Schema>
65
66 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_0_0">
67 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -060068 <Annotation Term="Redfish.Release" String="2018.2"/>
Ed Tanous530520e2019-01-02 13:41:37 -080069
70 <EntityType Name="MetricReport" BaseType="MetricReport.MetricReport">
71 <NavigationProperty Name="MetricReportDefinition" Type="MetricReportDefinition.MetricReportDefinition" Nullable="false">
72 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Gunnar Mills844b4152020-06-22 12:44:09 -050073 <Annotation Term="OData.Description" String="The link to the definition of this metric report."/>
74 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type MetricReportDefinition."/>
Ed Tanous530520e2019-01-02 13:41:37 -080075 <Annotation Term="OData.AutoExpandReferences"/>
76 </NavigationProperty>
77 <Property Name="ReportSequence" Type="Edm.String" Nullable="false">
78 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
79 <Annotation Term="OData.Description" String="The current sequence identifier for this metric report."/>
Gunnar Mills09b9d452020-02-11 13:27:39 -060080 <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."/>
81 <Annotation Term="Redfish.Revisions">
82 <Collection>
83 <Record>
84 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Deprecated"/>
85 <PropertyValue Property="Version" String="v1_3_0"/>
86 <PropertyValue Property="Description" String="This property has been deprecated due to specification changes with regards to Server-Sent Events."/>
87 </Record>
88 </Collection>
89 </Annotation>
Ed Tanous530520e2019-01-02 13:41:37 -080090 </Property>
Ed Tanouscb103132019-10-08 11:34:22 -070091 <Property Name="MetricValues" Type="Collection(MetricReport.v1_0_0.MetricValue)" Nullable="false">
Gunnar Mills844b4152020-06-22 12:44:09 -050092 <Annotation Term="OData.Description" String="An array of metric values for the metered items of this metric report."/>
93 <Annotation Term="OData.LongDescription" String="The values shall be metric values for this metric report."/>
Ed Tanous530520e2019-01-02 13:41:37 -080094 </Property>
95 <Property Name="Actions" Type="MetricReport.v1_0_0.Actions" Nullable="false">
Gunnar Mills844b4152020-06-22 12:44:09 -050096 <Annotation Term="OData.Description" String="The available actions for this resource."/>
97 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -080098 </Property>
99 </EntityType>
100
101 <ComplexType Name="MetricValue">
102 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500103 <Annotation Term="OData.Description" String="Properties that capture a metric value and other associated information."/>
104 <Annotation Term="OData.LongDescription" String="This type shall contain properties that capture a metric value and other associated information."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800105 <Property Name="MetricId" Type="Edm.String">
106 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
107 <Annotation Term="OData.Description" String="The metric definitions identifier for this metric."/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500108 <Annotation Term="OData.LongDescription" String="This property shall contain the same value as the Id property of the source metric within the associated metric definition."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800109 </Property>
110 <Property Name="MetricValue" Type="Edm.String">
111 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700112 <Annotation Term="OData.Description" String="The metric value, as a string."/>
113 <Annotation Term="OData.LongDescription" String="This property shall contain the metric value, as a string."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800114 </Property>
115 <Property Name="Timestamp" Type="Edm.DateTimeOffset">
116 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500117 <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."/>
118 <Annotation Term="OData.LongDescription" String="The value shall time when the metric value was obtained. Note that this value might be different from the time when this instance is created."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800119 </Property>
120 <Property Name="MetricProperty" Type="Edm.String">
121 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
122 <Annotation Term="OData.Description" String="The URI for the property from which this metric is derived."/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500123 <Annotation Term="OData.LongDescription" String="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."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800124 <Annotation Term="OData.IsURL"/>
125 </Property>
126 <NavigationProperty Name="MetricDefinition" Type="MetricDefinition.MetricDefinition" Nullable="false">
127 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500128 <Annotation Term="OData.Description" String="The link to the metric definition for this metric."/>
129 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type MetricDefinition that describes what this metric value captures."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800130 <Annotation Term="OData.AutoExpandReferences"/>
131 </NavigationProperty>
132 </ComplexType>
133
134 <ComplexType Name="Actions">
135 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500136 <Annotation Term="OData.Description" String="The available actions for this resource."/>
137 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800138 <Property Name="Oem" Type="MetricReport.v1_0_0.OemActions" Nullable="false">
Gunnar Mills844b4152020-06-22 12:44:09 -0500139 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
140 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800141 </Property>
142 </ComplexType>
143
144 <ComplexType Name="OemActions">
145 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500146 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
147 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800148 </ComplexType>
149 </Schema>
150
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600151 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_0_1">
152 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
153 <Annotation Term="OData.Description" String="This version was created to clarify descriptions of several properties."/>
154 <EntityType Name="MetricReport" BaseType="MetricReport.v1_0_0.MetricReport"/>
155 </Schema>
156
Ed Tanouscb103132019-10-08 11:34:22 -0700157 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_0_2">
158 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
159 <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."/>
160 <EntityType Name="MetricReport" BaseType="MetricReport.v1_0_1.MetricReport"/>
161 </Schema>
162
163 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_0_3">
164 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
165 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
166 <EntityType Name="MetricReport" BaseType="MetricReport.v1_0_2.MetricReport"/>
167 </Schema>
168
Gunnar Mills09b9d452020-02-11 13:27:39 -0600169 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_0_4">
170 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
171 <Annotation Term="OData.Description" String="This version was created to no longer make ReportSequence required."/>
172 <EntityType Name="MetricReport" BaseType="MetricReport.v1_0_3.MetricReport"/>
173 </Schema>
174
Gunnar Mills844b4152020-06-22 12:44:09 -0500175 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_0_5">
176 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
177 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
178 <EntityType Name="MetricReport" BaseType="MetricReport.v1_0_4.MetricReport"/>
179 </Schema>
180
Gunnar Mills262d7d42021-01-20 16:28:41 -0600181 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_0_6">
182 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
183 <Annotation Term="OData.Description" String="This version was created to clarify behavior for when a metric report is deleted."/>
184 <EntityType Name="MetricReport" BaseType="MetricReport.v1_0_5.MetricReport"/>
185 </Schema>
186
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600187 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_1_0">
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600188 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
189 <Annotation Term="Redfish.Release" String="2018.3"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500190 <Annotation Term="OData.Description" String="This version was created to add a Timestamp property for the metric report in its entirety."/>
191
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600192 <EntityType Name="MetricReport" BaseType="MetricReport.v1_0_1.MetricReport">
193 <Property Name="Timestamp" Type="Edm.DateTimeOffset">
194 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500195 <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."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700196 <Annotation Term="OData.LongDescription" String="This property shall contain the time when the metric report was generated."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600197 </Property>
198 </EntityType>
199 </Schema>
200
Ed Tanouscb103132019-10-08 11:34:22 -0700201 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_1_1">
202 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
203 <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."/>
204 <EntityType Name="MetricReport" BaseType="MetricReport.v1_1_0.MetricReport"/>
205 </Schema>
206
207 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_1_2">
208 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
209 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
210 <EntityType Name="MetricReport" BaseType="MetricReport.v1_1_1.MetricReport"/>
211 </Schema>
212
Gunnar Mills09b9d452020-02-11 13:27:39 -0600213 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_1_3">
214 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
215 <Annotation Term="OData.Description" String="This version was created to no longer make ReportSequence required."/>
216 <EntityType Name="MetricReport" BaseType="MetricReport.v1_1_2.MetricReport"/>
217 </Schema>
218
Gunnar Mills844b4152020-06-22 12:44:09 -0500219 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_1_4">
220 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
221 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
222 <EntityType Name="MetricReport" BaseType="MetricReport.v1_1_3.MetricReport"/>
223 </Schema>
224
Gunnar Mills262d7d42021-01-20 16:28:41 -0600225 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_1_5">
226 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
227 <Annotation Term="OData.Description" String="This version was created to clarify behavior for when a metric report is deleted."/>
228 <EntityType Name="MetricReport" BaseType="MetricReport.v1_1_4.MetricReport"/>
229 </Schema>
230
Ed Tanouscb103132019-10-08 11:34:22 -0700231 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_2_0">
232 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
233 <Annotation Term="Redfish.Release" String="2019.2"/>
234
235 <EntityType Name="MetricReport" BaseType="MetricReport.v1_1_2.MetricReport"/>
236
237 <ComplexType Name="MetricValue" BaseType="MetricReport.v1_0_0.MetricValue">
238 <Property Name="Oem" Type="Resource.Oem" Nullable="false">
239 <Annotation Term="OData.Description" String="The OEM extension property."/>
240 <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."/>
241 </Property>
242 </ComplexType>
243 </Schema>
244
Gunnar Mills09b9d452020-02-11 13:27:39 -0600245 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_2_1">
246 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
247 <Annotation Term="OData.Description" String="This version was created to no longer make ReportSequence required."/>
248 <EntityType Name="MetricReport" BaseType="MetricReport.v1_2_0.MetricReport"/>
249 </Schema>
250
Gunnar Mills844b4152020-06-22 12:44:09 -0500251 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_2_2">
252 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
253 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
254 <EntityType Name="MetricReport" BaseType="MetricReport.v1_2_1.MetricReport"/>
255 </Schema>
256
Gunnar Mills262d7d42021-01-20 16:28:41 -0600257 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_2_3">
258 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
259 <Annotation Term="OData.Description" String="This version was created to clarify behavior for when a metric report is deleted."/>
260 <EntityType Name="MetricReport" BaseType="MetricReport.v1_2_2.MetricReport"/>
261 </Schema>
262
Gunnar Mills09b9d452020-02-11 13:27:39 -0600263 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_3_0">
264 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
265 <Annotation Term="Redfish.Release" String="2019.4"/>
266 <Annotation Term="OData.Description" String="This version was created to deprecate ReportSequence."/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500267
Gunnar Mills09b9d452020-02-11 13:27:39 -0600268 <EntityType Name="MetricReport" BaseType="MetricReport.v1_2_1.MetricReport"/>
269 </Schema>
270
Gunnar Mills844b4152020-06-22 12:44:09 -0500271 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_3_1">
272 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
273 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
274 <EntityType Name="MetricReport" BaseType="MetricReport.v1_3_0.MetricReport"/>
275 </Schema>
276
Gunnar Mills262d7d42021-01-20 16:28:41 -0600277 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_3_2">
278 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
279 <Annotation Term="OData.Description" String="This version was created to clarify behavior for when a metric report is deleted."/>
280 <EntityType Name="MetricReport" BaseType="MetricReport.v1_3_1.MetricReport"/>
281 </Schema>
282
Gunnar Mills844b4152020-06-22 12:44:09 -0500283 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_4_0">
284 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
285 <Annotation Term="Redfish.Release" String="2020.2"/>
286
287 <EntityType Name="MetricReport" BaseType="MetricReport.v1_3_1.MetricReport">
288 <Property Name="Context" Type="Edm.String" Nullable="false">
289 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
290 <Annotation Term="OData.Description" String="A context can be supplied at subscription time. This property is the context value supplied by the subscriber."/>
291 <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."/>
292 </Property>
293 </EntityType>
294 </Schema>
295
Gunnar Mills262d7d42021-01-20 16:28:41 -0600296 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReport.v1_4_1">
297 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
298 <Annotation Term="OData.Description" String="This version was created to clarify behavior for when a metric report is deleted."/>
299 <EntityType Name="MetricReport" BaseType="MetricReport.v1_4_0.MetricReport"/>
300 </Schema>
301
Ed Tanous530520e2019-01-02 13:41:37 -0800302 </edmx:DataServices>
303</edmx:Edmx>