xref: /openbmc/bmcweb/features/redfish/schema/dmtf/csdl/ThermalSubsystem_v1.xml (revision c6d7a45d427f9a6d9e761afcf305761dca60d7cf)
1<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################       -->
4<!--# Redfish Schema:  ThermalSubsystem v1.4.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-2025 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/RedfishExtensions_v1.xml">
21    <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
22    <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
23  </edmx:Reference>
24  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
25    <edmx:Include Namespace="Resource"/>
26    <edmx:Include Namespace="Resource.v1_0_0"/>
27  </edmx:Reference>
28  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Redundancy_v1.xml">
29    <edmx:Include Namespace="Redundancy"/>
30  </edmx:Reference>
31  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/FanCollection_v1.xml">
32    <edmx:Include Namespace="FanCollection"/>
33  </edmx:Reference>
34  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/ThermalMetrics_v1.xml">
35    <edmx:Include Namespace="ThermalMetrics"/>
36  </edmx:Reference>
37  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/HeaterCollection_v1.xml">
38    <edmx:Include Namespace="HeaterCollection"/>
39  </edmx:Reference>
40  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/CoolantConnectorCollection_v1.xml">
41    <edmx:Include Namespace="CoolantConnectorCollection"/>
42  </edmx:Reference>
43  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/PumpCollection_v1.xml">
44    <edmx:Include Namespace="PumpCollection"/>
45  </edmx:Reference>
46  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/LeakDetection_v1.xml">
47    <edmx:Include Namespace="LeakDetection"/>
48  </edmx:Reference>
49  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/FilterCollection_v1.xml">
50    <edmx:Include Namespace="FilterCollection"/>
51  </edmx:Reference>
52
53  <edmx:DataServices>
54
55    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalSubsystem">
56      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
57      <Annotation Term="Redfish.Language" String="en"/>
58
59      <EntityType Name="ThermalSubsystem" BaseType="Resource.v1_0_0.Resource" Abstract="true">
60        <Annotation Term="OData.Description" String="The `ThermalSubsystem` schema contains the definition for the thermal subsystem of a chassis."/>
61        <Annotation Term="OData.LongDescription" String="This resource shall represent a thermal subsystem for a Redfish implementation."/>
62        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
63        <Annotation Term="Capabilities.InsertRestrictions">
64          <Record>
65            <PropertyValue Property="Insertable" Bool="false"/>
66          </Record>
67        </Annotation>
68        <Annotation Term="Capabilities.UpdateRestrictions">
69          <Record>
70            <PropertyValue Property="Updatable" Bool="false"/>
71          </Record>
72        </Annotation>
73        <Annotation Term="Capabilities.DeleteRestrictions">
74          <Record>
75            <PropertyValue Property="Deletable" Bool="false"/>
76          </Record>
77        </Annotation>
78        <Annotation Term="Redfish.Uris">
79          <Collection>
80            <String>/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem</String>
81          </Collection>
82        </Annotation>
83      </EntityType>
84    </Schema>
85
86    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalSubsystem.v1_0_0">
87      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
88      <Annotation Term="Redfish.Release" String="2020.4"/>
89
90      <EntityType Name="ThermalSubsystem" BaseType="ThermalSubsystem.ThermalSubsystem">
91        <Property Name="Status" Type="Resource.Status" Nullable="false">
92          <Annotation Term="OData.Description" String="The status and health of the resource and its subordinate or dependent resources."/>
93          <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
94        </Property>
95        <NavigationProperty Name="Fans" Type="FanCollection.FanCollection" Nullable="false">
96          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
97          <Annotation Term="OData.Description" String="The link to the collection of fans within this subsystem."/>
98          <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type `FanCollection`."/>
99          <Annotation Term="OData.AutoExpandReferences"/>
100        </NavigationProperty>
101        <Property Name="FanRedundancy" Type="Collection(Redundancy.RedundantGroup)" Nullable="false">
102          <Annotation Term="OData.Description" String="The redundancy information for the groups of fans in this subsystem."/>
103          <Annotation Term="OData.LongDescription" String="This property shall contain redundancy information for the groups of fans in this subsystem."/>
104        </Property>
105        <NavigationProperty Name="ThermalMetrics" Type="ThermalMetrics.ThermalMetrics" Nullable="false">
106          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
107          <Annotation Term="OData.Description" String="The link to the summary of thermal metrics for this subsystem."/>
108          <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type `ThermalMetrics`."/>
109          <Annotation Term="OData.AutoExpandReferences"/>
110        </NavigationProperty>
111        <Property Name="Actions" Type="ThermalSubsystem.v1_0_0.Actions" Nullable="false">
112          <Annotation Term="OData.Description" String="The available actions for this resource."/>
113          <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
114        </Property>
115      </EntityType>
116
117      <ComplexType Name="Actions">
118        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
119        <Annotation Term="OData.Description" String="The available actions for this resource."/>
120        <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
121        <Property Name="Oem" Type="ThermalSubsystem.v1_0_0.OemActions" Nullable="false">
122          <Annotation Term="OData.Description" String="This property contains the available OEM-specific actions for this resource."/>
123          <Annotation Term="OData.LongDescription" String="This property shall contain any additional OEM actions for this resource."/>
124        </Property>
125      </ComplexType>
126
127      <ComplexType Name="OemActions">
128        <Annotation Term="OData.AdditionalProperties" Bool="true"/>
129        <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
130        <Annotation Term="OData.LongDescription" String="This type shall contain any additional OEM actions for this resource."/>
131      </ComplexType>
132    </Schema>
133
134    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalSubsystem.v1_0_1">
135      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
136      <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
137      <EntityType Name="ThermalSubsystem" BaseType="ThermalSubsystem.v1_0_0.ThermalSubsystem"/>
138    </Schema>
139
140    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalSubsystem.v1_0_2">
141      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
142      <Annotation Term="OData.Description" String="This version was created to force the regeneration of OpenAPI schemas to properly express nullable properties with external references.  It was also created to correct various typographical errors."/>
143      <EntityType Name="ThermalSubsystem" BaseType="ThermalSubsystem.v1_0_1.ThermalSubsystem"/>
144    </Schema>
145
146    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalSubsystem.v1_1_0">
147      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
148      <Annotation Term="Redfish.Release" String="2022.3"/>
149
150      <EntityType Name="ThermalSubsystem" BaseType="ThermalSubsystem.v1_0_0.ThermalSubsystem">
151        <NavigationProperty Name="Heaters" Type="HeaterCollection.HeaterCollection" Nullable="false">
152          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
153          <Annotation Term="OData.Description" String="The link to the collection of heaters within this subsystem."/>
154          <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type `HeaterCollection`."/>
155          <Annotation Term="OData.AutoExpandReferences"/>
156        </NavigationProperty>
157      </EntityType>
158    </Schema>
159
160    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalSubsystem.v1_1_1">
161      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
162      <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
163      <EntityType Name="ThermalSubsystem" BaseType="ThermalSubsystem.v1_1_0.ThermalSubsystem"/>
164    </Schema>
165
166    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalSubsystem.v1_1_2">
167      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
168      <Annotation Term="OData.Description" String="This version was created to force the regeneration of OpenAPI schemas to properly express nullable properties with external references.  It was also created to correct various typographical errors."/>
169      <EntityType Name="ThermalSubsystem" BaseType="ThermalSubsystem.v1_1_1.ThermalSubsystem"/>
170    </Schema>
171
172    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalSubsystem.v1_2_0">
173      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
174      <Annotation Term="Redfish.Release" String="2023.1"/>
175
176      <EntityType Name="ThermalSubsystem" BaseType="ThermalSubsystem.v1_1_0.ThermalSubsystem">
177        <NavigationProperty Name="CoolantConnectors" Type="CoolantConnectorCollection.CoolantConnectorCollection" Nullable="false">
178          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
179          <Annotation Term="OData.Description" String="A link to the coolant connectors for this equipment."/>
180          <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type `CoolantConnectorCollection` that contains the coolant connectors for this equipment."/>
181          <Annotation Term="OData.AutoExpandReferences"/>
182        </NavigationProperty>
183      </EntityType>
184    </Schema>
185
186    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalSubsystem.v1_2_1">
187      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
188      <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
189      <EntityType Name="ThermalSubsystem" BaseType="ThermalSubsystem.v1_2_0.ThermalSubsystem"/>
190    </Schema>
191
192    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalSubsystem.v1_2_2">
193      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
194      <Annotation Term="OData.Description" String="This version was created to force the regeneration of OpenAPI schemas to properly express nullable properties with external references.  It was also created to correct various typographical errors."/>
195      <EntityType Name="ThermalSubsystem" BaseType="ThermalSubsystem.v1_2_1.ThermalSubsystem"/>
196    </Schema>
197
198    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalSubsystem.v1_3_0">
199      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
200      <Annotation Term="Redfish.Release" String="2023.2"/>
201
202      <EntityType Name="ThermalSubsystem" BaseType="ThermalSubsystem.v1_2_0.ThermalSubsystem">
203        <Property Name="CoolantConnectorRedundancy" Type="Collection(Redundancy.RedundantGroup)" Nullable="false">
204          <Annotation Term="OData.Description" String="The redundancy information for the coolant connectors in this subsystem."/>
205          <Annotation Term="OData.LongDescription" String="This property shall contain redundancy information for the set of coolant connectors attached to this equipment.  The values of the `RedundancyGroup` array shall reference resources of type `CoolantConnector`."/>
206        </Property>
207        <NavigationProperty Name="Pumps" Type="PumpCollection.PumpCollection" Nullable="false">
208          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
209          <Annotation Term="OData.Description" String="A link to the pumps for this equipment."/>
210          <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type `PumpCollection` that contains details for the pumps included in this equipment."/>
211          <Annotation Term="OData.AutoExpandReferences"/>
212        </NavigationProperty>
213        <NavigationProperty Name="LeakDetection" Type="LeakDetection.LeakDetection" ContainsTarget="true" Nullable="false">
214          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
215          <Annotation Term="OData.Description" String="The link to the leak detection system within this chassis."/>
216          <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type `LeakDetection`.  This link should be used when the leak detection capabilities are tied to, or are internal to, a particular `Chassis`.  For detection capabilities that are tied to a `CoolingUnit` resource, which may span multiple `Chassis` resources, populating the `LeakDetection` resource under `CoolingUnit` for the relevant equipment is the preferred approach."/>
217          <Annotation Term="OData.AutoExpandReferences"/>
218        </NavigationProperty>
219      </EntityType>
220    </Schema>
221
222    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalSubsystem.v1_3_1">
223      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
224      <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
225      <EntityType Name="ThermalSubsystem" BaseType="ThermalSubsystem.v1_3_0.ThermalSubsystem"/>
226    </Schema>
227
228    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalSubsystem.v1_3_2">
229      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
230      <Annotation Term="OData.Description" String="This version was created to force the regeneration of OpenAPI schemas to properly express nullable properties with external references.  It was also created to correct various typographical errors."/>
231      <EntityType Name="ThermalSubsystem" BaseType="ThermalSubsystem.v1_3_1.ThermalSubsystem"/>
232    </Schema>
233
234    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalSubsystem.v1_3_3">
235      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
236      <Annotation Term="OData.Description" String="This version was created to clarify the usage of `LeakDetection` in single-chassis equipments as compared to multi-chassis cooling equipment."/>
237      <EntityType Name="ThermalSubsystem" BaseType="ThermalSubsystem.v1_3_2.ThermalSubsystem"/>
238    </Schema>
239
240    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ThermalSubsystem.v1_4_0">
241      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
242      <Annotation Term="Redfish.Release" String="2025.2"/>
243
244      <EntityType Name="ThermalSubsystem" BaseType="ThermalSubsystem.v1_3_3.ThermalSubsystem">
245        <NavigationProperty Name="Filters" Type="FilterCollection.FilterCollection" Nullable="false">
246          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
247          <Annotation Term="OData.Description" String="A link to the filters for this equipment."/>
248          <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type `FilterCollection` that contains the filters for this equipment."/>
249          <Annotation Term="OData.AutoExpandReferences"/>
250        </NavigationProperty>
251      </EntityType>
252    </Schema>
253
254  </edmx:DataServices>
255</edmx:Edmx>
256