blob: 7f5b139c4e114b1d21ad683864b23f2fe3455ea2 [file] [log] [blame]
Ed Tanous530520e2019-01-02 13:41:37 -08001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -05004<!--# Redfish Schema: MetricReportDefinition v1.3.3 -->
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">
21 <edmx:Include Namespace="Resource"/>
22 <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:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
27 </edmx:Reference>
28 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/MetricReport_v1.xml">
29 <edmx:Include Namespace="MetricReport"/>
30 </edmx:Reference>
31 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Schedule_v1.xml">
32 <edmx:Include Namespace="Schedule"/>
33 </edmx:Reference>
Ed Tanouscb103132019-10-08 11:34:22 -070034 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Triggers_v1.xml">
35 <edmx:Include Namespace="Triggers"/>
36 </edmx:Reference>
Ed Tanous530520e2019-01-02 13:41:37 -080037
38 <edmx:DataServices>
39
40 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition">
41 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
42
43 <EntityType Name="MetricReportDefinition" BaseType="Resource.v1_0_0.Resource" Abstract="true">
Ed Tanouscb103132019-10-08 11:34:22 -070044 <Annotation Term="OData.Description" String="The MetricReportDefinition schema describes set of metrics that are collected into a metric report."/>
Gunnar Mills844b4152020-06-22 12:44:09 -050045 <Annotation Term="OData.LongDescription" String="This resource shall specify a set of metrics that shall be collected into a metric report in a Redfish implementation."/>
Ed Tanous530520e2019-01-02 13:41:37 -080046 <Annotation Term="Capabilities.InsertRestrictions">
47 <Record>
48 <PropertyValue Property="Insertable" Bool="false"/>
49 </Record>
50 </Annotation>
51 <Annotation Term="Capabilities.UpdateRestrictions">
52 <Record>
53 <PropertyValue Property="Updatable" Bool="true"/>
Ed Tanouscb103132019-10-08 11:34:22 -070054 <Annotation Term="OData.Description" String="Any writable properties can be updated for metric report definitions."/>
Ed Tanous530520e2019-01-02 13:41:37 -080055 </Record>
56 </Annotation>
57 <Annotation Term="Capabilities.DeleteRestrictions">
58 <Record>
59 <PropertyValue Property="Deletable" Bool="true"/>
Ed Tanouscb103132019-10-08 11:34:22 -070060 <Annotation Term="OData.Description" String="Metric report definitions can be deleted."/>
Ed Tanous530520e2019-01-02 13:41:37 -080061 </Record>
62 </Annotation>
63 <Annotation Term="Redfish.Uris">
64 <Collection>
65 <String>/redfish/v1/TelemetryService/MetricReportDefinitions/{MetricReportDefinitionId}</String>
66 </Collection>
67 </Annotation>
68 </EntityType>
69 </Schema>
70
71 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_0_0">
72 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -060073 <Annotation Term="Redfish.Release" String="2018.2"/>
Ed Tanous530520e2019-01-02 13:41:37 -080074
75 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.MetricReportDefinition">
76 <Property Name="MetricReportDefinitionType" Type="MetricReportDefinition.v1_0_0.MetricReportDefinitionType">
77 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
78 <Annotation Term="OData.Description" String="Specifies when the metric report is generated."/>
Ed Tanouscb103132019-10-08 11:34:22 -070079 <Annotation Term="OData.LongDescription" String="This property shall specify when the metric report is generated. If the value is `Periodic`, the Schedule property shall be present."/>
Ed Tanous530520e2019-01-02 13:41:37 -080080 </Property>
81 <Property Name="Schedule" Type="Schedule.Schedule" Nullable="false">
Ed Tanouscb103132019-10-08 11:34:22 -070082 <Annotation Term="OData.Description" String="The schedule for generating the metric report."/>
Gunnar Millsa778c022020-05-12 12:20:36 -050083 <Annotation Term="OData.LongDescription" String="This property shall contain the schedule of the metric report. The metric report shall be generated at an interval specified by the RecurrenceInterval property within Schedule. If MaxOccurrences property within Schedule is specified, the metric report shall no longer be generated after the specified number of occurrences. The State property within Status should be set to `Disabled` and the MetricReportDefinitionEnabled property should be set to `false` when the specified number of occurrences is reached."/>
Ed Tanous530520e2019-01-02 13:41:37 -080084 </Property>
85 <Property Name="ReportActions" Type="Collection(MetricReportDefinition.v1_0_0.ReportActionsEnum)" Nullable="false">
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -050086 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -070087 <Annotation Term="OData.Description" String="The set of actions to perform when a metric report is generated."/>
Gunnar Millsa778c022020-05-12 12:20:36 -050088 <Annotation Term="OData.LongDescription" String="This property shall contain the set of actions to perform when the metric report is generated. This property should be ignored if MetricReportDefinitionType contains the value `OnRequest`."/>
Ed Tanous530520e2019-01-02 13:41:37 -080089 </Property>
90 <Property Name="ReportUpdates" Type="MetricReportDefinition.v1_0_0.ReportUpdatesEnum" Nullable="false">
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -050091 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Gunnar Millsa778c022020-05-12 12:20:36 -050092 <Annotation Term="OData.Description" String="The behavior for how subsequent metric reports are handled in relationship to an existing metric report created from the metric report definition. Namely, whether to overwrite, append, or create a report resource."/>
93 <Annotation Term="OData.LongDescription" String="This property shall contain the behavior for how subsequent metric reports are handled in relationship to an existing metric report created from the metric report definition. This property should be ignored if MetricReportDefinitionType contains the value `OnRequest`."/>
Ed Tanous530520e2019-01-02 13:41:37 -080094 </Property>
95 <Property Name="AppendLimit" Type="Edm.Int64" Nullable="false">
96 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -070097 <Annotation Term="OData.Description" String="The maximum number of entries that can be appended to a metric report. When the metric report reaches its limit, its behavior is dictated by the ReportUpdates property."/>
98 <Annotation Term="OData.LongDescription" String="This property shall contain a number that indicates the maximum number of entries that can be appended to a metric report. When the metric report reaches its limit, its behavior shall be dictated by the ReportUpdates property. This property shall be required if ReportUpdates is either AppendWrapsWhenFull or AppendStopsWhenFull."/>
Ed Tanous530520e2019-01-02 13:41:37 -080099 <Annotation Term="Validation.Minimum" Int="0"/>
100 </Property>
101 <Property Name="Status" Type="Resource.Status" Nullable="false">
Gunnar Millsa778c022020-05-12 12:20:36 -0500102 <Annotation Term="OData.Description" String="The status and health of the resource and its subordinate or dependent resources."/>
103 <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800104 </Property>
Ed Tanouscb103132019-10-08 11:34:22 -0700105 <Property Name="Wildcards" Type="Collection(MetricReportDefinition.v1_0_0.Wildcard)" Nullable="false">
106 <Annotation Term="OData.Description" String="The set of wildcards and their substitution values for the entries in the MetricProperties property."/>
107 <Annotation Term="OData.LongDescription" String="The property shall contain a set of wildcards and their replacement strings, which are applied to the MetricProperties property. Each wildcard expressed in the MetricProperties property shall have a corresponding entry in this property."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800108 </Property>
109 <Property Name="MetricProperties" Type="Collection(Edm.String)">
110 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700111 <Annotation Term="OData.Description" String="The list of URIs with wildcards and property identifiers to include in the metric report. If a URI has wildcards, the wildcards are substituted as specified in the Wildcards property."/>
Gunnar Millsa778c022020-05-12 12:20:36 -0500112 <Annotation Term="OData.LongDescription" String="This property shall contain a list of URIs with wildcards and property identifiers to include in the metric report. 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 each wildcard, it shall describe a resource property to include in the metric report. The property identifiers portion of the URI shall follow RFC6901-specified JSON fragment notation rules."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800113 <Annotation Term="OData.IsURL"/>
114 </Property>
Ed Tanouscb103132019-10-08 11:34:22 -0700115 <Property Name="Metrics" Type="Collection(MetricReportDefinition.v1_0_0.Metric)" Nullable="false">
Gunnar Mills844b4152020-06-22 12:44:09 -0500116 <Annotation Term="OData.Description" String="The list of metrics to include in the metric report. The metrics might include metric properties or calculations applied to a metric property."/>
117 <Annotation Term="OData.LongDescription" String="The property shall contain a list of metrics to include in the metric report. The metrics might include metric properties or calculations that are applied to a metric property."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800118 </Property>
119 <NavigationProperty Name="MetricReport" Type="MetricReport.MetricReport" Nullable="false">
120 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700121 <Annotation Term="OData.Description" String="The location where the resultant metric report is placed."/>
Gunnar Millsa778c022020-05-12 12:20:36 -0500122 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type MetricReport where the resultant metric report is placed."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800123 <Annotation Term="OData.AutoExpandReferences"/>
124 </NavigationProperty>
125
126 <Property Name="Actions" Type="MetricReportDefinition.v1_0_0.Actions" Nullable="false">
Gunnar Millsa778c022020-05-12 12:20:36 -0500127 <Annotation Term="OData.Description" String="The available actions for this resource."/>
128 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800129 </Property>
130 </EntityType>
131
132 <ComplexType Name="Wildcard">
133 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700134 <Annotation Term="OData.Description" String="The wildcard and its substitution values."/>
135 <Annotation Term="OData.LongDescription" String="This type shall contain a wildcard and its substitution values."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800136 <Property Name="Name" Type="Edm.String">
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500137 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600138 <Annotation Term="OData.Description" String="The string used as a wildcard."/>
139 <Annotation Term="OData.LongDescription" String="This property shall contain the string used as a wildcard."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800140 </Property>
141 <Property Name="Keys" Type="Collection(Edm.String)">
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500142 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600143 <Annotation Term="OData.Description" String="An array of values to substitute for the wildcard."/>
144 <Annotation Term="OData.LongDescription" String="This property shall contain the list of values to substitute for the wildcard."/>
145 <Annotation Term="Redfish.Revisions">
146 <Collection>
147 <Record>
148 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Deprecated"/>
149 <PropertyValue Property="Version" String="v1_1_0"/>
Gunnar Millsa778c022020-05-12 12:20:36 -0500150 <PropertyValue Property="Description" String="This property has been deprecated in favor of using the property Values."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600151 </Record>
152 </Collection>
153 </Annotation>
Ed Tanous530520e2019-01-02 13:41:37 -0800154 </Property>
155 </ComplexType>
156
157 <ComplexType Name="Metric">
158 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700159 <Annotation Term="OData.Description" String="Specifies a metric to include in the metric report. The metrics are derived by applying a calculation on each of the listed metric properties."/>
Gunnar Millsa778c022020-05-12 12:20:36 -0500160 <Annotation Term="OData.LongDescription" String="The properties shall specify a metric to include in the metric report. The metrics shall be derived by applying the algorithm specified in the CollectionFunction property to each of the metric properties listed in the MetricProperties property."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800161
162 <Property Name="MetricId" Type="Edm.String">
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500163 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700164 <Annotation Term="OData.Description" String="The label for the metric definition that is derived by applying the collectionFunction to the metric property. It matches the Id property of the corresponding metric definition."/>
Gunnar Millsa778c022020-05-12 12:20:36 -0500165 <Annotation Term="OData.LongDescription" String="This property shall specify the label for the metric definition that is derived by applying the algorithm specified in the CollectionFunction property to the metric property. This property shall match the Id property of the corresponding metric definition."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800166 </Property>
167 <Property Name="MetricProperties" Type="Collection(Edm.String)">
168 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700169 <Annotation Term="OData.Description" String="The set of URIs for the properties on which this metric is collected."/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500170 <Annotation Term="OData.LongDescription" String="Each value can contain one or more wildcard names enclosed in curly braces. Wildcard value entries shall be substituted for each Wildcard name found. If two or more wild names are found, the same wildcard index is used for each in one substitution pass. After substituting the wildcard values entries, each value shall contain a URI for a property in a resource that matches a property declaration in the corresponding metric definition."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800171 <Annotation Term="OData.IsURL"/>
172 </Property>
173 <Property Name="CollectionFunction" Type="MetricReportDefinition.v1_0_0.CalculationAlgorithmEnum">
174 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Gunnar Millsa778c022020-05-12 12:20:36 -0500175 <Annotation Term="OData.Description" String="Specifies the function to perform on each of the metric properties listed in the MetricProperties property."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800176 <Annotation Term="OData.LongDescription" String="The property shall specify the function to perform on each of the metric properties listed in the MetricProperties property."/>
177 </Property>
178 <Property Name="CollectionDuration" Type="Edm.Duration">
179 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700180 <Annotation Term="OData.Description" String="The duration over which the function is computed."/>
Gunnar Millsa778c022020-05-12 12:20:36 -0500181 <Annotation Term="OData.LongDescription" String="This property shall specify the duration over which the function is computed."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800182 </Property>
183 <Property Name="CollectionTimeScope" Type="MetricReportDefinition.v1_0_0.CollectionTimeScope">
184 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Gunnar Millsa778c022020-05-12 12:20:36 -0500185 <Annotation Term="OData.Description" String="The scope of time over which the function is applied."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700186 <Annotation Term="OData.LongDescription" String="This property shall specify the scope of time over which the function is applied."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800187 </Property>
188 </ComplexType>
189
190 <EnumType Name="MetricReportDefinitionType">
191 <Annotation Term="OData.Description" String="Indicates when the metric report is generated."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700192 <Annotation Term="OData.LongDescription" String="This type shall specify when the metric report is generated."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800193 <Member Name="Periodic">
194 <Annotation Term="OData.Description" String="The metric report is generated at a periodic time interval, specified in the Schedule property."/>
195 </Member>
196 <Member Name="OnChange">
197 <Annotation Term="OData.Description" String="The metric report is generated when any of the metric values change."/>
198 </Member>
199 <Member Name="OnRequest">
200 <Annotation Term="OData.Description" String="The metric report is generated when a HTTP GET is performed on the specified metric report."/>
201 </Member>
202 </EnumType>
203
204 <EnumType Name="ReportActionsEnum">
205 <Annotation Term="OData.Description" String="Actions to perform when a metric report is generated."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700206 <Annotation Term="OData.LongDescription" String="This type shall specify the actions to perform when a metric report is generated."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800207 <Member Name="LogToMetricReportsCollection">
Gunnar Millsa778c022020-05-12 12:20:36 -0500208 <Annotation Term="OData.Description" String="Record the occurrence to the metric report collection."/>
209 <Annotation Term="OData.LongDescription" String="This value shall indicate the service records the occurrence to the metric report collection found under the telemetry service. The service shall update the metric report based on the setting of the ReportUpdates property."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800210 </Member>
211 <Member Name="RedfishEvent">
Gunnar Millsa778c022020-05-12 12:20:36 -0500212 <Annotation Term="OData.Description" String="Send a Redfish event message containing the metric report."/>
213 <Annotation Term="OData.LongDescription" String="This value shall indicate the service sends a Redfish event of type MetricReport to subscribers in the event subscription collection of the event service."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800214 </Member>
215 </EnumType>
216
217 <EnumType Name="ReportUpdatesEnum">
Ed Tanouscb103132019-10-08 11:34:22 -0700218 <Annotation Term="OData.Description" String="Handling of subsequent metric reports when a metric report exists."/>
Gunnar Millsa778c022020-05-12 12:20:36 -0500219 <Annotation Term="OData.LongDescription" String="This type shall indicate how the service handles subsequent metric reports when a metric report exists."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800220 <Member Name="Overwrite">
Gunnar Millsa778c022020-05-12 12:20:36 -0500221 <Annotation Term="OData.Description" String="Overwrite the metric report."/>
222 <Annotation Term="OData.LongDescription" String="This value shall indicate the service overwrites the metric report referenced by the MetricReport property."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800223 </Member>
224 <Member Name="AppendWrapsWhenFull">
Gunnar Millsa778c022020-05-12 12:20:36 -0500225 <Annotation Term="OData.Description" String="New information is appended to the metric report. The metric report entries are overwritten with new entries when the metric report has reached its maximum capacity."/>
226 <Annotation Term="OData.LongDescription" String="This value shall indicate the service appends new information to the metric report referenced by the MetricReport property. The service shall overwrite entries in the metric report with new entries when the metric report has reached its maximum capacity."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800227 </Member>
228 <Member Name="AppendStopsWhenFull">
Gunnar Millsa778c022020-05-12 12:20:36 -0500229 <Annotation Term="OData.Description" String="New information is appended to the metric report. The service stops adding entries when the metric report has reached its maximum capacity."/>
230 <Annotation Term="OData.LongDescription" String="This value shall indicate the service appends new information to the metric report referenced by the MetricReport property. The service shall stop adding entries when the metric report has reached its maximum capacity. The State property within Status should be set to `Disabled` and the MetricReportDefinitionEnabled property should be set to `false` when the append limit is reached."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800231 </Member>
232 <Member Name="NewReport">
Gunnar Millsa778c022020-05-12 12:20:36 -0500233 <Annotation Term="OData.Description" String="A new metric report is created, whose resource name is the metric report resource name concatenated with the timestamp."/>
234 <Annotation Term="OData.LongDescription" String="This value shall indicate the service creates a new metric report resource, whose resource name is the metric report resource name concatenated with the timestamp."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800235 </Member>
236 </EnumType>
237
238 <EnumType Name="CalculationAlgorithmEnum">
Ed Tanouscb103132019-10-08 11:34:22 -0700239 <Annotation Term="OData.Description" String="The function to apply to the list of metric properties."/>
240 <Annotation Term="OData.LongDescription" String="This type shall specify the function to apply to the list of metric properties."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800241 <Member Name="Average">
Ed Tanouscb103132019-10-08 11:34:22 -0700242 <Annotation Term="OData.Description" String="The metric is calculated as the average metric reading over a duration."/>
Gunnar Millsa778c022020-05-12 12:20:36 -0500243 <Annotation Term="OData.LongDescription" String="This value shall indicate the metric is calculated as the average metric reading over a duration. The duration shall be the CollectionDuration property value."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800244 </Member>
245 <Member Name="Maximum">
Ed Tanouscb103132019-10-08 11:34:22 -0700246 <Annotation Term="OData.Description" String="The metric is calculated as the maximum metric reading over a duration."/>
Gunnar Millsa778c022020-05-12 12:20:36 -0500247 <Annotation Term="OData.LongDescription" String="This value shall indicate the metric is calculated as the maximum metric reading over a duration. The duration shall be the CollectionDuration property value."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800248 </Member>
249 <Member Name="Minimum">
Ed Tanouscb103132019-10-08 11:34:22 -0700250 <Annotation Term="OData.Description" String="The metric is calculated as the minimum metric reading over a duration."/>
Gunnar Millsa778c022020-05-12 12:20:36 -0500251 <Annotation Term="OData.LongDescription" String="This value shall indicate the metric is calculated as the minimum metric reading over a duration. The duration shall be the CollectionDuration property value."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800252 </Member>
253 <Member Name="Summation">
Ed Tanouscb103132019-10-08 11:34:22 -0700254 <Annotation Term="OData.Description" String="The metric is calculated as the sum of the values over a duration."/>
Gunnar Millsa778c022020-05-12 12:20:36 -0500255 <Annotation Term="OData.LongDescription" String="This value shall indicate the metric is calculated as the sum of the specified metric reading over a duration. The duration shall be the CollectionDuration property value."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800256 </Member>
257 </EnumType>
258
259 <EnumType Name="CollectionTimeScope">
260 <Annotation Term="OData.Description" String="The time scope of the related metric values."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700261 <Annotation Term="OData.LongDescription" String="This type shall specify the time scope of the corresponding metric values."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800262 <Member Name="Point">
Gunnar Millsa778c022020-05-12 12:20:36 -0500263 <Annotation Term="OData.Description" String="The corresponding metric values apply to a point in time. On the corresponding metric value instances, the Timestamp property value in the metric report specifies the point in time."/>
264 <Annotation Term="OData.LongDescription" String="This value shall indicate the corresponding metric values apply to a point in time. On the corresponding metric value instances, the Timestamp property value in the metric report shall specify the point in time."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800265 </Member>
266 <Member Name="Interval">
Gunnar Millsa778c022020-05-12 12:20:36 -0500267 <Annotation Term="OData.Description" String="The corresponding metric values apply to a time interval. On the corresponding metric value instances, the Timestamp property value in the metric report specifies the end of the time interval and the CollectionDuration property specifies its duration."/>
268 <Annotation Term="OData.LongDescription" String="This value shall indicate the corresponding metric values apply to a time interval. On the corresponding metric value instances, the Timestamp property value in the metric report shall specify the end of the time interval and the CollectionDuration property shall specify its duration."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800269 </Member>
270 <Member Name="StartupInterval">
Gunnar Millsa778c022020-05-12 12:20:36 -0500271 <Annotation Term="OData.Description" String="The corresponding metric values apply to a time interval that began at the startup of the measured resource. On the corresponding metric value instances, the Timestamp property value in the metric report shall specifies the end of the time interval. The CollectionDuration property value specifies the duration between the startup of resource and timestamp."/>
272 <Annotation Term="OData.LongDescription" String="This value shall indicate the corresponding metric values apply to a time interval that began at the startup of the measured resource. On the corresponding metric value instances, the Timestamp property value in the metric report shall specify the end of the time interval. The CollectionDuration property value shall specify the duration between the startup of resource and timestamp."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800273 </Member>
274 </EnumType>
275
276 <ComplexType Name="Actions">
277 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
Gunnar Millsa778c022020-05-12 12:20:36 -0500278 <Annotation Term="OData.Description" String="The available actions for this resource."/>
279 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800280 <Property Name="Oem" Type="MetricReportDefinition.v1_0_0.OemActions" Nullable="false">
Gunnar Millsa778c022020-05-12 12:20:36 -0500281 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
282 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800283 </Property>
284 </ComplexType>
285
286 <ComplexType Name="OemActions">
287 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
Gunnar Millsa778c022020-05-12 12:20:36 -0500288 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
289 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800290 </ComplexType>
291 </Schema>
292
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600293 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_0_1">
294 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
295 <Annotation Term="OData.Description" String="This version was created to clarify descriptions of several properties."/>
296 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.v1_0_0.MetricReportDefinition"/>
297 </Schema>
298
Ed Tanouscb103132019-10-08 11:34:22 -0700299 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_0_2">
300 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
301 <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."/>
302 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.v1_0_1.MetricReportDefinition"/>
303 </Schema>
304
305 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_0_3">
306 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
307 <Annotation Term="OData.Description" String="This version was created to correct descriptions in the CalculationAlgorithmEnum enum. It was also created to update descriptions that this schema defines."/>
308 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.v1_0_2.MetricReportDefinition"/>
309 </Schema>
310
Gunnar Millsa778c022020-05-12 12:20:36 -0500311 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_0_4">
312 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
313 <Annotation Term="OData.Description" String="This version was created to clarify the behavior of `OnRequest` metric report definitions with regards to ReportUpdates and ReportActions. It was also created to clarify the behavior when a metric report definition stops updating a metric report."/>
314 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.v1_0_3.MetricReportDefinition"/>
315 </Schema>
316
Gunnar Mills844b4152020-06-22 12:44:09 -0500317 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_0_5">
318 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
319 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
320 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.v1_0_4.MetricReportDefinition"/>
321 </Schema>
322
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500323 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_0_6">
324 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
325 <Annotation Term="OData.Description" String="This version was created to mark ReportActions, ReportUpdates, MetricId, and properties in Wildcards as writable."/>
326 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.v1_0_5.MetricReportDefinition"/>
327 </Schema>
328
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600329 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_1_0">
330 <Annotation Term="OData.Description" String="This version was created to add the Values property to the Wildcard property."/>
331 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
332 <Annotation Term="Redfish.Release" String="2018.3"/>
333 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.v1_0_1.MetricReportDefinition"/>
334 <ComplexType Name="Wildcard" BaseType="MetricReportDefinition.v1_0_0.Wildcard">
335 <Property Name="Values" Type="Collection(Edm.String)">
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500336 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600337 <Annotation Term="OData.Description" String="An array of values to substitute for the wildcard."/>
338 <Annotation Term="OData.LongDescription" String="This property shall contain the list of values to substitute for the wildcard."/>
339 </Property>
340 </ComplexType>
341 </Schema>
342
Ed Tanouscb103132019-10-08 11:34:22 -0700343 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_1_1">
344 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
345 <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."/>
346 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.v1_1_0.MetricReportDefinition"/>
347 </Schema>
348
349 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_1_2">
350 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
351 <Annotation Term="OData.Description" String="This version was created to correct descriptions in the CalculationAlgorithmEnum enum. It was also created to update descriptions that this schema defines."/>
352 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.v1_1_1.MetricReportDefinition"/>
353 </Schema>
354
Gunnar Millsa778c022020-05-12 12:20:36 -0500355 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_1_3">
356 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
357 <Annotation Term="OData.Description" String="This version was created to clarify the behavior of `OnRequest` metric report definitions with regards to ReportUpdates and ReportActions. It was also created to clarify the behavior when a metric report definition stops updating a metric report."/>
358 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.v1_1_2.MetricReportDefinition"/>
359 </Schema>
360
Gunnar Mills844b4152020-06-22 12:44:09 -0500361 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_1_4">
362 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
363 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
364 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.v1_1_3.MetricReportDefinition"/>
365 </Schema>
366
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500367 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_1_5">
368 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
369 <Annotation Term="OData.Description" String="This version was created to mark ReportActions, ReportUpdates, MetricId, and properties in Wildcards as writable."/>
370 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.v1_1_4.MetricReportDefinition"/>
371 </Schema>
372
Ed Tanouscb103132019-10-08 11:34:22 -0700373 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_2_0">
374 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
375 <Annotation Term="Redfish.Release" String="2019.1"/>
376
377 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.v1_1_1.MetricReportDefinition">
378 <Property Name="SuppressRepeatedMetricValue" Type="Edm.Boolean">
379 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500380 <Annotation Term="OData.Description" String="An indication of whether any metrics are suppressed from the generated metric report. If `true`, any metric that equals the same value in the previously generated metric report is suppressed from the current report. Also, duplicate metrics are suppressed. If `false`, no metrics are suppressed from the current report. The current report might contain no metrics if all metrics equal the values in the previously generated metric report."/>
381 <Annotation Term="OData.LongDescription" String="This property shall indicate whether any metrics are suppressed from the generated metric report. If `true`, any metric that equals the same value in the previously generated metric report is suppressed from the current report. Also, duplicate metrics are suppressed. If `false`, no metrics are suppressed from the current report. The current report might contain no metrics if all metrics equal the values in the previously generated metric report."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700382 </Property>
383 <Property Name="MetricReportHeartbeatInterval" Type="Edm.Duration">
384 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
385 <Annotation Term="OData.Description" String="The interval at which to send the complete metric report because the Redfish client wants refreshed metric data even when the data has not changed. This property value is always greater than the recurrence interval of a metric report, and it only applies when the SuppressRepeatedMetricValue property is `true`."/>
Gunnar Millsa778c022020-05-12 12:20:36 -0500386 <Annotation Term="OData.LongDescription" String="The property value shall contain a Redfish duration that describes the time interval between generations of the unsuppressed metric report. It shall always be a value greater than the RecurrenceInterval property within Schedule and should only apply when the SuppressRepeatedMetricValue property is `true`."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700387 </Property>
388 <Property Name="MetricReportDefinitionEnabled" Type="Edm.Boolean">
389 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
390 <Annotation Term="OData.Description" String="An indication of whether the generation of new metric reports is enabled."/>
391 <Annotation Term="OData.LongDescription" String="This property shall indicate whether the generation of new metric reports is enabled."/>
392 </Property>
393 <Property Name="Links" Type="MetricReportDefinition.v1_2_0.Links" Nullable="false">
Gunnar Millsa778c022020-05-12 12:20:36 -0500394 <Annotation Term="OData.Description" String="The links to other resources that are related to this resource."/>
395 <Annotation Term="OData.LongDescription" String="This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700396 </Property>
397 </EntityType>
398
399 <ComplexType Name="Links" BaseType="Resource.Links">
Gunnar Millsa778c022020-05-12 12:20:36 -0500400 <Annotation Term="OData.Description" String="The links to other resources that are related to this resource."/>
401 <Annotation Term="OData.LongDescription" String="This Redfish Specification-described type shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700402 <NavigationProperty Name="Triggers" Type="Collection(Triggers.Triggers)">
403 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
404 <Annotation Term="OData.Description" String="The triggers that cause this metric report definition to generate a new metric report upon a trigger occurrence when the TriggerActions property contains `RedfishMetricReport`."/>
405 <Annotation Term="OData.LongDescription" String="This property shall contain a set of triggers that cause this metric report to generate a new metric report upon a trigger occurrence when the TriggerActions property contains `RedfishMetricReport`."/>
406 <Annotation Term="OData.AutoExpandReferences"/>
407 </NavigationProperty>
408 </ComplexType>
409 </Schema>
410
411 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_2_1">
412 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
413 <Annotation Term="OData.Description" String="This version was created to correct descriptions in the CalculationAlgorithmEnum enum. It was also created to update descriptions that this schema defines."/>
414 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.v1_2_0.MetricReportDefinition"/>
415 </Schema>
416
Gunnar Millsa778c022020-05-12 12:20:36 -0500417 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_2_2">
418 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
419 <Annotation Term="OData.Description" String="This version was created to clarify the behavior of `OnRequest` metric report definitions with regards to ReportUpdates and ReportActions. It was also created to clarify the behavior when a metric report definition stops updating a metric report."/>
420 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.v1_2_1.MetricReportDefinition"/>
421 </Schema>
422
Gunnar Mills844b4152020-06-22 12:44:09 -0500423 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_2_3">
424 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
425 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
426 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.v1_2_2.MetricReportDefinition"/>
427 </Schema>
428
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500429 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_2_4">
430 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
431 <Annotation Term="OData.Description" String="This version was created to mark ReportActions, ReportUpdates, MetricId, and properties in Wildcards as writable."/>
432 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.v1_2_3.MetricReportDefinition"/>
433 </Schema>
434
Ed Tanouscb103132019-10-08 11:34:22 -0700435 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_3_0">
436 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
437 <Annotation Term="Redfish.Release" String="2019.2"/>
438
439 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.v1_2_1.MetricReportDefinition">
440 <Property Name="ReportTimespan" Type="Edm.Duration">
441 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Gunnar Millsa778c022020-05-12 12:20:36 -0500442 <Annotation Term="OData.Description" String="The maximum timespan that a metric report can cover."/>
443 <Annotation Term="OData.LongDescription" String="This property shall contain maximum timespan that a metric report can cover."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700444 </Property>
445 </EntityType>
446 </Schema>
447
Gunnar Millsa778c022020-05-12 12:20:36 -0500448 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_3_1">
449 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
450 <Annotation Term="OData.Description" String="This version was created to clarify the behavior of `OnRequest` metric report definitions with regards to ReportUpdates and ReportActions. It was also created to clarify the behavior when a metric report definition stops updating a metric report. It was also created to clarify the description for the ReportTimespan property."/>
451 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.v1_3_0.MetricReportDefinition"/>
452 </Schema>
453
Gunnar Mills844b4152020-06-22 12:44:09 -0500454 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_3_2">
455 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
456 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
457 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.v1_3_1.MetricReportDefinition"/>
458 </Schema>
459
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500460 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="MetricReportDefinition.v1_3_3">
461 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
462 <Annotation Term="OData.Description" String="This version was created to mark ReportActions, ReportUpdates, MetricId, and properties in Wildcards as writable."/>
463 <EntityType Name="MetricReportDefinition" BaseType="MetricReportDefinition.v1_3_2.MetricReportDefinition"/>
464 </Schema>
465
Ed Tanous530520e2019-01-02 13:41:37 -0800466 </edmx:DataServices>
467</edmx:Edmx>