summaryrefslogtreecommitdiff
path: root/static/redfish/v1/schema/OemManager_v1.xml
blob: 4554db40bc345e33dfda6e6cbe80094680ef7cbb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
<?xml version="1.0" encoding="UTF-8"?>
<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://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
        <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
        <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
    </edmx:Reference>
    <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Manager_v1.xml">
        <edmx:Include Namespace="Manager"/>
        <edmx:Include Namespace="Manager.v1_4_0"/>
    </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/Chassis_v1.xml">
        <edmx:Include Namespace="Chassis"/>
    </edmx:Reference>

    <edmx:DataServices>
        <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="OemManager">
            <ComplexType Name="Oem" BaseType="Resource.OemObject">
                <Annotation Term="OData.AdditionalProperties" Bool="true" />
                <Annotation Term="OData.Description" String="OemManager Oem properties." />
                <Annotation Term="OData.AutoExpand"/>
                <Property Name="OpenBmc" Type="OemManager.OpenBmc"/>
            </ComplexType>

            <ComplexType Name="OpenBmc">
                <Annotation Term="OData.AdditionalProperties" Bool="true" />
                <Annotation Term="OData.Description" String="Oem properties for OpenBmc." />
                <Annotation Term="OData.AutoExpand"/>
                <Property Name="Fan" Type="OemManager.Fan"/>
            </ComplexType>

            <ComplexType Name="Fan">
                <Annotation Term="OData.AdditionalProperties" Bool="true" />
                <Annotation Term="OData.Description" String="OpenBmc oem fan properties." />
                <Annotation Term="OData.AutoExpand"/>
                <Property Name="FanControllers" Type="OemManager.FanControllers"/>
                <Property Name="PidControllers" Type="OemManager.PidControllers"/>
                <Property Name="StepwiseControllers" Type="OemManager.StepwiseControllers"/>
                <Property Name="FanZones" Type="OemManager.FanZones"/>
                <Property Name="Profile" Type="Edm.String">
                    <Annotation Term="OData.Description" String="Current thermal profile."/>
                    <Annotation Term="OData.LongDescription" String="Current thermal profile."/>
                </Property>

            </ComplexType>

            <ComplexType Name="FanControllers" BaseType="Resource.OemObject">
                <Annotation Term="OData.AdditionalProperties" Bool="true" />
                <Annotation Term="OData.Description" String="OpenBmc FanControllers." />
                <Annotation Term="OData.LongDescription" String="Container for OpenBmc fan controllers." />
                <Annotation Term="Redfish.DynamicPropertyPatterns">
                    <Collection>
                        <NavigationProperty Type="OemManager.FanController">
                            <Annotation Term="OData.AutoExpand"/>
                            <PropertyValue Property="Pattern" String="[A-Za-z0-9_.:]+" />
                            <PropertyValue Property="Type" String="OemManager.FanController" />
                        </NavigationProperty>
                    </Collection>
                </Annotation>
            </ComplexType>

            <ComplexType Name="PidControllers" BaseType="Resource.OemObject">
                <Annotation Term="OData.AdditionalProperties" Bool="true" />
                <Annotation Term="OData.Description" String="OpenBmc PidControllers." />
                <Annotation Term="OData.LongDescription" String="Container for OpenBmc pid controllers." />
                <Annotation Term="Redfish.DynamicPropertyPatterns">
                    <Collection>
                        <NavigationProperty>
                            <Annotation Term="OData.AutoExpand"/>
                            <PropertyValue Property="Pattern" String="[A-Za-z0-9_.:]+" />
                            <PropertyValue Property="Type" String="OemManager.PidController" />
                        </NavigationProperty>
                    </Collection>
                </Annotation>
            </ComplexType>

            <ComplexType Name="StepwiseControllers" BaseType="Resource.OemObject">
                <Annotation Term="OData.AdditionalProperties" Bool="true" />
                <Annotation Term="OData.Description" String="OpenBmc StepwiseControllers." />
                <Annotation Term="OData.LongDescription" String="Container for OpenBmc Stepwise controllers." />
                <Annotation Term="Redfish.DynamicPropertyPatterns">
                    <Collection>
                        <NavigationProperty>
                            <Annotation Term="OData.AutoExpand"/>
                            <PropertyValue Property="Pattern" String="[A-Za-z0-9_.:]+" />
                            <PropertyValue Property="Type" String="OemManager.StepwiseController" />
                        </NavigationProperty>
                    </Collection>
                </Annotation>
            </ComplexType>

            <ComplexType Name="FanZones" BaseType="Resource.OemObject">
                <Annotation Term="OData.AdditionalProperties" Bool="true" />
                <Annotation Term="OData.Description" String="OpenBmc FanZones." />
                <Annotation Term="OData.LongDescription" String="Container for OpenBmc fan zones." />
                <Annotation Term="Redfish.DynamicPropertyPatterns">
                    <Collection>
                        <NavigationProperty>
                            <Annotation Term="OData.AutoExpand"/>
                            <PropertyValue Property="Pattern" String="[A-Za-z0-9_.:]+" />
                            <PropertyValue Property="Type" String="OemManager.FanZone" />
                        </NavigationProperty>
                    </Collection>
                </Annotation>
            </ComplexType>

            <ComplexType Name="FanController" BaseType="Resource.OemObject">
                <Annotation Term="OData.AdditionalProperties" Bool="false" />
                <Annotation Term="OData.Description" String="Configuration data for Fan Controllers." />
                <Property Name="FFGainCoefficient" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Feed forward gain coefficient for the PID." />
                    <Annotation Term="OData.LongDescription" String="Feed forward gain coefficient for the PID." />
                </Property>
                <Property Name="FFOffCoefficient" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Feed forward offset coefficient for the PID." />
                    <Annotation Term="OData.LongDescription" String="Feed forward offset coefficient for the PID." />
                </Property>
                <Property Name="ICoefficient" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Integral Coefficient for the PID." />
                    <Annotation Term="OData.LongDescription" String="Integral Coefficient for the PID." />
                </Property>
                <Property Name="ILimitMax" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Integral limit maxiumum for the PID." />
                    <Annotation Term="OData.LongDescription" String="Integral limit maxiumum for the PID." />
                </Property>
                <Property Name="ILimitMin" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Integral limit miniumum for the PID." />
                    <Annotation Term="OData.LongDescription" String="Integral limit miniumum for the PID." />
                </Property>
                <Property Name="Inputs" Type="Collection(Edm.String)">
                    <Annotation Term="OData.Description" String="Input sensors to the PID controller."/>
                    <Annotation Term="OData.LongDescription" String="Input sensors to the PID controller."/>
                </Property>
                <Property Name="OutLimitMax" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Output limit maxiumum for the pwm." />
                    <Annotation Term="OData.LongDescription" String="Output limit maxiumum for the pwm." />
                </Property>
                <Property Name="OutLimitMin" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Output limit minimum for the pwm." />
                    <Annotation Term="OData.LongDescription" String="Output limit minimum for the pwm." />
                </Property>
                <Property Name="NegativeHysteresis" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Negative hysteresis for the controller." />
                    <Annotation Term="OData.LongDescription" String="Negative hysteresis for the controller." />
               </Property>
                <Property Name="PositiveHysteresis" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Positive hysteresis for the controller." />
                    <Annotation Term="OData.LongDescription" String="Positive hysteresis for the controller." />
               </Property>
                <Property Name="Outputs" Type="Collection(Edm.String)">
                    <Annotation Term="OData.Description" String="Output sensors to the PID controller."/>
                    <Annotation Term="OData.LongDescription" String="Output sensors to the PID controller."/>
                </Property>
                <Property Name="PCoefficient" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Polynomial coefficient for the PID." />
                    <Annotation Term="OData.LongDescription" String="Polynomial coefficient for the PID." />
                </Property>
                <Property Name="SlewNeg" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Negative slew rate for the PID." />
                    <Annotation Term="OData.LongDescription" String="Negative slew rate for the PID." />
                </Property>
                <Property Name="SlewPos" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Positive slew rate for the PID." />
                    <Annotation Term="OData.LongDescription" String="Positive slew rate for the PID." />
                </Property>
                <NavigationProperty Name="Zones" Type="Collection(OemManager.FanZone)">
                    <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read" />
                    <Annotation Term="OData.Description" String="Contains the Zones that this PID contributes to." />
                    <Annotation Term="OData.AutoExpandReferences"/>
                </NavigationProperty>
            </ComplexType>

            <ComplexType Name="FanZone" BaseType="Resource.OemObject">
                <Annotation Term="OData.AdditionalProperties" Bool="false" />
                <Annotation Term="OData.Description" String="Configuration data for Fan Controllers." />
                <Property Name="FailSafePercent" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="If the sensors are in fail-safe mode, this is the percentage to use." />
                    <Annotation Term="OData.LongDescription" String="If the sensors are in fail-safe mode, this is the percentage to use." />
                </Property>
                <Property Name="MinThermalOutput" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Minimum thermal RPM that can be set in this Zone." />
                    <Annotation Term="OData.LongDescription" String="Minimum thermal RPM that can be set in this Zone." />
                </Property>
                <NavigationProperty Name="Chassis" Type="Chassis.Chassis">
                    <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
                    <Annotation Term="OData.Description" String="The Chassis that enables this Zone."/>
                    <Annotation Term="OData.AutoExpandReferences"/>
                </NavigationProperty>
            </ComplexType>

            <ComplexType Name="PidController" BaseType="Resource.OemObject">
                <Annotation Term="OData.AdditionalProperties" Bool="false" />
                <Annotation Term="OData.Description" String="Configuration data for Fan Controllers." />
                <Property Name="FFGainCoefficient" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Feed forward gain coefficient for the PID." />
                    <Annotation Term="OData.LongDescription" String="Feed forward gain coefficient for the PID." />
                </Property>
                <Property Name="FFOffCoefficient" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Feed forward offset coefficient for the PID." />
                    <Annotation Term="OData.LongDescription" String="Feed forward offset coefficient for the PID." />
                </Property>
                <Property Name="ICoefficient" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Integral Coefficient for the PID." />
                    <Annotation Term="OData.LongDescription" String="Integral Coefficient for the PID." />
                </Property>
                <Property Name="ILimitMax" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Integral limit maxiumum for the PID." />
                    <Annotation Term="OData.LongDescription" String="Integral limit maxiumum for the PID." />
                </Property>
                <Property Name="ILimitMin" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Integral limit miniumum for the PID." />
                    <Annotation Term="OData.LongDescription" String="Integral limit miniumum for the PID." />
                </Property>
                <Property Name="Inputs" Type="Collection(Edm.String)">
                    <Annotation Term="OData.Description" String="Input sensors to the PID controller."/>
                    <Annotation Term="OData.LongDescription" String="Input sensors to the PID controller."/>
                </Property>
                <Property Name="OutLimitMax" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Output limit maxiumum for the pwm." />
                    <Annotation Term="OData.LongDescription" String="Output limit maxiumum for the pwm." />
                </Property>
                <Property Name="OutLimitMin" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Output limit minimum for the pwm." />
                    <Annotation Term="OData.LongDescription" String="Output limit minimum for the pwm." />
                </Property>
                <Property Name="NegativeHysteresis" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Negative hysteresis for the controller." />
                    <Annotation Term="OData.LongDescription" String="Negative hysteresis for the controller." />
               </Property>
                <Property Name="PositiveHysteresis" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Positive hysteresis for the controller." />
                    <Annotation Term="OData.LongDescription" String="Positive hysteresis for the controller." />
               </Property>
                <Property Name="PCoefficient" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Polynomial coefficient for the PID." />
                    <Annotation Term="OData.LongDescription" String="Polynomial coefficient for the PID." />
                </Property>
               <Property Name="SetPoint" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Setpoint for the PID." />
                    <Annotation Term="OData.LongDescription" String="Setpoint for the PID." />
                </Property>
                <Property Name="SetPointOffset" Type="Edm.String" Nullable="false">
                    <Annotation Term="OData.Description" String="Threshold to take value from and apply to setpoint." />
                    <Annotation Term="OData.LongDescription" String="Threshold to take value from and apply to setpoint. Valid threshold names are supported." />
                </Property>
                <Property Name="SlewNeg" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Negative slew rate for the PID." />
                    <Annotation Term="OData.LongDescription" String="Negative slew rate for the PID." />
                </Property>
                <Property Name="SlewPos" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Positive slew rate for the PID." />
                    <Annotation Term="OData.LongDescription" String="Positive slew rate for the PID." />
                </Property>
                <NavigationProperty Name="Zones" Type="Collection(OemManager.FanZone)">
                    <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read" />
                    <Annotation Term="OData.Description" String="Contains the Zones that this PID contributes to." />
                    <Annotation Term="OData.AutoExpandReferences"/>
                </NavigationProperty>
            </ComplexType>

            <ComplexType Name="StepwiseController" BaseType="Resource.OemObject">
                <Annotation Term="OData.AdditionalProperties" Bool="false" />
                <Annotation Term="OData.Description" String="Configuration data for Stepwise Controllers." />
                <Property Name="Inputs" Type="Collection(Edm.String)">
                    <Annotation Term="OData.Description" String="Input sensors to the Stepwise controller."/>
                    <Annotation Term="OData.LongDescription" String="Input sensors to the Stepwise controller."/>
                </Property>
                <Property Name="NegativeHysteresis" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Negative Hysteresis for the stepwise controller." />
                    <Annotation Term="OData.LongDescription" String="Negative Hysteresis for the stepwise controller." />
                </Property>
                <Property Name="PositiveHysteresis" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Positive Hysteresis for the stepwise controller." />
                    <Annotation Term="OData.LongDescription" String="Positive Hysteresis for the stepwise controller." />
                </Property>
                <Property Name="Steps" Type="Collection(OemManager.StepwiseSteps)">
                    <Annotation Term="OData.Description" String="Temperature vs RPM steps for the stepwise controller." />
                    <Annotation Term="OData.LongDescription" String="Temperature vs RPM steps for the stepwise controller." />
                    <Annotation Term="OData.AutoExpand"/>
                </Property>
                <Property Name="Direction" Type="Edm.String">
                    <Annotation Term="OData.Description" String="Direction that the stepwise controller applies."/>
                    <Annotation Term="OData.LongDescription" String="Direction that the stepwise controller applies. Options include Ceiling and Floor."/>
                </Property>
                <NavigationProperty Name="Zones" Type="Collection(OemManager.FanZone)">
                    <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read" />
                    <Annotation Term="OData.Description" String="Contains the Zones that this controller contributes to." />
                    <Annotation Term="OData.AutoExpandReferences"/>
                </NavigationProperty>
            </ComplexType>

            <ComplexType Name="StepwiseSteps" BaseType="Resource.OemObject">
                <Property Name="Target" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Input sensor reading for step."/>
                    <Annotation Term="OData.LongDescription" String="Input sensor reading for step."/>
                </Property>
                <Property Name="Output" Type="Edm.Decimal" Nullable="false">
                    <Annotation Term="OData.Description" String="Fan speed setting for step."/>
                    <Annotation Term="OData.LongDescription" String="Fan speed setting for step."/>
                </Property>
            </ComplexType>
        </Schema>
    </edmx:DataServices>
</edmx:Edmx>