Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 683f7276576dbf0bf7770570190f6b5b4e84d4c9 / . / static / redfish / v1 / JsonSchemas / NetworkAdapter / index.json
blob: 0e1252ad2f73674dd392928c5bb93751a63a5176 [file] [log] [blame]
Ed Tanous683f7272018-07-26 12:47:19 -0700[diff] [blame^]1{
2 "$ref": "#/definitions/NetworkAdapter",
3 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_3_0.json",
4 "copyright": "Copyright 2014-2017 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
5 "definitions": {
6 "Actions": {
7 "additionalProperties": false,
8 "description": "The available actions for this resource.",
9 "longDescription": "This type shall contain the available actions for this resource.",
10 "patternProperties": {
11 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
12 "description": "This property shall specify a valid odata or Redfish property.",
13 "type": [
14 "array",
15 "boolean",
16 "number",
17 "null",
18 "object",
19 "string"
20 ]
21 }
22 },
23 "properties": {
24 "#NetworkAdapter.ResetSettingsToDefault": {
25 "$ref": "#/definitions/ResetSettingsToDefault"
26 },
27 "Oem": {
28 "$ref": "#/definitions/OemActions"
29 }
30 },
31 "type": "object"
32 },
33 "ControllerCapabilities": {
34 "additionalProperties": false,
35 "description": "The capabilities of a controller.",
36 "longDescription": "This type shall describe the capabilities of a controller.",
37 "patternProperties": {
38 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
39 "description": "This property shall specify a valid odata or Redfish property.",
40 "type": [
41 "array",
42 "boolean",
43 "number",
44 "null",
45 "object",
46 "string"
47 ]
48 }
49 },
50 "properties": {
51 "DataCenterBridging": {
52 "anyOf": [
53 {
54 "$ref": "#/definitions/DataCenterBridging"
55 },
56 {
57 "type": "null"
58 }
59 ],
60 "description": "Data Center Bridging (DCB) for this controller.",
61 "longDescription": "This object shall contain capability, status, and configuration values related to Data Center Bridging (DCB) for this controller."
62 },
63 "NPIV": {
64 "anyOf": [
65 {
66 "$ref": "#/definitions/NPIV"
67 },
68 {
69 "type": "null"
70 }
71 ],
72 "description": "N_Port ID Virtualization (NPIV) capabilties for this controller.",
73 "longDescription": "This object shall contain N_Port ID Virtualization (NPIV) capabilties for this controller."
74 },
75 "NetworkDeviceFunctionCount": {
76 "description": "The maximum number of physical functions available on this controller.",
77 "longDescription": "The value of this property shall be the number of physical functions available on this controller.",
78 "readonly": true,
79 "type": [
80 "number",
81 "null"
82 ]
83 },
84 "NetworkPortCount": {
85 "description": "The number of physical ports on this controller.",
86 "longDescription": "The value of this property shall be the number of physical ports on this controller.",
87 "readonly": true,
88 "type": [
89 "number",
90 "null"
91 ]
92 },
93 "VirtualizationOffload": {
94 "anyOf": [
95 {
96 "$ref": "#/definitions/VirtualizationOffload"
97 },
98 {
99 "type": "null"
100 }
101 ],
102 "description": "Virtualization offload for this controller.",
103 "longDescription": "This object shall contain capability, status, and configuration values related to virtualization offload for this controller."
104 }
105 },
106 "type": "object"
107 },
108 "ControllerLinks": {
109 "additionalProperties": false,
110 "description": "Contains references to other resources that are related to this resource.",
111 "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.",
112 "patternProperties": {
113 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
114 "description": "This property shall specify a valid odata or Redfish property.",
115 "type": [
116 "array",
117 "boolean",
118 "number",
119 "null",
120 "object",
121 "string"
122 ]
123 }
124 },
125 "properties": {
126 "NetworkDeviceFunctions": {
127 "description": "Contains the members of this collection.",
128 "items": {
129 "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.json#/definitions/NetworkDeviceFunction"
130 },
131 "readonly": true,
132 "type": "array"
133 },
134 "NetworkDeviceFunctions@odata.count": {
135 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/count"
136 },
137 "NetworkPorts": {
138 "description": "Contains the members of this collection.",
139 "items": {
140 "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkPort.json#/definitions/NetworkPort"
141 },
142 "readonly": true,
143 "type": "array"
144 },
145 "NetworkPorts@odata.count": {
146 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/count"
147 },
148 "Oem": {
149 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
150 "description": "Oem extension object.",
151 "longDescription": "This object represents the Oem property. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification."
152 },
153 "PCIeDevices": {
154 "description": "Contains the members of this collection.",
155 "items": {
156 "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeDevice"
157 },
158 "readonly": true,
159 "type": "array"
160 },
161 "PCIeDevices@odata.count": {
162 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/count"
163 }
164 },
165 "type": "object"
166 },
167 "Controllers": {
168 "additionalProperties": false,
169 "description": "A network controller ASIC that makes up part of a NetworkAdapter.",
170 "longDescription": "This type shall describe a network controller ASIC that makes up part of a NetworkAdapter.",
171 "patternProperties": {
172 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
173 "description": "This property shall specify a valid odata or Redfish property.",
174 "type": [
175 "array",
176 "boolean",
177 "number",
178 "null",
179 "object",
180 "string"
181 ]
182 }
183 },
184 "properties": {
185 "ControllerCapabilities": {
186 "anyOf": [
187 {
188 "$ref": "#/definitions/ControllerCapabilities"
189 },
190 {
191 "type": "null"
192 }
193 ],
194 "description": "The capabilities of this controller.",
195 "longDescription": "The value of this property shall contain the capabilities of this controller."
196 },
197 "FirmwarePackageVersion": {
198 "description": "The version of the user-facing firmware package.",
199 "longDescription": "The value of this property shall be the version number of the user-facing firmware package.",
200 "readonly": true,
201 "type": [
202 "string",
203 "null"
204 ]
205 },
206 "Links": {
207 "$ref": "#/definitions/ControllerLinks",
208 "description": "Links.",
209 "longDescription": "Links for this controller."
210 },
211 "Location": {
212 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location"
213 }
214 },
215 "type": "object"
216 },
217 "DataCenterBridging": {
218 "additionalProperties": false,
219 "description": "Data Center Bridging (DCB) for capabilities of a controller.",
220 "longDescription": "This type shall describe the capability, status, and configuration values related to Data Center Bridging (DCB) for a controller.",
221 "patternProperties": {
222 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
223 "description": "This property shall specify a valid odata or Redfish property.",
224 "type": [
225 "array",
226 "boolean",
227 "number",
228 "null",
229 "object",
230 "string"
231 ]
232 }
233 },
234 "properties": {
235 "Capable": {
236 "description": "Whether this controller is capable of Data Center Bridging (DCB).",
237 "longDescription": "The value of this property shall be a boolean indicating whether this controller is capable of Data Center Bridging (DCB).",
238 "readonly": true,
239 "type": [
240 "boolean",
241 "null"
242 ]
243 }
244 },
245 "type": "object"
246 },
247 "NPIV": {
248 "additionalProperties": false,
249 "description": "N_Port ID Virtualization (NPIV) capabilties for a controller.",
250 "longDescription": "This type shall contain N_Port ID Virtualization (NPIV) capabilties for a controller.",
251 "patternProperties": {
252 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
253 "description": "This property shall specify a valid odata or Redfish property.",
254 "type": [
255 "array",
256 "boolean",
257 "number",
258 "null",
259 "object",
260 "string"
261 ]
262 }
263 },
264 "properties": {
265 "MaxDeviceLogins": {
266 "description": "The maximum number of N_Port ID Virtualization (NPIV) logins allowed simultaneously from all ports on this controller.",
267 "longDescription": "The value of this property shall be the maximum number of N_Port ID Virtualization (NPIV) logins allowed simultaneously from all ports on this controller.",
268 "readonly": true,
269 "type": [
270 "number",
271 "null"
272 ]
273 },
274 "MaxPortLogins": {
275 "description": "The maximum number of N_Port ID Virtualization (NPIV) logins allowed per physical port on this controller.",
276 "longDescription": "The value of this property shall be the maximum number of N_Port ID Virtualization (NPIV) logins allowed per physical port on this controller.",
277 "readonly": true,
278 "type": [
279 "number",
280 "null"
281 ]
282 }
283 },
284 "type": "object"
285 },
286 "NetworkAdapter": {
287 "additionalProperties": false,
288 "description": "A NetworkAdapter represents the physical network adapter capable of connecting to a computer network. Examples include but are not limited to Ethernet, Fibre Channel, and converged network adapters.",
289 "longDescription": "A NetworkAdapter represents the physical network adapter capable of connecting to a computer network. Examples include but are not limited to Ethernet, Fibre Channel, and converged network adapters.",
290 "patternProperties": {
291 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
292 "description": "This property shall specify a valid odata or Redfish property.",
293 "type": [
294 "array",
295 "boolean",
296 "number",
297 "null",
298 "object",
299 "string"
300 ]
301 }
302 },
303 "properties": {
304 "@odata.context": {
305 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/context"
306 },
307 "@odata.id": {
308 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/id"
309 },
310 "@odata.type": {
311 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/type"
312 },
313 "Actions": {
314 "$ref": "#/definitions/Actions",
315 "description": "The available actions for this resource.",
316 "longDescription": "The Actions property shall contain the available actions for this resource."
317 },
318 "Assembly": {
319 "$ref": "http://redfish.dmtf.org/schemas/v1/Assembly.json#/definitions/Assembly",
320 "description": "A reference to the Assembly resource associated with this adapter.",
321 "longDescription": "The value of this property shall be a link to a resource of type Assembly.",
322 "readonly": true
323 },
324 "Controllers": {
325 "description": "The set of network controllers ASICs that make up this NetworkAdapter.",
326 "items": {
327 "anyOf": [
328 {
329 "$ref": "#/definitions/Controllers"
330 },
331 {
332 "type": "null"
333 }
334 ]
335 },
336 "longDescription": "The value of this property shall contain the set of network controllers ASICs that make up this NetworkAdapter.",
337 "type": "array"
338 },
339 "Description": {
340 "anyOf": [
341 {
342 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
343 },
344 {
345 "type": "null"
346 }
347 ],
348 "readonly": true
349 },
350 "Id": {
351 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
352 "readonly": true
353 },
354 "Manufacturer": {
355 "description": "The manufacturer or OEM of this network adapter.",
356 "longDescription": "The value of this property shall contain a value that represents the manufacturer of the network adapter.",
357 "readonly": true,
358 "type": [
359 "string",
360 "null"
361 ]
362 },
363 "Model": {
364 "description": "The model string for this network adapter.",
365 "longDescription": "The value of this property shall contain the information about how the manufacturer references this network adapter.",
366 "readonly": true,
367 "type": [
368 "string",
369 "null"
370 ]
371 },
372 "Name": {
373 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
374 "readonly": true
375 },
376 "NetworkDeviceFunctions": {
377 "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunctionCollection.json#/definitions/NetworkDeviceFunctionCollection",
378 "description": "Contains the members of this collection.",
379 "readonly": true
380 },
381 "NetworkPorts": {
382 "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkPortCollection.json#/definitions/NetworkPortCollection",
383 "description": "Contains the members of this collection.",
384 "readonly": true
385 },
386 "Oem": {
387 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
388 "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
389 "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
390 },
391 "PartNumber": {
392 "description": "Part number for this network adapter.",
393 "longDescription": "The value of this property shall contain the part number for the network adapter as defined by the manufacturer.",
394 "readonly": true,
395 "type": [
396 "string",
397 "null"
398 ]
399 },
400 "SKU": {
401 "description": "The manufacturer SKU for this network adapter.",
402 "longDescription": "The value of this property shall contain the Stock Keeping Unit (SKU) for the network adapter.",
403 "readonly": true,
404 "type": [
405 "string",
406 "null"
407 ]
408 },
409 "SerialNumber": {
410 "description": "The serial number for this network adapter.",
411 "longDescription": "The value of this property shall contain the serial number for the network adapter.",
412 "readonly": true,
413 "type": [
414 "string",
415 "null"
416 ]
417 },
418 "Status": {
419 "anyOf": [
420 {
421 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status"
422 },
423 {
424 "type": "null"
425 }
426 ]
427 }
428 },
429 "required": [
430 "Id",
431 "Name"
432 ],
433 "type": "object"
434 },
435 "OemActions": {
436 "additionalProperties": true,
437 "description": "The available OEM specific actions for this resource.",
438 "longDescription": "This type shall contain any additional OEM actions for this resource.",
439 "patternProperties": {
440 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
441 "description": "This property shall specify a valid odata or Redfish property.",
442 "type": [
443 "array",
444 "boolean",
445 "number",
446 "null",
447 "object",
448 "string"
449 ]
450 }
451 },
452 "properties": {},
453 "type": "object"
454 },
455 "ResetSettingsToDefault": {
456 "additionalProperties": false,
457 "description": "This action is to clear the settings back to factory defaults.",
458 "longDescription": "This action shall perform a reset of all active and pending settings back to factory default settings upon reset of the network adapter.",
459 "parameters": {},
460 "patternProperties": {
461 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
462 "description": "This property shall specify a valid odata or Redfish property.",
463 "type": [
464 "array",
465 "boolean",
466 "number",
467 "null",
468 "object",
469 "string"
470 ]
471 }
472 },
473 "properties": {
474 "target": {
475 "description": "Link to invoke action",
476 "format": "uri",
477 "type": "string"
478 },
479 "title": {
480 "description": "Friendly action name",
481 "type": "string"
482 }
483 },
484 "type": "object"
485 },
486 "SRIOV": {
487 "additionalProperties": false,
488 "description": "Single-Root Input/Output Virtualization (SR-IOV) capabilities.",
489 "longDescription": "This type shall contain Single-Root Input/Output Virtualization (SR-IOV) capabilities.",
490 "patternProperties": {
491 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
492 "description": "This property shall specify a valid odata or Redfish property.",
493 "type": [
494 "array",
495 "boolean",
496 "number",
497 "null",
498 "object",
499 "string"
500 ]
501 }
502 },
503 "properties": {
504 "SRIOVVEPACapable": {
505 "description": "Whether this controller supports Single Root Input/Output Virtualization (SR-IOV) in Virtual Ethernet Port Aggregator (VEPA) mode.",
506 "longDescription": "The value of this property shall be a boolean indicating whether this controller supports Single Root Input/Output Virtualization (SR-IOV) in Virtual Ethernet Port Aggregator (VEPA) mode.",
507 "readonly": true,
508 "type": [
509 "boolean",
510 "null"
511 ]
512 }
513 },
514 "type": "object"
515 },
516 "VirtualFunction": {
517 "additionalProperties": false,
518 "description": "A virtual function of a controller.",
519 "longDescription": "This type shall describe the capability, status, and configuration values related to a virtual function for a controller.",
520 "patternProperties": {
521 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
522 "description": "This property shall specify a valid odata or Redfish property.",
523 "type": [
524 "array",
525 "boolean",
526 "number",
527 "null",
528 "object",
529 "string"
530 ]
531 }
532 },
533 "properties": {
534 "DeviceMaxCount": {
535 "description": "The maximum number of Virtual Functions (VFs) supported by this controller.",
536 "longDescription": "The value of this property shall be the maximum number of Virtual Functions (VFs) supported by this controller.",
537 "readonly": true,
538 "type": [
539 "number",
540 "null"
541 ]
542 },
543 "MinAssignmentGroupSize": {
544 "description": "The minimum number of Virtual Functions (VFs) that can be allocated or moved between physical functions for this controller.",
545 "longDescription": "The value of this property shall be the minimum number of Virtual Functions (VFs) that can be allocated or moved between physical functions for this controller.",
546 "readonly": true,
547 "type": [
548 "number",
549 "null"
550 ]
551 },
552 "NetworkPortMaxCount": {
553 "description": "The maximum number of Virtual Functions (VFs) supported per network port for this controller.",
554 "longDescription": "The value of this property shall be the maximum number of Virtual Functions (VFs) supported per network port for this controller.",
555 "readonly": true,
556 "type": [
557 "number",
558 "null"
559 ]
560 }
561 },
562 "type": "object"
563 },
564 "VirtualizationOffload": {
565 "additionalProperties": false,
566 "description": "A Virtualization offload capability of a controller.",
567 "longDescription": "This type shall describe the capability, status, and configuration values related to a virtualization offload for a controller.",
568 "patternProperties": {
569 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
570 "description": "This property shall specify a valid odata or Redfish property.",
571 "type": [
572 "array",
573 "boolean",
574 "number",
575 "null",
576 "object",
577 "string"
578 ]
579 }
580 },
581 "properties": {
582 "SRIOV": {
583 "anyOf": [
584 {
585 "$ref": "#/definitions/SRIOV"
586 },
587 {
588 "type": "null"
589 }
590 ],
591 "description": "Single-Root Input/Output Virtualization (SR-IOV) capabilities.",
592 "longDescription": "This object shall contain Single-Root Input/Output Virtualization (SR-IOV) capabilities."
593 },
594 "VirtualFunction": {
595 "anyOf": [
596 {
597 "$ref": "#/definitions/VirtualFunction"
598 },
599 {
600 "type": "null"
601 }
602 ]
603 }
604 },
605 "type": "object"
606 }
607 },
608 "title": "#NetworkAdapter.v1_1_0.NetworkAdapter"
609}