blob: 9c8f952dc73c29c9b2223cb7280bad12057325b5 [file] [log] [blame]
Ed Tanous118b1c72018-09-13 13:45:51 -07001{
Ed Tanouscb103132019-10-08 11:34:22 -07002 "$id": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.v1_8_0.json",
Ed Tanous118b1c72018-09-13 13:45:51 -07003 "$ref": "#/definitions/ComputerSystem",
Ed Tanous530520e2019-01-02 13:41:37 -08004 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
Ed Tanouscb103132019-10-08 11:34:22 -07005 "copyright": "Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
Ed Tanous118b1c72018-09-13 13:45:51 -07006 "definitions": {
7 "Actions": {
8 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -07009 "description": "The available actions for this Resource.",
10 "longDescription": "This type shall contain the available actions for this Resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -070011 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070012 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -070013 "description": "This property shall specify a valid odata or Redfish property.",
14 "type": [
15 "array",
16 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -080017 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -070018 "number",
19 "null",
20 "object",
21 "string"
22 ]
23 }
24 },
25 "properties": {
Marri Devender Raod45d2d02019-01-21 10:11:34 -060026 "#ComputerSystem.AddResourceBlock": {
27 "$ref": "#/definitions/AddResourceBlock"
28 },
29 "#ComputerSystem.RemoveResourceBlock": {
30 "$ref": "#/definitions/RemoveResourceBlock"
31 },
Ed Tanous118b1c72018-09-13 13:45:51 -070032 "#ComputerSystem.Reset": {
33 "$ref": "#/definitions/Reset"
34 },
35 "#ComputerSystem.SetDefaultBootOrder": {
36 "$ref": "#/definitions/SetDefaultBootOrder"
37 },
38 "Oem": {
Ed Tanous530520e2019-01-02 13:41:37 -080039 "$ref": "#/definitions/OemActions",
Ed Tanouscb103132019-10-08 11:34:22 -070040 "description": "The available OEM-specific actions for this Resource.",
41 "longDescription": "This property shall contain the available OEM-specific actions for this Resource."
Ed Tanous118b1c72018-09-13 13:45:51 -070042 }
43 },
44 "type": "object"
45 },
Marri Devender Raod45d2d02019-01-21 10:11:34 -060046 "AddResourceBlock": {
47 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -070048 "description": "This action adds a Resource Block to a system.",
49 "longDescription": "This action shall add a Resource Block to a system.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -060050 "parameters": {
51 "ComputerSystemETag": {
52 "description": "The current ETag of the system.",
Ed Tanouscb103132019-10-08 11:34:22 -070053 "longDescription": "This parameter shall contain the current ETag of the system. If the client-provided ETag does not match the current ETag of the system, the service shall return the HTTP 428 (Precondition Required) status code to reject the request.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -060054 "type": "string"
55 },
56 "ResourceBlock": {
57 "$ref": "http://redfish.dmtf.org/schemas/v1/ResourceBlock.json#/definitions/ResourceBlock",
58 "description": "The Resource Block to add to the system.",
Ed Tanouscb103132019-10-08 11:34:22 -070059 "longDescription": "This parameter shall contain a link to the specified Resource Block to add to the system.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -060060 "requiredParameter": true
61 },
62 "ResourceBlockETag": {
63 "description": "The current ETag of the Resource Block to add to the system.",
Ed Tanouscb103132019-10-08 11:34:22 -070064 "longDescription": "This parameter shall contain the current ETag of the Resource Block to add to the system. If the client-provided ETag does not match the current ETag of the Resource Block that the ResourceBlock parameter specifies, the service shall return the HTTP 428 (Precondition Required) status code to reject the request.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -060065 "type": "string"
66 }
67 },
68 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070069 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Marri Devender Raod45d2d02019-01-21 10:11:34 -060070 "description": "This property shall specify a valid odata or Redfish property.",
71 "type": [
72 "array",
73 "boolean",
74 "integer",
75 "number",
76 "null",
77 "object",
78 "string"
79 ]
80 }
81 },
82 "properties": {
83 "target": {
84 "description": "Link to invoke action",
Ed Tanouscb103132019-10-08 11:34:22 -070085 "format": "uri-reference",
Marri Devender Raod45d2d02019-01-21 10:11:34 -060086 "type": "string"
87 },
88 "title": {
89 "description": "Friendly action name",
90 "type": "string"
91 }
92 },
93 "type": "object",
94 "versionAdded": "v1_6_0"
95 },
Ed Tanous118b1c72018-09-13 13:45:51 -070096 "Boot": {
97 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -070098 "description": "The boot information for this Resource.",
99 "longDescription": "This type shall contain properties that describe boot information for a system.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700100 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700101 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700102 "description": "This property shall specify a valid odata or Redfish property.",
103 "type": [
104 "array",
105 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800106 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700107 "number",
108 "null",
109 "object",
110 "string"
111 ]
112 }
113 },
114 "properties": {
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600115 "AliasBootOrder": {
Ed Tanouscb103132019-10-08 11:34:22 -0700116 "description": "Ordered array of boot source aliases representing the persistent boot order associated with this computer system.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600117 "items": {
118 "anyOf": [
119 {
120 "$ref": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.json#/definitions/BootSource"
121 },
122 {
123 "type": "null"
124 }
125 ]
126 },
Ed Tanouscb103132019-10-08 11:34:22 -0700127 "longDescription": "This property shall contain an ordered array of boot source aliases of the BootSource type that represents the persistent boot order of this computer system.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600128 "readonly": false,
129 "type": "array",
130 "versionAdded": "v1_6_0"
131 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700132 "BootNext": {
Ed Tanouscb103132019-10-08 11:34:22 -0700133 "description": "The BootOptionReference of the Boot Option to perform a one-time boot from when BootSourceOverrideTarget is `UefiBootNext`.",
134 "longDescription": "This property shall contain the BootOptionReference of the UEFI boot option for one time boot, as defined by the UEFI Specification. The valid values for this property are specified in the values of the BootOrder array. BootSourceOverrideEnabled set to `Continuous` is not supported for UEFI BootNext because this setting is defined in UEFI as a one-time boot only.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700135 "readonly": false,
136 "type": [
137 "string",
138 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600139 ],
140 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700141 },
142 "BootOptions": {
143 "$ref": "http://redfish.dmtf.org/schemas/v1/BootOptionCollection.json#/definitions/BootOptionCollection",
Ed Tanouscb103132019-10-08 11:34:22 -0700144 "description": "The link to the collection of the UEFI boot options associated with this computer system.",
145 "longDescription": "This property shall contain a link to a Resource Collection of type BootOptionCollection.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600146 "readonly": true,
147 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700148 },
149 "BootOrder": {
Ed Tanouscb103132019-10-08 11:34:22 -0700150 "description": "An array of BootOptionReference strings that represent the persistent boot order for with this computer system.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700151 "items": {
152 "type": [
153 "string",
154 "null"
155 ]
156 },
Ed Tanouscb103132019-10-08 11:34:22 -0700157 "longDescription": "This property shall contain an array of BootOptionReference strings that represent the persistent boot order for this computer system. For UEFI systems, this is the UEFI Specification-defined UEFI BootOrder.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700158 "readonly": false,
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600159 "type": "array",
160 "versionAdded": "v1_5_0"
161 },
162 "BootOrderPropertySelection": {
163 "anyOf": [
164 {
165 "$ref": "#/definitions/BootOrderTypes"
166 },
167 {
168 "type": "null"
169 }
170 ],
Ed Tanouscb103132019-10-08 11:34:22 -0700171 "description": "The name of the boot order property that the system uses for the persistent boot order.",
172 "longDescription": "This property shall indicate which boot order property the system uses for the persistent boot order.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600173 "readonly": false,
174 "versionAdded": "v1_6_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700175 },
176 "BootSourceOverrideEnabled": {
177 "anyOf": [
178 {
179 "$ref": "#/definitions/BootSourceOverrideEnabled"
180 },
181 {
182 "type": "null"
183 }
184 ],
Ed Tanouscb103132019-10-08 11:34:22 -0700185 "description": "The state of the boot source override feature.",
186 "longDescription": "This property shall contain `Once` for a one-time boot override, and `Continuous` for a remain-active-until-cancelled override. The `Continuous` value is not supported for this property for UEFI boot source override because UEFI supports one-time boot only. If set to `Once`, the value is reset to `Disabled` after the BootSourceOverrideTarget actions have completed successfully. Changes to this property do not alter the BIOS persistent boot order configuration.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700187 "readonly": false
188 },
189 "BootSourceOverrideMode": {
190 "anyOf": [
191 {
192 "$ref": "#/definitions/BootSourceOverrideMode"
193 },
194 {
195 "type": "null"
196 }
197 ],
Ed Tanouscb103132019-10-08 11:34:22 -0700198 "description": "The BIOS boot mode to use when the system boots from the BootSourceOverrideTarget boot source.",
199 "longDescription": "This property shall contain the BIOS boot mode to use when the system boots from the BootSourceOverrideTarget boot source.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600200 "readonly": false,
201 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700202 },
203 "BootSourceOverrideTarget": {
204 "anyOf": [
205 {
206 "$ref": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.json#/definitions/BootSource"
207 },
208 {
209 "type": "null"
210 }
211 ],
Ed Tanouscb103132019-10-08 11:34:22 -0700212 "description": "The current boot source to use at the next boot instead of the normal boot device, if BootSourceOverrideEnabled is `true`.",
213 "longDescription": "This property shall contain the source to boot the system from, overriding the normal boot order. The Redfish.AllowableValues annotation specifies the valid values for this property. `Pxe` indicates to PXE boot from the primary NIC; `Floppy`, `Cd`, `Usb`, and `Hdd` indicate to boot from their devices respectively. `BiosSetup` indicates to boot into the native BIOS screen setup. `Utilities` and `Diags` indicate to boot from the local utilities or diags partitions. `UefiTarget` indicates to boot from the UEFI device path found in UefiTargetBootSourceOverride. `UefiBootNext` indicates to boot from the UEFI BootOptionReference found in BootNext. Changes to this property do not alter the BIOS persistent boot order configuration.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700214 "readonly": false
215 },
Ed Tanouscb103132019-10-08 11:34:22 -0700216 "Certificates": {
217 "$ref": "http://redfish.dmtf.org/schemas/v1/CertificateCollection.json#/definitions/CertificateCollection",
218 "description": "The link to a collection of certificates used for booting through HTTPS by this computer system.",
219 "longDescription": "This property shall contain a link to a Resource Collection of type CertificateCollection.",
220 "readonly": true,
221 "versionAdded": "v1_7_0"
222 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700223 "UefiTargetBootSourceOverride": {
Ed Tanouscb103132019-10-08 11:34:22 -0700224 "description": "The UEFI device path of the device from which to boot when BootSourceOverrideTarget is `UefiTarget`.",
225 "longDescription": "This property shall contain the UEFI device path of the override boot target. The Redfish.AllowableValues annotation specifies the values for this property. The `Continuous` value is not supported for the BootSourceOverrideEnabled property for UEFI boot source override because UEFI supports one-time boot only. Changes to this property do not alter the BIOS persistent boot order configuration.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700226 "readonly": false,
227 "type": [
228 "string",
229 "null"
230 ]
231 }
232 },
233 "type": "object"
234 },
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600235 "BootOrderTypes": {
236 "description": "The enumerations of BootOrderTypes specify the choice of boot order property to use when controller the persistent boot order for this computer system.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700237 "enum": [
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600238 "BootOrder",
239 "AliasBootOrder"
Ed Tanous118b1c72018-09-13 13:45:51 -0700240 ],
241 "enumDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700242 "AliasBootOrder": "The system uses the AliasBootOrder property to specify the persistent boot order.",
243 "BootOrder": "The system uses the BootOrder property to specify the persistent boot order."
Ed Tanous118b1c72018-09-13 13:45:51 -0700244 },
245 "type": "string"
246 },
247 "BootSourceOverrideEnabled": {
248 "enum": [
249 "Disabled",
250 "Once",
251 "Continuous"
252 ],
253 "enumDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700254 "Continuous": "The system boots to the target specified in the BootSourceOverrideTarget property until this property is `Disabled`.",
255 "Disabled": "The system boots normally.",
256 "Once": "On its next boot cycle, the system boots one time to the boot source override target. Then, the BootSourceOverrideEnabled value is reset to `Disabled`."
Ed Tanous118b1c72018-09-13 13:45:51 -0700257 },
258 "type": "string"
259 },
260 "BootSourceOverrideMode": {
261 "enum": [
262 "Legacy",
263 "UEFI"
264 ],
265 "enumDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700266 "Legacy": "The system boots in non-UEFI boot mode to the boot source override target.",
267 "UEFI": "The system boots in UEFI boot mode to the boot source override target."
Ed Tanous118b1c72018-09-13 13:45:51 -0700268 },
269 "type": "string"
270 },
271 "ComputerSystem": {
272 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -0700273 "description": "The ComputerSystem schema represents a computer or system instance and the software-visible Resources, or items within the data plane, such as memory, CPU, and other devices that it can access. Details of those Resources or subsystems are also linked through this Resource.",
274 "longDescription": "This Resource shall represent a computing system in the Redfish Specification.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700275 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700276 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700277 "description": "This property shall specify a valid odata or Redfish property.",
278 "type": [
279 "array",
280 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800281 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700282 "number",
283 "null",
284 "object",
285 "string"
286 ]
287 }
288 },
289 "properties": {
290 "@odata.context": {
Ed Tanouscb103132019-10-08 11:34:22 -0700291 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
Ed Tanous530520e2019-01-02 13:41:37 -0800292 },
293 "@odata.etag": {
Ed Tanouscb103132019-10-08 11:34:22 -0700294 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
Ed Tanous118b1c72018-09-13 13:45:51 -0700295 },
296 "@odata.id": {
Ed Tanouscb103132019-10-08 11:34:22 -0700297 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
Ed Tanous118b1c72018-09-13 13:45:51 -0700298 },
299 "@odata.type": {
Ed Tanouscb103132019-10-08 11:34:22 -0700300 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
Ed Tanous118b1c72018-09-13 13:45:51 -0700301 },
302 "Actions": {
303 "$ref": "#/definitions/Actions",
Ed Tanouscb103132019-10-08 11:34:22 -0700304 "description": "The available actions for this Resource.",
305 "longDescription": "This property shall contain the available actions for this Resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700306 },
307 "AssetTag": {
Ed Tanouscb103132019-10-08 11:34:22 -0700308 "description": "The user-definable tag that can track this computer system for inventory or other client purposes.",
309 "longDescription": "This property shall contain the system asset tag value.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700310 "readonly": false,
311 "type": [
312 "string",
313 "null"
314 ]
315 },
316 "Bios": {
317 "$ref": "http://redfish.dmtf.org/schemas/v1/Bios.json#/definitions/Bios",
Ed Tanouscb103132019-10-08 11:34:22 -0700318 "description": "The link to the BIOS settings associated with this system.",
319 "longDescription": "This property shall contain a link to a Resource of type Bios that lists the BIOS settings for this system.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600320 "readonly": true,
321 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700322 },
323 "BiosVersion": {
324 "description": "The version of the system BIOS or primary system firmware.",
Ed Tanouscb103132019-10-08 11:34:22 -0700325 "longDescription": "This property shall contain the version string of the currently installed and running BIOS for x86 systems. For other systems, the property may contain a version string that represents the primary system firmware.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700326 "readonly": true,
327 "type": [
328 "string",
329 "null"
330 ]
331 },
332 "Boot": {
333 "$ref": "#/definitions/Boot",
Ed Tanouscb103132019-10-08 11:34:22 -0700334 "description": "The boot settings for this system.",
335 "longDescription": "This property shall contain the boot settings for this system."
Ed Tanous118b1c72018-09-13 13:45:51 -0700336 },
337 "Description": {
338 "anyOf": [
339 {
340 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
341 },
342 {
343 "type": "null"
344 }
345 ],
346 "readonly": true
347 },
348 "EthernetInterfaces": {
349 "$ref": "http://redfish.dmtf.org/schemas/v1/EthernetInterfaceCollection.json#/definitions/EthernetInterfaceCollection",
Ed Tanouscb103132019-10-08 11:34:22 -0700350 "description": "The link to the collection of Ethernet interfaces associated with this system.",
351 "longDescription": "This property shall contain a link to a Resource Collection of type EthernetInterfaceCollection.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700352 "readonly": true
353 },
354 "HostName": {
Ed Tanouscb103132019-10-08 11:34:22 -0700355 "description": "The DNS host name, without any domain information.",
356 "longDescription": "This property shall contain the host name for this system, as reported by the operating system or hypervisor. A service running in the host operating system typically reports this value to the manager.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700357 "readonly": false,
358 "type": [
359 "string",
360 "null"
361 ]
362 },
363 "HostWatchdogTimer": {
364 "$ref": "#/definitions/WatchdogTimer",
Ed Tanouscb103132019-10-08 11:34:22 -0700365 "description": "The host watchdog timer functionality for this system.",
366 "longDescription": "This object shall contain properties that describe the host watchdog timer functionality for this ComputerSystem.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600367 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700368 },
369 "HostedServices": {
370 "$ref": "#/definitions/HostedServices",
371 "description": "The services that this computer system supports.",
Ed Tanouscb103132019-10-08 11:34:22 -0700372 "longDescription": "This property shall describe services that this computer system supports.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600373 "versionAdded": "v1_2_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700374 },
375 "HostingRoles": {
Ed Tanouscb103132019-10-08 11:34:22 -0700376 "description": "The hosting roles that this computer system supports.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700377 "items": {
378 "$ref": "#/definitions/HostingRole"
379 },
Ed Tanouscb103132019-10-08 11:34:22 -0700380 "longDescription": "This property shall contain the hosting roles that this computer system supports.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700381 "readonly": true,
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600382 "type": "array",
383 "versionAdded": "v1_2_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700384 },
385 "Id": {
386 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
387 "readonly": true
388 },
389 "IndicatorLED": {
390 "anyOf": [
391 {
392 "$ref": "#/definitions/IndicatorLED"
393 },
394 {
395 "type": "null"
396 }
397 ],
Ed Tanouscb103132019-10-08 11:34:22 -0700398 "description": "The state of the indicator LED, which identifies the system.",
399 "longDescription": "This property shall contain the state of the indicator light, which identifies this system.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700400 "readonly": false
401 },
402 "Links": {
403 "$ref": "#/definitions/Links",
Ed Tanouscb103132019-10-08 11:34:22 -0700404 "description": "The links to other Resources that are related to this Resource.",
405 "longDescription": "The Redfish Specification-described Links Property shall contain links to Resources related to but not subordinate to this Resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700406 },
407 "LogServices": {
408 "$ref": "http://redfish.dmtf.org/schemas/v1/LogServiceCollection.json#/definitions/LogServiceCollection",
Ed Tanouscb103132019-10-08 11:34:22 -0700409 "description": "The link to the collection of Log Services associated with this system.",
410 "longDescription": "This property shall contain a link to a Resource Collection of type LogServiceCollection.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700411 "readonly": true
412 },
413 "Manufacturer": {
414 "description": "The manufacturer or OEM of this system.",
Ed Tanouscb103132019-10-08 11:34:22 -0700415 "longDescription": "This property shall contain a value that represents the manufacturer of the system.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700416 "readonly": true,
417 "type": [
418 "string",
419 "null"
420 ]
421 },
422 "Memory": {
423 "$ref": "http://redfish.dmtf.org/schemas/v1/MemoryCollection.json#/definitions/MemoryCollection",
Ed Tanouscb103132019-10-08 11:34:22 -0700424 "description": "The link to the collection of memory associated with this system.",
425 "longDescription": "This property shall contain a link to a Resource Collection of type MemoryCollection.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600426 "readonly": true,
427 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700428 },
429 "MemoryDomains": {
Ed Tanouscb103132019-10-08 11:34:22 -0700430 "$ref": "http://redfish.dmtf.org/schemas/v1/MemoryDomainCollection.json#/definitions/MemoryDomainCollection",
431 "description": "The link to the collection of memory domains associated with this system.",
432 "longDescription": "This property shall contain a link to a Resource Collection of type MemoryDomainCollection.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600433 "readonly": true,
434 "versionAdded": "v1_2_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700435 },
436 "MemorySummary": {
437 "$ref": "#/definitions/MemorySummary",
Ed Tanouscb103132019-10-08 11:34:22 -0700438 "description": "The central memory of the system in general detail.",
439 "longDescription": "This property shall describe the central memory for this Resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700440 },
441 "Model": {
442 "description": "The product name for this system, without the manufacturer name.",
Ed Tanouscb103132019-10-08 11:34:22 -0700443 "longDescription": "This property shall describe how the manufacturer refers to this system. Typically, this value is the product name for this system without the manufacturer name.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700444 "readonly": true,
445 "type": [
446 "string",
447 "null"
448 ]
449 },
450 "Name": {
451 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
452 "readonly": true
453 },
454 "NetworkInterfaces": {
455 "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkInterfaceCollection.json#/definitions/NetworkInterfaceCollection",
Ed Tanouscb103132019-10-08 11:34:22 -0700456 "description": "The link to the collection of Network Interfaces associated with this system.",
457 "longDescription": "This property shall contain a link to a Resource Collection of type NetworkInterfaceCollection.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600458 "readonly": true,
459 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700460 },
461 "Oem": {
462 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700463 "description": "The OEM extension property.",
464 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
Ed Tanous118b1c72018-09-13 13:45:51 -0700465 },
466 "PCIeDevices": {
Ed Tanouscb103132019-10-08 11:34:22 -0700467 "description": "The link to a collection of PCIe devices that this computer system uses.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700468 "items": {
469 "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeDevice"
470 },
Ed Tanouscb103132019-10-08 11:34:22 -0700471 "longDescription": "This property shall contain an array of links of the PCIeDevice type.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700472 "readonly": true,
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600473 "type": "array",
474 "versionAdded": "v1_2_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700475 },
476 "PCIeDevices@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700477 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700478 },
479 "PCIeFunctions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700480 "description": "The link to a collection of PCIe functions that this computer system uses.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700481 "items": {
482 "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeFunction.json#/definitions/PCIeFunction"
483 },
Ed Tanouscb103132019-10-08 11:34:22 -0700484 "longDescription": "This property shall contain an array of links of the PCIeFunction type.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700485 "readonly": true,
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600486 "type": "array",
487 "versionAdded": "v1_2_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700488 },
489 "PCIeFunctions@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700490 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700491 },
492 "PartNumber": {
493 "description": "The part number for this system.",
Ed Tanouscb103132019-10-08 11:34:22 -0700494 "longDescription": "This property shall contain the manufacturer-defined part number for the system.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700495 "readonly": true,
496 "type": [
497 "string",
498 "null"
499 ]
500 },
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600501 "PowerRestorePolicy": {
502 "$ref": "#/definitions/PowerRestorePolicyTypes",
503 "description": "The desired power state of the system when power is restored after a power loss.",
Ed Tanouscb103132019-10-08 11:34:22 -0700504 "longDescription": "This property shall indicate the desired PowerState of the system when power is applied to the system. The `LastState` value shall return the system to the PowerState it was in when power was lost.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600505 "readonly": false,
506 "versionAdded": "v1_6_0"
507 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700508 "PowerState": {
509 "anyOf": [
510 {
511 "$ref": "#/definitions/PowerState"
512 },
513 {
514 "type": "null"
515 }
516 ],
Ed Tanouscb103132019-10-08 11:34:22 -0700517 "description": "The current power state of the system.",
518 "longDescription": "This property shall contain the power state of the system.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700519 "readonly": true
520 },
521 "ProcessorSummary": {
522 "$ref": "#/definitions/ProcessorSummary",
Ed Tanouscb103132019-10-08 11:34:22 -0700523 "description": "The central processors of the system in general detail.",
524 "longDescription": "This property shall describe the central processors for this Resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700525 },
526 "Processors": {
527 "$ref": "http://redfish.dmtf.org/schemas/v1/ProcessorCollection.json#/definitions/ProcessorCollection",
Ed Tanouscb103132019-10-08 11:34:22 -0700528 "description": "The link to the collection of processors associated with this system.",
529 "longDescription": "This property shall contain a link to a Resource Collection of type ProcessorCollection.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700530 "readonly": true
531 },
532 "Redundancy": {
Ed Tanous530520e2019-01-02 13:41:37 -0800533 "autoExpand": true,
Ed Tanouscb103132019-10-08 11:34:22 -0700534 "description": "The link to a collection of redundancy entities. Each entity specifies a kind and level of redundancy and a collection, or redundancy set, of other computer systems that provide the specified redundancy to this computer system.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700535 "items": {
536 "$ref": "http://redfish.dmtf.org/schemas/v1/Redundancy.json#/definitions/Redundancy"
537 },
Ed Tanouscb103132019-10-08 11:34:22 -0700538 "longDescription": "This property shall contain a set of redundancy entities. Each entity specifies a kind and level of redundancy and a collection, or redundancy set, of other computer systems that provide the specified redundancy to this computer system.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700539 "readonly": true,
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600540 "type": "array",
541 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700542 },
543 "Redundancy@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700544 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700545 },
546 "SKU": {
547 "description": "The manufacturer SKU for this system.",
Ed Tanouscb103132019-10-08 11:34:22 -0700548 "longDescription": "This property shall contain the SKU for the system.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700549 "readonly": true,
550 "type": [
551 "string",
552 "null"
553 ]
554 },
555 "SecureBoot": {
556 "$ref": "http://redfish.dmtf.org/schemas/v1/SecureBoot.json#/definitions/SecureBoot",
Ed Tanouscb103132019-10-08 11:34:22 -0700557 "description": "The link to the UEFI Secure Boot associated with this system.",
558 "longDescription": "This property shall contain a link to a Resource of type SecureBoot.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600559 "readonly": true,
560 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700561 },
562 "SerialNumber": {
563 "description": "The serial number for this system.",
Ed Tanouscb103132019-10-08 11:34:22 -0700564 "longDescription": "This property shall contain the serial number for the system.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700565 "readonly": true,
566 "type": [
567 "string",
568 "null"
569 ]
570 },
571 "SimpleStorage": {
572 "$ref": "http://redfish.dmtf.org/schemas/v1/SimpleStorageCollection.json#/definitions/SimpleStorageCollection",
Ed Tanouscb103132019-10-08 11:34:22 -0700573 "description": "The link to the collection of storage devices associated with this system.",
574 "longDescription": "This property shall contain a link to a Resource Collection of type SimpleStorageCollection.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700575 "readonly": true
576 },
577 "Status": {
Ed Tanous530520e2019-01-02 13:41:37 -0800578 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
Ed Tanouscb103132019-10-08 11:34:22 -0700579 "description": "The status and health of the Resource and its subordinate or dependent Resources.",
580 "longDescription": "This property shall contain any status or health properties of the Resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700581 },
582 "Storage": {
583 "$ref": "http://redfish.dmtf.org/schemas/v1/StorageCollection.json#/definitions/StorageCollection",
Ed Tanouscb103132019-10-08 11:34:22 -0700584 "description": "The link to the collection of storage devices associated with this system.",
585 "longDescription": "This property shall contain a link to a Resource Collection of type StorageCollection.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600586 "readonly": true,
587 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700588 },
589 "SubModel": {
590 "description": "The sub-model for this system.",
Ed Tanouscb103132019-10-08 11:34:22 -0700591 "longDescription": "This property shall contain the information about the sub-model (or config) of the system. This shall not include the model/product name or the manufacturer name.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700592 "readonly": true,
593 "type": [
594 "string",
595 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600596 ],
597 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700598 },
599 "SystemType": {
600 "$ref": "#/definitions/SystemType",
Ed Tanouscb103132019-10-08 11:34:22 -0700601 "description": "The type of computer system that this Resource represents.",
602 "longDescription": "An enumeration that indicates the kind of system that this Resource represents.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700603 "readonly": true
604 },
605 "TrustedModules": {
Ed Tanouscb103132019-10-08 11:34:22 -0700606 "description": "An array of trusted modules in the system.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700607 "items": {
608 "$ref": "#/definitions/TrustedModules"
609 },
Ed Tanouscb103132019-10-08 11:34:22 -0700610 "longDescription": "This object shall contain an array of objects with properties that describe the trusted modules for this Resource.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600611 "type": "array",
612 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700613 },
614 "UUID": {
615 "anyOf": [
616 {
617 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/UUID"
618 },
619 {
620 "type": "null"
621 }
622 ],
Ed Tanouscb103132019-10-08 11:34:22 -0700623 "description": "The UUID for this system.",
624 "longDescription": "This property shall contain the UUID for the system. RFC4122 describes methods to create this value. The value should be considered to be opaque. Client software should only treat the overall value as a UUID and should not interpret any sub-fields within the UUID. If the system supports SMBIOS, the property value should follow the SMBIOS 2.6 and later recommendation for converting the SMBIOS 16-byte UUID structure into the Redfish canonical `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` string format, so that the property value matches the byte order presented by current OS APIs, such as WMI and dmidecode.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700625 "readonly": true
626 }
627 },
628 "required": [
Ed Tanous530520e2019-01-02 13:41:37 -0800629 "@odata.id",
630 "@odata.type",
Ed Tanous118b1c72018-09-13 13:45:51 -0700631 "Id",
632 "Name"
633 ],
634 "type": "object"
635 },
636 "HostedServices": {
637 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -0700638 "description": "The services that may be running or installed on the system.",
639 "longDescription": "This type shall describe services that a computer system supports.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700640 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700641 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700642 "description": "This property shall specify a valid odata or Redfish property.",
643 "type": [
644 "array",
645 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800646 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700647 "number",
648 "null",
649 "object",
650 "string"
651 ]
652 }
653 },
654 "properties": {
655 "Oem": {
Ed Tanous530520e2019-01-02 13:41:37 -0800656 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700657 "description": "The OEM extension property.",
658 "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600659 "versionAdded": "v1_2_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700660 },
661 "StorageServices": {
662 "$ref": "http://redfish.dmtf.org/schemas/swordfish/v1/HostedStorageServices.json#/definitions/HostedStorageServices",
Ed Tanouscb103132019-10-08 11:34:22 -0700663 "description": "The link to a collection of storage services that this computer system supports.",
664 "longDescription": "This property shall contain a link to a Resource Collection of type HostedStorageServices.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600665 "readonly": true,
666 "versionAdded": "v1_2_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700667 }
668 },
669 "type": "object"
670 },
671 "HostingRole": {
672 "description": "The enumerations of HostingRoles specify different features that the hosting ComputerSystem supports.",
673 "enum": [
674 "ApplicationServer",
675 "StorageServer",
676 "Switch"
677 ],
678 "enumDescriptions": {
679 "ApplicationServer": "The system hosts functionality that supports general purpose applications.",
680 "StorageServer": "The system hosts functionality that supports the system acting as a storage server.",
681 "Switch": "The system hosts functionality that supports the system acting as a switch."
682 },
683 "type": "string"
684 },
685 "IndicatorLED": {
686 "enum": [
687 "Unknown",
688 "Lit",
689 "Blinking",
690 "Off"
691 ],
692 "enumDeprecated": {
Ed Tanouscb103132019-10-08 11:34:22 -0700693 "Unknown": "This value has been deprecated in favor of returning null if the state is unknown."
Ed Tanous118b1c72018-09-13 13:45:51 -0700694 },
695 "enumDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700696 "Blinking": "The indicator LED is blinking.",
697 "Lit": "The indicator LED is lit.",
698 "Off": "The indicator LED is off.",
699 "Unknown": "The state of the indicator LED cannot be determined."
Ed Tanous118b1c72018-09-13 13:45:51 -0700700 },
701 "enumLongDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700702 "Blinking": "This value shall represent that the indicator LED is in a blinking state where the LED is being turned on and off in repetition. If the service does not support this value, it shall reject PATCH or PUT requests containing this value by returning the HTTP 400 (Bad Request) status code.",
703 "Lit": "This value shall represent that the indicator LED is in a solid on state. If the service does not support this value, it shall reject PATCH or PUT requests containing this value by returning the HTTP 400 (Bad Request) status code.",
704 "Off": "This value shall represent that the indicator LED is in a solid off state. If the service does not support this value, it shall reject PATCH or PUT requests containing this value by returning the HTTP 400 (Bad Request) status code.",
705 "Unknown": "This value shall represent that the indicator LED is in an unknown state. The Service shall reject PATCH or PUT requests containing this value by returning the HTTP 400 (Bad Request) status code."
Ed Tanous118b1c72018-09-13 13:45:51 -0700706 },
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600707 "enumVersionDeprecated": {
708 "Unknown": "v1_1_0"
709 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700710 "type": "string"
711 },
712 "InterfaceType": {
713 "enum": [
714 "TPM1_2",
715 "TPM2_0",
716 "TCM1_0"
717 ],
718 "enumDescriptions": {
719 "TCM1_0": "Trusted Cryptography Module (TCM) 1.0.",
720 "TPM1_2": "Trusted Platform Module (TPM) 1.2.",
721 "TPM2_0": "Trusted Platform Module (TPM) 2.0."
722 },
723 "type": "string"
724 },
725 "InterfaceTypeSelection": {
726 "description": "The enumerations of InterfaceTypeSelection specify the method for switching the TrustedModule InterfaceType, for instance between TPM1_2 and TPM2_0, if supported.",
727 "enum": [
728 "None",
729 "FirmwareUpdate",
730 "BiosSetting",
731 "OemMethod"
732 ],
733 "enumDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700734 "BiosSetting": "The TrustedModule supports switching InterfaceType through platform software, such as a BIOS configuration attribute.",
735 "FirmwareUpdate": "The TrustedModule supports switching InterfaceType through a firmware update.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700736 "None": "The TrustedModule does not support switching the InterfaceType.",
Ed Tanouscb103132019-10-08 11:34:22 -0700737 "OemMethod": "The TrustedModule supports switching InterfaceType through an OEM proprietary mechanism."
Ed Tanous118b1c72018-09-13 13:45:51 -0700738 },
739 "type": "string"
740 },
741 "Links": {
742 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -0700743 "description": "The links to other Resources that are related to this Resource.",
744 "longDescription": "This Redfish Specification-described type shall contain links to Resources that are related to but are not contained by or subordinate to this Resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700745 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700746 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700747 "description": "This property shall specify a valid odata or Redfish property.",
748 "type": [
749 "array",
750 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800751 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700752 "number",
753 "null",
754 "object",
755 "string"
756 ]
757 }
758 },
759 "properties": {
760 "Chassis": {
Ed Tanouscb103132019-10-08 11:34:22 -0700761 "description": "An array of links to the chassis that contains this system.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700762 "items": {
763 "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis"
764 },
Ed Tanouscb103132019-10-08 11:34:22 -0700765 "longDescription": "This property shall link to a Resource of type Chassis that represents the physical container associated with this Resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700766 "readonly": true,
767 "type": "array"
768 },
769 "Chassis@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700770 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700771 },
772 "ConsumingComputerSystems": {
Ed Tanouscb103132019-10-08 11:34:22 -0700773 "description": "An array of links to ComputerSystems that are realized, in whole or in part, from this ComputerSystem.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700774 "items": {
775 "$ref": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.json#/definitions/ComputerSystem"
776 },
Ed Tanouscb103132019-10-08 11:34:22 -0700777 "longDescription": "The value shall be an array of links to ComputerSystems that are realized, in whole or in part, from this ComputerSystem.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700778 "readonly": true,
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600779 "type": "array",
780 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700781 },
782 "ConsumingComputerSystems@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700783 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700784 },
785 "CooledBy": {
Ed Tanouscb103132019-10-08 11:34:22 -0700786 "description": "An array of one or more IDs for Resources that cool this computer system. Normally, the ID is for either a chassis or a specific set of fans.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700787 "items": {
Ed Tanouscb103132019-10-08 11:34:22 -0700788 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef"
Ed Tanous118b1c72018-09-13 13:45:51 -0700789 },
Ed Tanouscb103132019-10-08 11:34:22 -0700790 "longDescription": "This property shall contain an array of IDs that contain pointers consistent with JSON Pointer syntax to the Resource that powers this computer system.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700791 "readonly": true,
792 "type": "array"
793 },
794 "CooledBy@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700795 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700796 },
797 "Endpoints": {
Ed Tanouscb103132019-10-08 11:34:22 -0700798 "description": "An array of links to the endpoints that connect to this system.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700799 "items": {
800 "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint"
801 },
Ed Tanouscb103132019-10-08 11:34:22 -0700802 "longDescription": "This property shall contain a link to the Resources of the Endpoint type with which this system is associated.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700803 "readonly": true,
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600804 "type": "array",
805 "versionAdded": "v1_2_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700806 },
807 "Endpoints@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700808 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700809 },
810 "ManagedBy": {
Ed Tanouscb103132019-10-08 11:34:22 -0700811 "description": "An array of links to the managers responsible for this system.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700812 "items": {
813 "$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager"
814 },
Ed Tanouscb103132019-10-08 11:34:22 -0700815 "longDescription": "This property shall link to a Resource of type Manager that represents the Resource with management responsibility for this Resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700816 "readonly": true,
817 "type": "array"
818 },
819 "ManagedBy@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700820 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700821 },
822 "Oem": {
823 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700824 "description": "The OEM extension property.",
825 "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
Ed Tanous118b1c72018-09-13 13:45:51 -0700826 },
827 "PoweredBy": {
Ed Tanouscb103132019-10-08 11:34:22 -0700828 "description": "An array of one or more IDs for Resources that power this computer system. Normally, the ID is for either a chassis or a specific set of power supplies.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700829 "items": {
Ed Tanouscb103132019-10-08 11:34:22 -0700830 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef"
Ed Tanous118b1c72018-09-13 13:45:51 -0700831 },
Ed Tanouscb103132019-10-08 11:34:22 -0700832 "longDescription": "This property shall contain an array of IDs that contain pointers consistent with JSON Pointer syntax to the Resource that powers this computer system.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700833 "readonly": true,
834 "type": "array"
835 },
836 "PoweredBy@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700837 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700838 },
839 "ResourceBlocks": {
Ed Tanouscb103132019-10-08 11:34:22 -0700840 "description": "An array of links to the Resource Blocks that are used in this computer system.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700841 "items": {
842 "$ref": "http://redfish.dmtf.org/schemas/v1/ResourceBlock.json#/definitions/ResourceBlock"
843 },
Ed Tanouscb103132019-10-08 11:34:22 -0700844 "longDescription": "This property shall contain an array of links of the ResourceBlock type that show the Resource Blocks that are used in this computer system.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700845 "readonly": false,
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600846 "type": "array",
847 "versionAdded": "v1_4_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700848 },
849 "ResourceBlocks@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700850 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700851 },
852 "SupplyingComputerSystems": {
Ed Tanouscb103132019-10-08 11:34:22 -0700853 "description": "An array of links to ComputerSystems that contribute, in whole or in part, to the implementation of this ComputerSystem.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700854 "items": {
855 "$ref": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.json#/definitions/ComputerSystem"
856 },
Ed Tanouscb103132019-10-08 11:34:22 -0700857 "longDescription": "The value shall be an array of links to ComputerSystems that contribute, in whole or in part, to the implementation of this ComputerSystem.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700858 "readonly": true,
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600859 "type": "array",
860 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700861 },
862 "SupplyingComputerSystems@odata.count": {
Ed Tanouscb103132019-10-08 11:34:22 -0700863 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
Ed Tanous118b1c72018-09-13 13:45:51 -0700864 }
865 },
866 "type": "object"
867 },
868 "MemoryMirroring": {
869 "enum": [
870 "System",
871 "DIMM",
872 "Hybrid",
873 "None"
874 ],
875 "enumDescriptions": {
876 "DIMM": "The system supports DIMM mirroring at the DIMM level. Individual DIMMs can be mirrored.",
877 "Hybrid": "The system supports a hybrid mirroring at the system and DIMM levels. Individual DIMMs can be mirrored.",
878 "None": "The system does not support DIMM mirroring.",
Ed Tanouscb103132019-10-08 11:34:22 -0700879 "System": "The system supports DIMM mirroring at the system level. Individual DIMMs are not paired for mirroring in this mode."
Ed Tanous118b1c72018-09-13 13:45:51 -0700880 },
881 "type": "string"
882 },
883 "MemorySummary": {
884 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -0700885 "description": "The memory of the system in general detail.",
886 "longDescription": "This type shall contain properties that describe the central memory for a system.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700887 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700888 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700889 "description": "This property shall specify a valid odata or Redfish property.",
890 "type": [
891 "array",
892 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800893 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700894 "number",
895 "null",
896 "object",
897 "string"
898 ]
899 }
900 },
901 "properties": {
902 "MemoryMirroring": {
903 "anyOf": [
904 {
905 "$ref": "#/definitions/MemoryMirroring"
906 },
907 {
908 "type": "null"
909 }
910 ],
Ed Tanouscb103132019-10-08 11:34:22 -0700911 "description": "The ability and type of memory mirroring that this computer system supports.",
912 "longDescription": "This property shall contain the ability and type of memory mirring that this computer system supports.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600913 "readonly": true,
914 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700915 },
Ed Tanouscb103132019-10-08 11:34:22 -0700916 "Metrics": {
917 "$ref": "http://redfish.dmtf.org/schemas/v1/MemoryMetrics.json#/definitions/MemoryMetrics",
918 "description": "The link to the metrics associated with all memory in this system.",
919 "longDescription": "This property shall contain a link to the metrics associated with all memory in this system.",
920 "readonly": true,
921 "versionAdded": "v1_8_0"
922 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700923 "Status": {
Ed Tanous530520e2019-01-02 13:41:37 -0800924 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
Ed Tanouscb103132019-10-08 11:34:22 -0700925 "description": "The status and health of the Resource and its subordinate or dependent Resources.",
926 "longDescription": "This property shall contain any status or health properties of the Resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700927 },
928 "TotalSystemMemoryGiB": {
929 "description": "The total configured operating system-accessible memory (RAM), measured in GiB.",
930 "longDescription": "This property shall contain the amount of configured system general purpose volatile (RAM) memory as measured in gibibytes.",
931 "minimum": 0,
932 "readonly": true,
933 "type": [
934 "number",
935 "null"
Ed Tanous530520e2019-01-02 13:41:37 -0800936 ],
937 "units": "GiBy"
Ed Tanous118b1c72018-09-13 13:45:51 -0700938 },
939 "TotalSystemPersistentMemoryGiB": {
940 "description": "The total configured, system-accessible persistent memory, measured in GiB.",
941 "longDescription": "This property shall contain the total amount of configured persistent memory available to the system as measured in gibibytes.",
942 "minimum": 0,
943 "readonly": true,
944 "type": [
945 "number",
946 "null"
Ed Tanous530520e2019-01-02 13:41:37 -0800947 ],
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600948 "units": "GiBy",
949 "versionAdded": "v1_4_0"
Ed Tanous118b1c72018-09-13 13:45:51 -0700950 }
951 },
952 "type": "object"
953 },
954 "OemActions": {
955 "additionalProperties": true,
Ed Tanouscb103132019-10-08 11:34:22 -0700956 "description": "The available OEM-specific actions for this Resource.",
957 "longDescription": "This type shall contain the available OEM-specific actions for this Resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -0700958 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700959 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700960 "description": "This property shall specify a valid odata or Redfish property.",
961 "type": [
962 "array",
963 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800964 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700965 "number",
966 "null",
967 "object",
968 "string"
969 ]
970 }
971 },
972 "properties": {},
973 "type": "object"
974 },
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600975 "PowerRestorePolicyTypes": {
976 "description": "The enumerations of PowerRestorePolicyTypes specify the choice of power state for the system when power is applied.",
977 "enum": [
978 "AlwaysOn",
979 "AlwaysOff",
980 "LastState"
981 ],
982 "enumDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -0700983 "AlwaysOff": "The system always remains powered off when power is applied.",
984 "AlwaysOn": "The system always powers on when power is applied.",
985 "LastState": "The system returns to its last on or off power state when power is applied."
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600986 },
987 "type": "string"
988 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700989 "PowerState": {
990 "enum": [
991 "On",
992 "Off",
993 "PoweringOn",
994 "PoweringOff"
995 ],
996 "enumDescriptions": {
997 "Off": "The system is powered off, although some components may continue to have AUX power such as management controller.",
998 "On": "The system is powered on.",
Ed Tanouscb103132019-10-08 11:34:22 -0700999 "PoweringOff": "A temporary state between on and off. The power off action can take time while the OS is in the shutdown process.",
1000 "PoweringOn": "A temporary state between off and on. This temporary state can be very short."
Ed Tanous118b1c72018-09-13 13:45:51 -07001001 },
1002 "type": "string"
1003 },
1004 "ProcessorSummary": {
1005 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -07001006 "description": "The central processors of the system in general detail.",
1007 "longDescription": "This type shall contain properties that describe the central processors for a system.",
Ed Tanous118b1c72018-09-13 13:45:51 -07001008 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -07001009 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -07001010 "description": "This property shall specify a valid odata or Redfish property.",
1011 "type": [
1012 "array",
1013 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -08001014 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -07001015 "number",
1016 "null",
1017 "object",
1018 "string"
1019 ]
1020 }
1021 },
1022 "properties": {
1023 "Count": {
1024 "description": "The number of physical processors in the system.",
1025 "longDescription": "This property shall contain the number of physical central processors in the system.",
1026 "minimum": 0,
1027 "readonly": true,
1028 "type": [
Ed Tanous530520e2019-01-02 13:41:37 -08001029 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -07001030 "null"
1031 ]
1032 },
1033 "LogicalProcessorCount": {
1034 "description": "The number of logical processors in the system.",
1035 "longDescription": "This property shall contain the number of logical central processors in the system.",
1036 "minimum": 0,
1037 "readonly": true,
1038 "type": [
Ed Tanous530520e2019-01-02 13:41:37 -08001039 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -07001040 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001041 ],
1042 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -07001043 },
Ed Tanouscb103132019-10-08 11:34:22 -07001044 "Metrics": {
1045 "$ref": "http://redfish.dmtf.org/schemas/v1/ProcessorMetrics.json#/definitions/ProcessorMetrics",
1046 "description": "The link to the metrics associated with all processors in this system.",
1047 "longDescription": "This property shall contain a link to the metrics associated with all processors in this system.",
1048 "readonly": true,
1049 "versionAdded": "v1_7_0"
1050 },
Ed Tanous118b1c72018-09-13 13:45:51 -07001051 "Model": {
1052 "description": "The processor model for the primary or majority of processors in this system.",
1053 "longDescription": "This property shall contain the processor model for the central processors in the system, per the description in the Processor Information - Processor Family section of the SMBIOS Specification DSP0134 2.8 or later.",
1054 "readonly": true,
1055 "type": [
1056 "string",
1057 "null"
1058 ]
1059 },
1060 "Status": {
Ed Tanous530520e2019-01-02 13:41:37 -08001061 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
Ed Tanouscb103132019-10-08 11:34:22 -07001062 "description": "The status and health of the Resource and its subordinate or dependent Resources.",
1063 "longDescription": "This property shall contain any status or health properties of the Resource."
Ed Tanous118b1c72018-09-13 13:45:51 -07001064 }
1065 },
1066 "type": "object"
1067 },
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001068 "RemoveResourceBlock": {
1069 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -07001070 "description": "This action removes a Resource Block from a system.",
1071 "longDescription": "This action shall remove a Resource Block from a system.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001072 "parameters": {
1073 "ComputerSystemETag": {
1074 "description": "The current ETag of the system.",
Ed Tanouscb103132019-10-08 11:34:22 -07001075 "longDescription": "This parameter shall contain the current ETag of the system. If the client-provided ETag does not match the current ETag of the system, the service shall return the HTTP 428 (Precondition Required) status code to reject the request.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001076 "type": "string"
1077 },
1078 "ResourceBlock": {
1079 "$ref": "http://redfish.dmtf.org/schemas/v1/ResourceBlock.json#/definitions/ResourceBlock",
1080 "description": "The Resource Block to remove from the system.",
Ed Tanouscb103132019-10-08 11:34:22 -07001081 "longDescription": "This parameter shall contain a link to the specified Resource Block to remove from the system.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001082 "requiredParameter": true
1083 },
1084 "ResourceBlockETag": {
1085 "description": "The current ETag of the Resource Block to remove from the system.",
Ed Tanouscb103132019-10-08 11:34:22 -07001086 "longDescription": "This parameter shall contain the current ETag of the Resource Block to remove from the system. If the client-provided ETag does not match the current ETag of the Resource Block that the ResourceBlock parameter specifies, the service shall return the HTTP 428 (Precondition Required) status code to reject the request.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001087 "type": "string"
1088 }
1089 },
1090 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -07001091 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001092 "description": "This property shall specify a valid odata or Redfish property.",
1093 "type": [
1094 "array",
1095 "boolean",
1096 "integer",
1097 "number",
1098 "null",
1099 "object",
1100 "string"
1101 ]
1102 }
1103 },
1104 "properties": {
1105 "target": {
1106 "description": "Link to invoke action",
Ed Tanouscb103132019-10-08 11:34:22 -07001107 "format": "uri-reference",
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001108 "type": "string"
1109 },
1110 "title": {
1111 "description": "Friendly action name",
1112 "type": "string"
1113 }
1114 },
1115 "type": "object",
1116 "versionAdded": "v1_6_0"
1117 },
Ed Tanous118b1c72018-09-13 13:45:51 -07001118 "Reset": {
1119 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -07001120 "description": "This action resets the system.",
1121 "longDescription": "This action shall reset the system represented by the Resource. For systems that implement ACPI Power Button functionality, the PushPowerButton value shall perform or emulate an ACPI Power Button Push. The ForceOff value shall remove power from the system or perform an ACPI Power Button Override, commonly known as a four-second hold of the Power Button. The ForceRestart value shall perform a ForceOff action, followed by an On action.",
Ed Tanous118b1c72018-09-13 13:45:51 -07001122 "parameters": {
1123 "ResetType": {
1124 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/ResetType",
Ed Tanouscb103132019-10-08 11:34:22 -07001125 "description": "The type of reset.",
1126 "longDescription": "This parameter shall contain the type of reset. The Service may accept a request without the parameter and perform an implementation-specific default reset."
Ed Tanous118b1c72018-09-13 13:45:51 -07001127 }
1128 },
1129 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -07001130 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -07001131 "description": "This property shall specify a valid odata or Redfish property.",
1132 "type": [
1133 "array",
1134 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -08001135 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -07001136 "number",
1137 "null",
1138 "object",
1139 "string"
1140 ]
1141 }
1142 },
1143 "properties": {
1144 "target": {
1145 "description": "Link to invoke action",
Ed Tanouscb103132019-10-08 11:34:22 -07001146 "format": "uri-reference",
Ed Tanous118b1c72018-09-13 13:45:51 -07001147 "type": "string"
1148 },
1149 "title": {
1150 "description": "Friendly action name",
1151 "type": "string"
1152 }
1153 },
1154 "type": "object"
1155 },
1156 "SetDefaultBootOrder": {
1157 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -07001158 "description": "This action sets the BootOrder to the default settings.",
1159 "longDescription": "This action shall set the BootOrder array to the default settings.",
Ed Tanous118b1c72018-09-13 13:45:51 -07001160 "parameters": {},
1161 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -07001162 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -07001163 "description": "This property shall specify a valid odata or Redfish property.",
1164 "type": [
1165 "array",
1166 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -08001167 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -07001168 "number",
1169 "null",
1170 "object",
1171 "string"
1172 ]
1173 }
1174 },
1175 "properties": {
1176 "target": {
1177 "description": "Link to invoke action",
Ed Tanouscb103132019-10-08 11:34:22 -07001178 "format": "uri-reference",
Ed Tanous118b1c72018-09-13 13:45:51 -07001179 "type": "string"
1180 },
1181 "title": {
1182 "description": "Friendly action name",
1183 "type": "string"
1184 }
1185 },
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001186 "type": "object",
1187 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -07001188 },
1189 "SystemType": {
1190 "enum": [
1191 "Physical",
1192 "Virtual",
1193 "OS",
1194 "PhysicallyPartitioned",
1195 "VirtuallyPartitioned",
1196 "Composed"
1197 ],
1198 "enumDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -07001199 "Composed": "A computer system constructed by binding Resource Blocks together.",
Ed Tanous118b1c72018-09-13 13:45:51 -07001200 "OS": "An operating system instance.",
1201 "Physical": "A computer system.",
1202 "PhysicallyPartitioned": "A hardware-based partition of a computer system.",
1203 "Virtual": "A virtual machine instance running on this system.",
1204 "VirtuallyPartitioned": "A virtual or software-based partition of a computer system."
1205 },
1206 "enumLongDescriptions": {
Ed Tanouscb103132019-10-08 11:34:22 -07001207 "Composed": "A SystemType of Composed typically represents a single system constructed from disaggregated Resources through the Redfish Composition Service.",
1208 "OS": "A SystemType of OS typically represents an OS or hypervisor view of the system.",
1209 "Physical": "A SystemType of Physical typically represents the hardware aspects of a system, such as a management controller.",
1210 "PhysicallyPartitioned": "A SystemType of PhysicallyPartition typically represents a single system constructed from one or more physical systems through a firmware or hardware-based service.",
1211 "Virtual": "A SystemType of Virtual typically represents a system that is actually a virtual machine instance.",
1212 "VirtuallyPartitioned": "A SystemType of VirtuallyPartition typically represents a single system constructed from one or more virtual systems through a software-based service."
Ed Tanous118b1c72018-09-13 13:45:51 -07001213 },
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001214 "enumVersionAdded": {
1215 "Composed": "v1_4_0"
1216 },
Ed Tanous118b1c72018-09-13 13:45:51 -07001217 "type": "string"
1218 },
1219 "TrustedModules": {
1220 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -07001221 "description": "The Trusted Module installed in the system.",
1222 "longDescription": "This type shall describe a Trusted Module for a system.",
Ed Tanous118b1c72018-09-13 13:45:51 -07001223 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -07001224 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -07001225 "description": "This property shall specify a valid odata or Redfish property.",
1226 "type": [
1227 "array",
1228 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -08001229 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -07001230 "number",
1231 "null",
1232 "object",
1233 "string"
1234 ]
1235 }
1236 },
1237 "properties": {
1238 "FirmwareVersion": {
1239 "description": "The firmware version of this Trusted Module.",
1240 "longDescription": "This property shall contain the firwmare version as defined by the manufacturer for the Trusted Module.",
1241 "readonly": true,
1242 "type": [
1243 "string",
1244 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001245 ],
1246 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -07001247 },
1248 "FirmwareVersion2": {
Ed Tanouscb103132019-10-08 11:34:22 -07001249 "description": "The second firmware version of this Trusted Module, if applicable.",
Ed Tanous118b1c72018-09-13 13:45:51 -07001250 "longDescription": "This property shall contain the 2nd firmware version, if applicable, as defined by the manufacturer for the Trusted Module.",
1251 "readonly": true,
1252 "type": [
1253 "string",
1254 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001255 ],
1256 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -07001257 },
1258 "InterfaceType": {
1259 "anyOf": [
1260 {
1261 "$ref": "#/definitions/InterfaceType"
1262 },
1263 {
1264 "type": "null"
1265 }
1266 ],
Ed Tanouscb103132019-10-08 11:34:22 -07001267 "description": "The interface type of the Trusted Module.",
Ed Tanous118b1c72018-09-13 13:45:51 -07001268 "longDescription": "This property shall contain the interface type of the installed Trusted Module.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001269 "readonly": true,
1270 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -07001271 },
1272 "InterfaceTypeSelection": {
1273 "anyOf": [
1274 {
1275 "$ref": "#/definitions/InterfaceTypeSelection"
1276 },
1277 {
1278 "type": "null"
1279 }
1280 ],
Ed Tanouscb103132019-10-08 11:34:22 -07001281 "description": "The interface type selection supported by this Trusted Module.",
1282 "longDescription": "This property shall contain the interface type Selection method (for example to switch between TPM1_2 and TPM2_0) that is supported by this TrustedModule.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001283 "readonly": true,
1284 "versionAdded": "v1_3_0"
Ed Tanous118b1c72018-09-13 13:45:51 -07001285 },
1286 "Oem": {
Ed Tanous530520e2019-01-02 13:41:37 -08001287 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -07001288 "description": "The OEM extension property.",
1289 "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001290 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -07001291 },
1292 "Status": {
Ed Tanous530520e2019-01-02 13:41:37 -08001293 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
Ed Tanouscb103132019-10-08 11:34:22 -07001294 "description": "The status and health of the Resource and its subordinate or dependent Resources.",
1295 "longDescription": "This property shall contain any status or health properties of the Resource.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001296 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -07001297 }
1298 },
1299 "type": "object"
1300 },
1301 "WatchdogTimeoutActions": {
Ed Tanouscb103132019-10-08 11:34:22 -07001302 "description": "The enumerations of WatchdogTimeoutActions specify the choice of action to take when the host watchdog timer reaches its timeout value.",
Ed Tanous118b1c72018-09-13 13:45:51 -07001303 "enum": [
1304 "None",
1305 "ResetSystem",
1306 "PowerCycle",
1307 "PowerDown",
1308 "OEM"
1309 ],
1310 "enumDescriptions": {
1311 "None": "No action taken.",
1312 "OEM": "Perform an OEM-defined action.",
1313 "PowerCycle": "Power cycle the system.",
1314 "PowerDown": "Power down the system.",
1315 "ResetSystem": "Reset the system."
1316 },
1317 "type": "string"
1318 },
1319 "WatchdogTimer": {
1320 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -07001321 "description": "This type describes the host watchdog timer functionality for this system.",
1322 "longDescription": "This type shall contain properties that describe the host watchdog timer functionality for this ComputerSystem.",
Ed Tanous118b1c72018-09-13 13:45:51 -07001323 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -07001324 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous118b1c72018-09-13 13:45:51 -07001325 "description": "This property shall specify a valid odata or Redfish property.",
1326 "type": [
1327 "array",
1328 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -08001329 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -07001330 "number",
1331 "null",
1332 "object",
1333 "string"
1334 ]
1335 }
1336 },
1337 "properties": {
1338 "FunctionEnabled": {
Ed Tanouscb103132019-10-08 11:34:22 -07001339 "description": "An indication of whether a user has enabled the host watchdog timer functionality. This property indicates only that a user has enabled the timer. To activate the timer, installation of additional host-based software is necessary; an update to this property does not initiate the timer.",
1340 "longDescription": "This property shall indicate whether a user has enabled the host watchdog timer functionality. This property indicates only that a user has enabled the timer. To activate the timer, installation of additional host-based software is necessary; an update to this property does not initiate the timer.",
Ed Tanous118b1c72018-09-13 13:45:51 -07001341 "readonly": false,
1342 "type": [
1343 "boolean",
1344 "null"
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001345 ],
1346 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -07001347 },
1348 "Oem": {
Ed Tanous530520e2019-01-02 13:41:37 -08001349 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -07001350 "description": "The OEM extension property.",
1351 "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001352 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -07001353 },
1354 "Status": {
Ed Tanous530520e2019-01-02 13:41:37 -08001355 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
Ed Tanouscb103132019-10-08 11:34:22 -07001356 "description": "The status and health of the Resource and its subordinate or dependent Resources.",
1357 "longDescription": "This property shall contain any status or health properties of the Resource.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001358 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -07001359 },
1360 "TimeoutAction": {
1361 "anyOf": [
1362 {
1363 "$ref": "#/definitions/WatchdogTimeoutActions"
1364 },
1365 {
1366 "type": "null"
1367 }
1368 ],
Ed Tanouscb103132019-10-08 11:34:22 -07001369 "description": "The action to perform when the watchdog timer reaches its timeout value.",
1370 "longDescription": "This property shall contain the action to perform when the watchdog timer reaches its timeout value.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001371 "readonly": false,
1372 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -07001373 },
1374 "WarningAction": {
1375 "anyOf": [
1376 {
1377 "$ref": "#/definitions/WatchdogWarningActions"
1378 },
1379 {
1380 "type": "null"
1381 }
1382 ],
Ed Tanouscb103132019-10-08 11:34:22 -07001383 "description": "The action to perform when the watchdog timer is close to reaching its timeout value. This action typically occurs from three to ten seconds before to the timeout value, but the exact timing is dependent on the implementation.",
1384 "longDescription": "This property shall contain the action to perform before the watchdog timer expires. This action typically occurs from three to ten seconds before to the timeout value, but the exact timing is dependent on the implementation.",
Marri Devender Raod45d2d02019-01-21 10:11:34 -06001385 "readonly": false,
1386 "versionAdded": "v1_5_0"
Ed Tanous118b1c72018-09-13 13:45:51 -07001387 }
1388 },
1389 "required": [
1390 "FunctionEnabled",
1391 "TimeoutAction"
1392 ],
1393 "type": "object"
1394 },
1395 "WatchdogWarningActions": {
Ed Tanouscb103132019-10-08 11:34:22 -07001396 "description": "The enumerations of WatchdogWarningActions specify the choice of action to take when the host watchdog timer is close (typically 3-10 seconds) to reaching its timeout value.",
Ed Tanous118b1c72018-09-13 13:45:51 -07001397 "enum": [
1398 "None",
1399 "DiagnosticInterrupt",
1400 "SMI",
1401 "MessagingInterrupt",
1402 "SCI",
1403 "OEM"
1404 ],
1405 "enumDescriptions": {
1406 "DiagnosticInterrupt": "Raise a (typically non-maskable) Diagnostic Interrupt.",
1407 "MessagingInterrupt": "Raise a legacy IPMI messaging interrupt.",
1408 "None": "No action taken.",
1409 "OEM": "Perform an OEM-defined action.",
1410 "SCI": "Raise an interrupt using the ACPI System Control Interrupt (SCI).",
1411 "SMI": "Raise a Systems Management Interrupt (SMI)."
1412 },
1413 "type": "string"
1414 }
1415 },
Ed Tanous530520e2019-01-02 13:41:37 -08001416 "owningEntity": "DMTF",
Ed Tanouscb103132019-10-08 11:34:22 -07001417 "release": "2019.2",
1418 "title": "#ComputerSystem.v1_8_0.ComputerSystem"
Ed Tanous118b1c72018-09-13 13:45:51 -07001419}