summaryrefslogtreecommitdiff
path: root/static/redfish/v1/JsonSchemas/OperatingConfig/OperatingConfig.json
blob: fa29b301d3b0d6a551c80009693ebd8720700540 (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
{
    "$id": "http://redfish.dmtf.org/schemas/v1/OperatingConfig.v1_0_3.json",
    "$ref": "#/definitions/OperatingConfig",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2023 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
    "definitions": {
        "Actions": {
            "additionalProperties": false,
            "description": "The available actions for this resource.",
            "longDescription": "This type shall contain the available actions for this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "Oem": {
                    "$ref": "#/definitions/OemActions",
                    "description": "The available OEM-specific actions for this resource.",
                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
                }
            },
            "type": "object"
        },
        "BaseSpeedPrioritySettings": {
            "additionalProperties": false,
            "description": "The clock speed for a set of cores.",
            "longDescription": "This type shall specify the clock speed for a set of cores.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "BaseSpeedMHz": {
                    "description": "The clock speed to configure the set of cores in MHz.",
                    "longDescription": "This property shall contain the clock speed to configure the set of cores in MHz.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "MHz"
                },
                "CoreCount": {
                    "description": "The number of cores to configure with a specified speed.",
                    "longDescription": "This property shall contain the number of cores to configure with the speed specified by the BaseSpeedMHz property.  The sum of all CoreCount properties shall equal the value of the TotalAvailableCoreCount property.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "CoreIDs": {
                    "description": "The identifier of the cores to configure with the specified speed.",
                    "items": {
                        "type": [
                            "integer",
                            "null"
                        ]
                    },
                    "longDescription": "This property shall contain an array identifying the cores to configure with the speed specified by the BaseSpeedMHz property.  The length of the array shall equal the value of the CoreCount property.",
                    "readonly": true,
                    "type": "array"
                }
            },
            "type": "object"
        },
        "OemActions": {
            "additionalProperties": true,
            "description": "The available OEM-specific actions for this resource.",
            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {},
            "type": "object"
        },
        "OperatingConfig": {
            "additionalProperties": false,
            "description": "The OperatingConfig schema specifies a configuration that can be used when the processor is operational.",
            "longDescription": "This resource shall represent an operational configuration for a processor in the Redfish Specification.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "@odata.context": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
                },
                "@odata.etag": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
                },
                "@odata.id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
                },
                "@odata.type": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
                },
                "Actions": {
                    "$ref": "#/definitions/Actions",
                    "description": "The available actions for this resource.",
                    "longDescription": "This property shall contain the available actions for this resource."
                },
                "BaseSpeedMHz": {
                    "description": "The base (nominal) clock speed of the processor in MHz.",
                    "longDescription": "This property shall contain the base (nominal) clock speed of the processor in MHz.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "MHz"
                },
                "BaseSpeedPrioritySettings": {
                    "description": "The clock speed for sets of cores when the configuration is operational.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "#/definitions/BaseSpeedPrioritySettings"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "This property shall contain an array of objects that specify the clock speed for sets of cores when the configuration is operational.",
                    "type": "array"
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "MaxJunctionTemperatureCelsius": {
                    "description": "The maximum temperature of the junction in degree Celsius units.",
                    "longDescription": "This property shall contain the maximum temperature of the junction in degree Celsius units.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "Cel"
                },
                "MaxSpeedMHz": {
                    "description": "The maximum clock speed to which the processor can be configured in MHz.",
                    "longDescription": "This property shall contain the maximum clock speed to which the processor can be configured in MHz.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "MHz"
                },
                "Name": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
                    "readonly": true
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "The OEM extension property.",
                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
                },
                "TDPWatts": {
                    "description": "The thermal design point of the processor in watt units.",
                    "longDescription": "This property shall contain the thermal design point of the processor in watt units.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "W"
                },
                "TotalAvailableCoreCount": {
                    "description": "The number of cores in the processor that can be configured.",
                    "longDescription": "This property shall contain the number of cores in the processor that can be configured.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "TurboProfile": {
                    "description": "The turbo profiles for the processor.  A turbo profile is the maximum turbo clock speed as a function of the number of active cores.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "#/definitions/TurboProfileDatapoint"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "The property shall contain an array of objects that specify the turbo profile for a set of active cores.",
                    "type": "array"
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        },
        "TurboProfileDatapoint": {
            "additionalProperties": false,
            "description": "The turbo profile for a set of active cores.",
            "longDescription": "This type shall specify the turbo profile for a set of active cores.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "ActiveCoreCount": {
                    "description": "The number of active cores to be configured with the specified maximum clock speed.",
                    "longDescription": "This property shall contain the number of cores to be configured with the maximum turbo clock speed.  The value shall be less than or equal to the TotalAvailableCoreCount property.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "MaxSpeedMHz": {
                    "description": "The maximum turbo clock speed that correspond to the number of active cores in MHz.",
                    "longDescription": "This property shall contain the maximum turbo clock speed that correspond to the number of active cores in MHz.",
                    "minimum": 0,
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "MHz"
                }
            },
            "type": "object"
        }
    },
    "owningEntity": "DMTF",
    "release": "2020.2",
    "title": "#OperatingConfig.v1_0_3.OperatingConfig"
}