1<?xml version="1.0" encoding="UTF-8"?> 2<!----> 3<!--################################################################################ --> 4<!--# Redfish Schema: TelemetryService v1.2.1 --> 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-2020 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"/> 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:Reference> 27 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/MetricDefinitionCollection_v1.xml"> 28 <edmx:Include Namespace="MetricDefinitionCollection"/> 29 </edmx:Reference> 30 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/MetricReportDefinitionCollection_v1.xml"> 31 <edmx:Include Namespace="MetricReportDefinitionCollection"/> 32 </edmx:Reference> 33 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/MetricReportCollection_v1.xml"> 34 <edmx:Include Namespace="MetricReportCollection"/> 35 </edmx:Reference> 36 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/TriggersCollection_v1.xml"> 37 <edmx:Include Namespace="TriggersCollection"/> 38 </edmx:Reference> 39 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/LogService_v1.xml"> 40 <edmx:Include Namespace="LogService"/> 41 </edmx:Reference> 42 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/MetricDefinition_v1.xml"> 43 <edmx:Include Namespace="MetricDefinition"/> 44 </edmx:Reference> 45 46 <edmx:DataServices> 47 48 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService"> 49 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 50 51 <EntityType Name="TelemetryService" BaseType="Resource.v1_0_0.Resource" Abstract="true"> 52 <Annotation Term="OData.Description" String="The TelemetryService schema describes a telemetry service. The telemetry service is used to for collecting and reporting metric data within the Redfish Service."/> 53 <Annotation Term="OData.LongDescription" String="This resource contains a telemetry service for a Redfish implementation."/> 54 <Annotation Term="Capabilities.InsertRestrictions"> 55 <Record> 56 <PropertyValue Property="Insertable" Bool="false"/> 57 </Record> 58 </Annotation> 59 <Annotation Term="Capabilities.UpdateRestrictions"> 60 <Record> 61 <PropertyValue Property="Updatable" Bool="true"/> 62 <Annotation Term="OData.Description" String="Any writable properties, such as ServiceEnabled, can be updated for the telemetry service."/> 63 </Record> 64 </Annotation> 65 <Annotation Term="Capabilities.DeleteRestrictions"> 66 <Record> 67 <PropertyValue Property="Deletable" Bool="false"/> 68 </Record> 69 </Annotation> 70 <Annotation Term="Redfish.Uris"> 71 <Collection> 72 <String>/redfish/v1/TelemetryService</String> 73 </Collection> 74 </Annotation> 75 </EntityType> 76 77 <Action Name="SubmitTestMetricReport" IsBound="true"> 78 <Annotation Term="OData.Description" String="This action generates a metric report."/> 79 <Annotation Term="OData.LongDescription" String="This action shall cause the Event Service to immediately generate the metric report as an alert event. Then, this message should be sent to any appropriate event destinations."/> 80 <Parameter Name="TelemetryService" Type="TelemetryService.v1_0_0.Actions"/> 81 <Parameter Name="MetricReportName" Type="Edm.String" Nullable="false"> 82 <Annotation Term="OData.Description" String="The name of the metric report in generated metric report."/> 83 <Annotation Term="OData.LongDescription" String="This parameter shall contain the name of the generated metric report."/> 84 </Parameter> 85 <Parameter Name="MetricReportValues" Type="Edm.String"> 86 <Annotation Term="OData.Description" String="The contents of MetricReportValues array in the generated metric report."/> 87 <Annotation Term="OData.LongDescription" String="This parameter shall contain the contents of the MetricReportValues array property in the generated metric report."/> 88 <Annotation Term="Redfish.Revisions"> 89 <Collection> 90 <Record> 91 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Deprecated"/> 92 <PropertyValue Property="Version" String="v1_1_0"/> 93 <PropertyValue Property="Description" String="This property has been deprecated in favor of using the property 'GeneratedMetricReportValues'."/> 94 </Record> 95 </Collection> 96 </Annotation> 97 </Parameter> 98 <Parameter Name="GeneratedMetricReportValues" Type="Collection(TelemetryService.v1_1_0.MetricValue)" Nullable="false"> 99 <Annotation Term="OData.Description" String="The content of the MetricReportValues in the generated metric report."/> 100 <Annotation Term="OData.LongDescription" String="This parameter shall contain the contents of the MetricReportValues array property in the generated metric report."/> 101 <Annotation Term="Redfish.Revisions"> 102 <Collection> 103 <Record> 104 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/> 105 <PropertyValue Property="Version" String="v1_1_0"/> 106 <PropertyValue Property="Description" String="This property has been deprecated in favor of using the property 'GeneratedMetricReportValues'."/> 107 </Record> 108 </Collection> 109 </Annotation> 110 </Parameter> 111 </Action> 112 </Schema> 113 114 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_0_0"> 115 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 116 <Annotation Term="Redfish.Release" String="2018.2"/> 117 118 <EntityType Name="TelemetryService" BaseType="TelemetryService.TelemetryService"> 119 <Property Name="Status" Type="Resource.Status" Nullable="false"> 120 <Annotation Term="OData.Description" String="The status and health of the resource and its subordinate or dependent resources."/> 121 <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/> 122 </Property> 123 <Property Name="MaxReports" Type="Edm.Int64"> 124 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 125 <Annotation Term="OData.Description" String="The maximum number of metric reports that this service supports."/> 126 <Annotation Term="OData.LongDescription" String="This property shall contain the maximum number of metric reports that this service supports."/> 127 </Property> 128 <Property Name="MinCollectionInterval" Type="Edm.Duration"> 129 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 130 <Annotation Term="OData.Description" String="The minimum time interval between gathering metric data that this service allows."/> 131 <Annotation Term="OData.LongDescription" String="This property shall contain the minimum time interval between gathering metric data that this service allows."/> 132 </Property> 133 <Property Name="SupportedCollectionFunctions" Type="Collection(TelemetryService.v1_0_0.CollectionFunction)"> 134 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> 135 <Annotation Term="OData.Description" String="The functions that can be performed over each metric."/> 136 <Annotation Term="OData.LongDescription" String="This property shall contain the function to apply over the collection duration."/> 137 </Property> 138 139 <NavigationProperty Name="MetricDefinitions" Type="MetricDefinitionCollection.MetricDefinitionCollection" ContainsTarget="true" Nullable="false"> 140 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 141 <Annotation Term="OData.Description" String="The link to the collection of metric definitions."/> 142 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type MetricDefinitionCollection."/> 143 <Annotation Term="OData.AutoExpandReferences"/> 144 </NavigationProperty> 145 <NavigationProperty Name="MetricReportDefinitions" Type="MetricReportDefinitionCollection.MetricReportDefinitionCollection" ContainsTarget="true" Nullable="false"> 146 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 147 <Annotation Term="OData.Description" String="The link to the collection of metric report definitions."/> 148 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type MetricReportDefinitionCollection."/> 149 <Annotation Term="OData.AutoExpandReferences"/> 150 </NavigationProperty> 151 <NavigationProperty Name="MetricReports" Type="MetricReportCollection.MetricReportCollection" ContainsTarget="true" Nullable="false"> 152 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 153 <Annotation Term="OData.Description" String="The link to the collection of metric reports."/> 154 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type MetricReportCollection."/> 155 <Annotation Term="OData.AutoExpandReferences"/> 156 </NavigationProperty> 157 <NavigationProperty Name="Triggers" Type="TriggersCollection.TriggersCollection" ContainsTarget="true" Nullable="false"> 158 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 159 <Annotation Term="OData.Description" String="The link to the collection of triggers that apply to metrics."/> 160 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type TriggersCollection."/> 161 <Annotation Term="OData.AutoExpandReferences"/> 162 </NavigationProperty> 163 <NavigationProperty Name="LogService" Type="LogService.LogService" Nullable="false"> 164 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 165 <Annotation Term="OData.Description" String="The link to a log service that the telemetry service uses. This service can be a dedicated log service or a pointer a log service under another resource, such as a manager."/> 166 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type LogService that this telemetry service uses."/> 167 <Annotation Term="OData.AutoExpandReferences"/> 168 </NavigationProperty> 169 <Property Name="Actions" Type="TelemetryService.v1_0_0.Actions" Nullable="false"> 170 <Annotation Term="OData.Description" String="The available actions for this resource."/> 171 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/> 172 </Property> 173 </EntityType> 174 175 <EnumType Name="CollectionFunction"> 176 <Annotation Term="OData.Description" String="An operation to perform over the sample."/> 177 <Annotation Term="OData.LongDescription" String="If present, the metric value shall be computed according to this function."/> 178 <Member Name="Average"> 179 <Annotation Term="OData.Description" String="An averaging function."/> 180 </Member> 181 <Member Name="Maximum"> 182 <Annotation Term="OData.Description" String="A maximum function."/> 183 </Member> 184 <Member Name="Minimum"> 185 <Annotation Term="OData.Description" String="A minimum function."/> 186 </Member> 187 <Member Name="Summation"> 188 <Annotation Term="OData.Description" String="A summation function."/> 189 </Member> 190 </EnumType> 191 192 <ComplexType Name="Actions"> 193 <Annotation Term="OData.AdditionalProperties" Bool="false"/> 194 <Annotation Term="OData.Description" String="The available actions for this resource."/> 195 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/> 196 <Property Name="Oem" Type="TelemetryService.v1_0_0.OemActions" Nullable="false"> 197 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/> 198 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/> 199 </Property> 200 </ComplexType> 201 202 <ComplexType Name="OemActions"> 203 <Annotation Term="OData.AdditionalProperties" Bool="true"/> 204 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/> 205 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/> 206 </ComplexType> 207 </Schema> 208 209 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_0_1"> 210 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 211 <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."/> 212 <EntityType Name="TelemetryService" BaseType="TelemetryService.v1_0_0.TelemetryService"/> 213 </Schema> 214 215 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_0_2"> 216 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 217 <Annotation Term="OData.Description" String="This version was created to update the description of the LogService property. It was also created to update descriptions that this schema defines."/> 218 <EntityType Name="TelemetryService" BaseType="TelemetryService.v1_0_1.TelemetryService"/> 219 </Schema> 220 221 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_0_3"> 222 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 223 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/> 224 <EntityType Name="TelemetryService" BaseType="TelemetryService.v1_0_2.TelemetryService"/> 225 </Schema> 226 227 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_1_0"> 228 <Annotation Term="OData.Description" String="This version was created to add the GeneratedMetricReportValues property to the SubmittestMetricReport action."/> 229 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 230 <Annotation Term="Redfish.Release" String="2018.3"/> 231 232 <EntityType Name="TelemetryService" BaseType="TelemetryService.v1_0_0.TelemetryService"/> 233 234 <ComplexType Name="MetricValue"> 235 <Annotation Term="OData.AdditionalProperties" Bool="false"/> 236 <Annotation Term="OData.Description" String="Properties that capture a metric value and other associated information."/> 237 <Annotation Term="OData.LongDescription" String="This type shall contain properties that capture a metric value and other associated information."/> 238 <Property Name="MetricId" Type="Edm.String"> 239 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 240 <Annotation Term="OData.Description" String="The metric definitions identifier for this metric."/> 241 <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."/> 242 </Property> 243 <Property Name="MetricValue" Type="Edm.String"> 244 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 245 <Annotation Term="OData.Description" String="The metric value, as a string."/> 246 <Annotation Term="OData.LongDescription" String="This property shall contain the metric value, as a string."/> 247 </Property> 248 <Property Name="Timestamp" Type="Edm.DateTimeOffset"> 249 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 250 <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."/> 251 <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."/> 252 </Property> 253 <Property Name="MetricProperty" Type="Edm.String"> 254 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 255 <Annotation Term="OData.Description" String="The URI for the property from which this metric is derived."/> 256 <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."/> 257 <Annotation Term="OData.IsURL"/> 258 </Property> 259 <NavigationProperty Name="MetricDefinition" Type="MetricDefinition.MetricDefinition" Nullable="false"> 260 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/> 261 <Annotation Term="OData.Description" String="The link to the metric definition for this metric."/> 262 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type MetricDefinition that describes what this metric value captures."/> 263 <Annotation Term="OData.AutoExpandReferences"/> 264 </NavigationProperty> 265 </ComplexType> 266 </Schema> 267 268 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_1_1"> 269 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 270 <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."/> 271 <EntityType Name="TelemetryService" BaseType="TelemetryService.v1_1_0.TelemetryService"/> 272 </Schema> 273 274 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_1_2"> 275 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 276 <Annotation Term="OData.Description" String="This version was created to update the description of the LogService property. It was also created to update descriptions that this schema defines."/> 277 <EntityType Name="TelemetryService" BaseType="TelemetryService.v1_1_1.TelemetryService"/> 278 </Schema> 279 280 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_1_3"> 281 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 282 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/> 283 <EntityType Name="TelemetryService" BaseType="TelemetryService.v1_1_2.TelemetryService"/> 284 </Schema> 285 286 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_2_0"> 287 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 288 <Annotation Term="Redfish.Release" String="2019.4"/> 289 290 <EntityType Name="TelemetryService" BaseType="TelemetryService.v1_1_2.TelemetryService"> 291 <Property Name="ServiceEnabled" Type="Edm.Boolean"> 292 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/> 293 <Annotation Term="OData.Description" String="An indication of whether this service is enabled."/> 294 <Annotation Term="OData.LongDescription" String="This property shall indicate whether this service is enabled."/> 295 </Property> 296 </EntityType> 297 </Schema> 298 299 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_2_1"> 300 <Annotation Term="Redfish.OwningEntity" String="DMTF"/> 301 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/> 302 <EntityType Name="TelemetryService" BaseType="TelemetryService.v1_2_0.TelemetryService"/> 303 </Schema> 304 305 </edmx:DataServices> 306</edmx:Edmx> 307