blob: 20977fdd7031f657e91bc3247e395eb49f6d08e5 [file] [log] [blame]
Ed Tanous530520e2019-01-02 13:41:37 -08001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
4<!--# Redfish Schema: TelemetryService v1.0.0-->
5<!--# -->
6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, -->
7<!--# available at http://www.dmtf.org/standards/redfish -->
8<!--# Copyright 2014-2018 DMTF. -->
9<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
10<!--################################################################################ -->
11<!---->
12<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
13
14 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
15 <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
16 </edmx:Reference>
17 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
18 <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
19 </edmx:Reference>
20 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
21 <edmx:Include Namespace="Resource"/>
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
43 <edmx:DataServices>
44
45 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService">
46 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
47
48 <EntityType Name="TelemetryService" BaseType="Resource.v1_0_0.Resource" Abstract="true">
49 <Annotation Term="OData.Description" String="This is the schema definition for the Metrics Service."/>
50 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent a Metrics Service for a Redfish implementation."/>
51 <Annotation Term="Capabilities.InsertRestrictions">
52 <Record>
53 <PropertyValue Property="Insertable" Bool="false"/>
54 </Record>
55 </Annotation>
56 <Annotation Term="Capabilities.UpdateRestrictions">
57 <Record>
58 <PropertyValue Property="Updatable" Bool="true"/>
59 <Annotation Term="OData.Description" String="The Metrics Service can be updated to change properties such as ServiceEnabled."/>
60 </Record>
61 </Annotation>
62 <Annotation Term="Capabilities.DeleteRestrictions">
63 <Record>
64 <PropertyValue Property="Deletable" Bool="false"/>
65 </Record>
66 </Annotation>
67 <Annotation Term="Redfish.Uris">
68 <Collection>
69 <String>/redfish/v1/TelemetryService</String>
70 </Collection>
71 </Annotation>
72 </EntityType>
73
74 <Action Name="SubmitTestMetricReport" IsBound="true">
75 <Annotation Term="OData.Description" String="This action is used to generate a metric report."/>
76 <Annotation Term="OData.LongDescription" String="This action shall cause the event service to immediately generate the metric report, as an Alert Event. This message should then be sent to any appropriate ListenerDestination targets."/>
77 <Parameter Name="TelemetryService" Type="TelemetryService.v1_0_0.Actions"/>
78 <Parameter Name="MetricReportName" Type="Edm.String" Nullable="false">
79 <Annotation Term="OData.Description" String="The Name property of the metric report in generated metric report."/>
80 <Annotation Term="OData.LongDescription" String="This parameter shall be the value of the Name property in the generated metric report."/>
81 </Parameter>
82 <Parameter Name="MetricReportValues" Type="Edm.String" Nullable="false">
83 <Annotation Term="OData.Description" String="The content of MetricReportValues array in generated metric report."/>
84 <Annotation Term="OData.LongDescription" String="This parameter shall contain the contents of the MetricReportValues array property in the generated metric report."/>
85 </Parameter>
86 </Action>
87 </Schema>
88
89 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryService.v1_0_0">
90 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
91
92 <EntityType Name="TelemetryService" BaseType="TelemetryService.TelemetryService">
93 <Annotation Term="OData.Description" String="This is the schema definition for the Metrics Service. It represents the properties for the service itself and has links to collections of metric definitions and metric report definitions."/>
94 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent an Metrics Service for a Redfish implementation. It represents the properties that affect the service itself."/>
95 <Property Name="Status" Type="Resource.Status" Nullable="false">
96 <Annotation Term="OData.Description" String="This property describes the status and health of the resource and its children."/>
97 <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
98 </Property>
99 <Property Name="MaxReports" Type="Edm.Int64">
100 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
101 <Annotation Term="OData.Description" String="The maximum number of metric reports supported by this service."/>
102 <Annotation Term="OData.LongDescription" String="The value shall be the maximum number of metric reports supported by this service."/>
103 </Property>
104 <Property Name="MinCollectionInterval" Type="Edm.Duration">
105 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
106 <Annotation Term="OData.Description" String="The minimum time interval between collections supported by this service."/>
107 <Annotation Term="OData.LongDescription" String="The value shall be the minimum time interval between collections supported by this service. The value shall conform to the Duration format."/>
108 </Property>
109 <Property Name="SupportedCollectionFunctions" Type="Collection(TelemetryService.v1_0_0.CollectionFunction)">
110 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
111 <Annotation Term="OData.Description" String="The functions that can be performed over each metric."/>
112 <Annotation Term="OData.LongDescription" String="The value shall define the function to apply over the collection duration."/>
113 </Property>
114
115 <NavigationProperty Name="MetricDefinitions" Type="MetricDefinitionCollection.MetricDefinitionCollection" ContainsTarget="true" Nullable="false">
116 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
117 <Annotation Term="OData.Description" String="A link to the collection of Metric Definitions."/>
118 <Annotation Term="OData.LongDescription" String="The entries of shall be resources of type MetricDefinitionCollection."/>
119 <Annotation Term="OData.AutoExpandReferences"/>
120 </NavigationProperty>
121 <NavigationProperty Name="MetricReportDefinitions" Type="MetricReportDefinitionCollection.MetricReportDefinitionCollection" ContainsTarget="true" Nullable="false">
122 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
123 <Annotation Term="OData.Description" String="A link to the collection of Metric Report Definitions."/>
124 <Annotation Term="OData.LongDescription" String="The value shall be a link to a resource of type MetricReportDefinitionCollection."/>
125 <Annotation Term="OData.AutoExpandReferences"/>
126 </NavigationProperty>
127 <NavigationProperty Name="MetricReports" Type="MetricReportCollection.MetricReportCollection" ContainsTarget="true" Nullable="false">
128 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
129 <Annotation Term="OData.Description" String="A link to the collection of Metric Reports."/>
130 <Annotation Term="OData.LongDescription" String="The value shall be a link to a resource of type MetricReportCollection."/>
131 <Annotation Term="OData.AutoExpandReferences"/>
132 </NavigationProperty>
133 <NavigationProperty Name="Triggers" Type="TriggersCollection.TriggersCollection" ContainsTarget="true" Nullable="false">
134 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
135 <Annotation Term="OData.Description" String="A link to the collection of Triggers, which apply to metrics."/>
136 <Annotation Term="OData.LongDescription" String="The value shall be a link to a resource of type TriggersCollection."/>
137 <Annotation Term="OData.AutoExpandReferences"/>
138 </NavigationProperty>
139 <NavigationProperty Name="LogService" Type="LogService.LogService" ContainsTarget="true" Nullable="false">
140 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
141 <Annotation Term="OData.Description" String="This is a reference to a Log Service used by the Telemetry Service."/>
142 <Annotation Term="OData.LongDescription" String="The value of this property shall contain a reference to a LogService for the use by this Telemetry Service."/>
143 <Annotation Term="OData.AutoExpandReferences"/>
144 </NavigationProperty>
145 <Property Name="Actions" Type="TelemetryService.v1_0_0.Actions" Nullable="false">
146 <Annotation Term="OData.Description" String="The available actions for this resource."/>
147 <Annotation Term="OData.LongDescription" String="The Actions property shall contain the available actions for this resource."/>
148 </Property>
149 </EntityType>
150
151 <EnumType Name="CollectionFunction">
152 <Annotation Term="OData.Description" String="An operation to perform over the sample."/>
153 <Annotation Term="OData.LongDescription" String="If present, the metric value shall be computed according to this function."/>
154 <Member Name="Average">
155 <Annotation Term="OData.Description" String="An averaging function."/>
156 </Member>
157 <Member Name="Maximum">
158 <Annotation Term="OData.Description" String="A maximum function."/>
159 </Member>
160 <Member Name="Minimum">
161 <Annotation Term="OData.Description" String="A minimum function."/>
162 </Member>
163 <Member Name="Summation">
164 <Annotation Term="OData.Description" String="A summation function."/>
165 </Member>
166 </EnumType>
167
168 <ComplexType Name="Actions">
169 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
170 <Annotation Term="OData.Description" String="The available actions for this resource."/>
171 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
172 <Property Name="Oem" Type="TelemetryService.v1_0_0.OemActions" Nullable="false">
173 <Annotation Term="OData.Description" String="This property contains the available OEM specific actions for this resource."/>
174 <Annotation Term="OData.LongDescription" String="This property shall contain any additional OEM actions for this resource."/>
175 </Property>
176 </ComplexType>
177
178 <ComplexType Name="OemActions">
179 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
180 <Annotation Term="OData.Description" String="The available OEM specific actions for this resource."/>
181 <Annotation Term="OData.LongDescription" String="This type shall contain any additional OEM actions for this resource."/>
182 </ComplexType>
183 </Schema>
184
185 </edmx:DataServices>
186</edmx:Edmx>