blob: c744df53161432b47c4254b5b7360af5787a8eac [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!---->
<!--################################################################################ -->
<!--# Redfish Schema: TelemetryService v1.3.1 -->
<!--# -->
<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, -->
<!--# available at http://www.dmtf.org/standards/redfish -->
<!--# Copyright 2014-2021 DMTF. -->
<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
<!--################################################################################ -->
<!---->
<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
<edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
<edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
</edmx:Reference>
<edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
<edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
<edmx:Include Namespace="Resource"/>
<edmx:Include Namespace="Resource.v1_0_0"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
<edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/MetricDefinitionCollection_v1.xml">
<edmx:Include Namespace="MetricDefinitionCollection"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/MetricReportDefinitionCollection_v1.xml">
<edmx:Include Namespace="MetricReportDefinitionCollection"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/MetricReportCollection_v1.xml">
<edmx:Include Namespace="MetricReportCollection"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/TriggersCollection_v1.xml">
<edmx:Include Namespace="TriggersCollection"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/LogService_v1.xml">
<edmx:Include Namespace="LogService"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/MetricDefinition_v1.xml">
<edmx:Include Namespace="MetricDefinition"/>
</edmx:Reference>
<edmx:DataServices>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<EntityType Name="TelemetryService" BaseType="Resource.v1_0_0.Resource" Abstract="true">
<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."/>
<Annotation Term="OData.LongDescription" String="This resource contains a telemetry service for a Redfish implementation."/>
<Annotation Term="Capabilities.InsertRestrictions">
<Record>
<PropertyValue Property="Insertable" Bool="false"/>
</Record>
</Annotation>
<Annotation Term="Capabilities.UpdateRestrictions">
<Record>
<PropertyValue Property="Updatable" Bool="true"/>
<Annotation Term="OData.Description" String="Any writable properties, such as ServiceEnabled, can be updated for the telemetry service."/>
</Record>
</Annotation>
<Annotation Term="Capabilities.DeleteRestrictions">
<Record>
<PropertyValue Property="Deletable" Bool="false"/>
</Record>
</Annotation>
<Annotation Term="Redfish.Uris">
<Collection>
<String>/redfish/v1/TelemetryService</String>
</Collection>
</Annotation>
</EntityType>
<Action Name="SubmitTestMetricReport" IsBound="true">
<Annotation Term="OData.Description" String="This action generates a metric report."/>
<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."/>
<Parameter Name="TelemetryService" Type="TelemetryService.v1_0_0.Actions"/>
<Parameter Name="MetricReportName" Type="Edm.String" Nullable="false">
<Annotation Term="OData.Description" String="The name of the metric report in generated metric report."/>
<Annotation Term="OData.LongDescription" String="This parameter shall contain the name of the generated metric report."/>
</Parameter>
<Parameter Name="MetricReportValues" Type="Edm.String">
<Annotation Term="OData.Description" String="The contents of MetricReportValues array in the generated metric report."/>
<Annotation Term="OData.LongDescription" String="This parameter shall contain the contents of the MetricReportValues array property in the generated metric report."/>
<Annotation Term="Redfish.Revisions">
<Collection>
<Record>
<PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Deprecated"/>
<PropertyValue Property="Version" String="v1_1_0"/>
<PropertyValue Property="Description" String="This property has been deprecated in favor of using the property 'GeneratedMetricReportValues'."/>
</Record>
</Collection>
</Annotation>
</Parameter>
<Parameter Name="GeneratedMetricReportValues" Type="Collection(TelemetryService.v1_1_0.MetricValue)" Nullable="false">
<Annotation Term="OData.Description" String="The content of the MetricReportValues in the generated metric report."/>
<Annotation Term="OData.LongDescription" String="This parameter shall contain the contents of the MetricReportValues array property in the generated metric report."/>
<Annotation Term="Redfish.Revisions">
<Collection>
<Record>
<PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
<PropertyValue Property="Version" String="v1_1_0"/>
</Record>
</Collection>
</Annotation>
</Parameter>
</Action>
<Action Name="ClearMetricReports" IsBound="true">
<Annotation Term="OData.Description" String="The action to clear the metric reports for this telemetry service."/>
<Annotation Term="OData.LongDescription" String="This action shall delete all entries found in the metric report collection for this telemetry service."/>
<Parameter Name="TelemetryService" Type="TelemetryService.v1_0_0.Actions"/>
<Annotation Term="Redfish.Revisions">
<Collection>
<Record>
<PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
<PropertyValue Property="Version" String="v1_3_0"/>
</Record>
</Collection>
</Annotation>
</Action>
<Action Name="ResetMetricReportDefinitionsToDefaults" IsBound="true">
<Annotation Term="OData.Description" String="The action to reset the metric report definitions to factory defaults."/>
<Annotation Term="OData.LongDescription" String="This action shall reset all entries found in the metric report definition collection to factory defaults. This action may delete members of the metric report definition collection."/>
<Parameter Name="TelemetryService" Type="TelemetryService.v1_0_0.Actions"/>
<Annotation Term="Redfish.Revisions">
<Collection>
<Record>
<PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
<PropertyValue Property="Version" String="v1_3_0"/>
</Record>
</Collection>
</Annotation>
</Action>
<Action Name="ResetTriggersToDefaults" IsBound="true">
<Annotation Term="OData.Description" String="The action to reset the triggers to factory defaults."/>
<Annotation Term="OData.LongDescription" String="This action shall reset all entries found in the triggers collection to factory defaults. This action may delete members of the triggers collection."/>
<Parameter Name="TelemetryService" Type="TelemetryService.v1_0_0.Actions"/>
<Annotation Term="Redfish.Revisions">
<Collection>
<Record>
<PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
<PropertyValue Property="Version" String="v1_3_0"/>
</Record>
</Collection>
</Annotation>
</Action>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_0_0">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="Redfish.Release" String="2018.2"/>
<EntityType Name="TelemetryService" BaseType="TelemetryService.TelemetryService">
<Property Name="Status" Type="Resource.Status" Nullable="false">
<Annotation Term="OData.Description" String="The status and health of the resource and its subordinate or dependent resources."/>
<Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
</Property>
<Property Name="MaxReports" Type="Edm.Int64">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<Annotation Term="OData.Description" String="The maximum number of metric reports that this service supports."/>
<Annotation Term="OData.LongDescription" String="This property shall contain the maximum number of metric reports that this service supports."/>
</Property>
<Property Name="MinCollectionInterval" Type="Edm.Duration">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<Annotation Term="OData.Description" String="The minimum time interval between gathering metric data that this service allows."/>
<Annotation Term="OData.LongDescription" String="This property shall contain the minimum time interval between gathering metric data that this service allows."/>
</Property>
<Property Name="SupportedCollectionFunctions" Type="Collection(TelemetryService.v1_0_0.CollectionFunction)">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
<Annotation Term="OData.Description" String="The functions that can be performed over each metric."/>
<Annotation Term="OData.LongDescription" String="This property shall contain the function to apply over the collection duration."/>
</Property>
<NavigationProperty Name="MetricDefinitions" Type="MetricDefinitionCollection.MetricDefinitionCollection" ContainsTarget="true" Nullable="false">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<Annotation Term="OData.Description" String="The link to the collection of metric definitions."/>
<Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type MetricDefinitionCollection."/>
<Annotation Term="OData.AutoExpandReferences"/>
</NavigationProperty>
<NavigationProperty Name="MetricReportDefinitions" Type="MetricReportDefinitionCollection.MetricReportDefinitionCollection" ContainsTarget="true" Nullable="false">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<Annotation Term="OData.Description" String="The link to the collection of metric report definitions."/>
<Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type MetricReportDefinitionCollection."/>
<Annotation Term="OData.AutoExpandReferences"/>
</NavigationProperty>
<NavigationProperty Name="MetricReports" Type="MetricReportCollection.MetricReportCollection" ContainsTarget="true" Nullable="false">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<Annotation Term="OData.Description" String="The link to the collection of metric reports."/>
<Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type MetricReportCollection."/>
<Annotation Term="OData.AutoExpandReferences"/>
</NavigationProperty>
<NavigationProperty Name="Triggers" Type="TriggersCollection.TriggersCollection" ContainsTarget="true" Nullable="false">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<Annotation Term="OData.Description" String="The link to the collection of triggers that apply to metrics."/>
<Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type TriggersCollection."/>
<Annotation Term="OData.AutoExpandReferences"/>
</NavigationProperty>
<NavigationProperty Name="LogService" Type="LogService.LogService" Nullable="false">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<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."/>
<Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type LogService that this telemetry service uses."/>
<Annotation Term="OData.AutoExpandReferences"/>
</NavigationProperty>
<Property Name="Actions" Type="TelemetryService.v1_0_0.Actions" Nullable="false">
<Annotation Term="OData.Description" String="The available actions for this resource."/>
<Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
</Property>
</EntityType>
<EnumType Name="CollectionFunction">
<Annotation Term="OData.Description" String="An operation to perform over the sample."/>
<Annotation Term="OData.LongDescription" String="If present, the metric value shall be computed according to this function."/>
<Member Name="Average">
<Annotation Term="OData.Description" String="An averaging function."/>
</Member>
<Member Name="Maximum">
<Annotation Term="OData.Description" String="A maximum function."/>
</Member>
<Member Name="Minimum">
<Annotation Term="OData.Description" String="A minimum function."/>
</Member>
<Member Name="Summation">
<Annotation Term="OData.Description" String="A summation function."/>
</Member>
</EnumType>
<ComplexType Name="Actions">
<Annotation Term="OData.AdditionalProperties" Bool="false"/>
<Annotation Term="OData.Description" String="The available actions for this resource."/>
<Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
<Property Name="Oem" Type="TelemetryService.v1_0_0.OemActions" Nullable="false">
<Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
<Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
</Property>
</ComplexType>
<ComplexType Name="OemActions">
<Annotation Term="OData.AdditionalProperties" Bool="true"/>
<Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
<Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
</ComplexType>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_0_1">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/>
<EntityType Name="TelemetryService" BaseType="TelemetryService.v1_0_0.TelemetryService"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_0_2">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<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."/>
<EntityType Name="TelemetryService" BaseType="TelemetryService.v1_0_1.TelemetryService"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_0_3">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
<EntityType Name="TelemetryService" BaseType="TelemetryService.v1_0_2.TelemetryService"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_0_4">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created specify 64-bit integers in OpenAPI."/>
<EntityType Name="TelemetryService" BaseType="TelemetryService.v1_0_3.TelemetryService"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_0_5">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to correct various description to use proper normative terminology."/>
<EntityType Name="TelemetryService" BaseType="TelemetryService.v1_0_4.TelemetryService"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_1_0">
<Annotation Term="OData.Description" String="This version was created to add the GeneratedMetricReportValues property to the SubmitTestMetricReport action."/>
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="Redfish.Release" String="2018.3"/>
<EntityType Name="TelemetryService" BaseType="TelemetryService.v1_0_0.TelemetryService"/>
<ComplexType Name="MetricValue">
<Annotation Term="OData.AdditionalProperties" Bool="false"/>
<Annotation Term="OData.Description" String="Properties that capture a metric value and other associated information."/>
<Annotation Term="OData.LongDescription" String="This type shall contain properties that capture a metric value and other associated information."/>
<Property Name="MetricId" Type="Edm.String">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<Annotation Term="OData.Description" String="The metric definitions identifier for this metric."/>
<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."/>
</Property>
<Property Name="MetricValue" Type="Edm.String">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<Annotation Term="OData.Description" String="The metric value, as a string."/>
<Annotation Term="OData.LongDescription" String="This property shall contain the metric value, as a string."/>
</Property>
<Property Name="Timestamp" Type="Edm.DateTimeOffset">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<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."/>
<Annotation Term="OData.LongDescription" String="The value shall time when the metric value was obtained. Note that this value may be different from the time when this instance is created."/>
</Property>
<Property Name="MetricProperty" Type="Edm.String">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<Annotation Term="OData.Description" String="The URI for the property from which this metric is derived."/>
<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."/>
<Annotation Term="OData.IsURL"/>
</Property>
<NavigationProperty Name="MetricDefinition" Type="MetricDefinition.MetricDefinition" Nullable="false">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<Annotation Term="OData.Description" String="The link to the metric definition for this metric."/>
<Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type MetricDefinition that describes what this metric value captures."/>
<Annotation Term="OData.AutoExpandReferences"/>
</NavigationProperty>
</ComplexType>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_1_1">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/>
<EntityType Name="TelemetryService" BaseType="TelemetryService.v1_1_0.TelemetryService"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_1_2">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<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."/>
<EntityType Name="TelemetryService" BaseType="TelemetryService.v1_1_1.TelemetryService"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_1_3">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
<EntityType Name="TelemetryService" BaseType="TelemetryService.v1_1_2.TelemetryService"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_1_4">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created specify 64-bit integers in OpenAPI."/>
<EntityType Name="TelemetryService" BaseType="TelemetryService.v1_1_3.TelemetryService"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_1_5">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to correct various description to use proper normative terminology."/>
<EntityType Name="TelemetryService" BaseType="TelemetryService.v1_1_4.TelemetryService"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_2_0">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="Redfish.Release" String="2019.4"/>
<EntityType Name="TelemetryService" BaseType="TelemetryService.v1_1_2.TelemetryService">
<Property Name="ServiceEnabled" Type="Edm.Boolean">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
<Annotation Term="OData.Description" String="An indication of whether this service is enabled."/>
<Annotation Term="OData.LongDescription" String="This property shall indicate whether this service is enabled."/>
</Property>
</EntityType>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_2_1">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
<EntityType Name="TelemetryService" BaseType="TelemetryService.v1_2_0.TelemetryService"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_2_2">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created specify 64-bit integers in OpenAPI."/>
<EntityType Name="TelemetryService" BaseType="TelemetryService.v1_2_1.TelemetryService"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_2_3">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to correct various description to use proper normative terminology."/>
<EntityType Name="TelemetryService" BaseType="TelemetryService.v1_2_2.TelemetryService"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_3_0">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="Redfish.Release" String="2020.4"/>
<Annotation Term="OData.Description" String="This version was created to add the ClearMetricReports, ResetMetricReportDefinitionsToDefaults, and ResetTriggersToDefaults actions."/>
<EntityType Name="TelemetryService" BaseType="TelemetryService.v1_2_2.TelemetryService"/>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_3_1">
<Annotation Term="Redfish.OwningEntity" String="DMTF"/>
<Annotation Term="OData.Description" String="This version was created to correct various description to use proper normative terminology."/>
<EntityType Name="TelemetryService" BaseType="TelemetryService.v1_3_0.TelemetryService"/>
</Schema>
</edmx:DataServices>
</edmx:Edmx>