1{ 2 "$id": "http://redfish.dmtf.org/schemas/v1/NetworkAdapter.v1_13_0.json", 3 "$ref": "#/definitions/NetworkAdapter", 4 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", 5 "copyright": "Copyright 2014-2025 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", 6 "definitions": { 7 "Actions": { 8 "additionalProperties": false, 9 "description": "The available actions for this resource.", 10 "longDescription": "This type shall contain the available actions for this resource.", 11 "patternProperties": { 12 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 13 "description": "This property shall specify a valid odata or Redfish property.", 14 "type": [ 15 "array", 16 "boolean", 17 "integer", 18 "number", 19 "null", 20 "object", 21 "string" 22 ] 23 } 24 }, 25 "properties": { 26 "#NetworkAdapter.Reset": { 27 "$ref": "#/definitions/Reset" 28 }, 29 "#NetworkAdapter.ResetSettingsToDefault": { 30 "$ref": "#/definitions/ResetSettingsToDefault" 31 }, 32 "Oem": { 33 "$ref": "#/definitions/OemActions", 34 "description": "The available OEM-specific actions for this resource.", 35 "longDescription": "This property shall contain the available OEM-specific actions for this resource." 36 } 37 }, 38 "type": "object" 39 }, 40 "ControllerCapabilities": { 41 "additionalProperties": false, 42 "description": "The capabilities of a controller.", 43 "longDescription": "This type shall describe the capabilities of a controller.", 44 "patternProperties": { 45 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 46 "description": "This property shall specify a valid odata or Redfish property.", 47 "type": [ 48 "array", 49 "boolean", 50 "integer", 51 "number", 52 "null", 53 "object", 54 "string" 55 ] 56 } 57 }, 58 "properties": { 59 "DataCenterBridging": { 60 "$ref": "#/definitions/DataCenterBridging", 61 "description": "Data center bridging (DCB) for this controller.", 62 "longDescription": "This property shall contain capability, status, and configuration values related to data center bridging (DCB) for this controller." 63 }, 64 "NPAR": { 65 "$ref": "#/definitions/NicPartitioning", 66 "description": "NIC Partitioning (NPAR) capabilities for this controller.", 67 "longDescription": "This property shall contain capability, status, and configuration values related to NIC partitioning for this controller.", 68 "versionAdded": "v1_2_0" 69 }, 70 "NPIV": { 71 "$ref": "#/definitions/NPIV", 72 "description": "N_Port ID Virtualization (NPIV) capabilities for this controller.", 73 "longDescription": "This property shall contain N_Port ID Virtualization (NPIV) capabilities for this controller." 74 }, 75 "NetworkDeviceFunctionCount": { 76 "description": "The maximum number of physical functions available on this controller.", 77 "longDescription": "This property shall contain the number of physical functions available on this controller.", 78 "readonly": true, 79 "type": [ 80 "integer", 81 "null" 82 ] 83 }, 84 "NetworkPortCount": { 85 "description": "The number of physical ports on this controller.", 86 "longDescription": "This property shall contain the number of physical ports on this controller.", 87 "readonly": true, 88 "type": [ 89 "integer", 90 "null" 91 ] 92 }, 93 "VirtualizationOffload": { 94 "$ref": "#/definitions/VirtualizationOffload", 95 "description": "Virtualization offload for this controller.", 96 "longDescription": "This property shall contain capability, status, and configuration values related to virtualization offload for this controller." 97 } 98 }, 99 "type": "object" 100 }, 101 "ControllerLinks": { 102 "additionalProperties": false, 103 "description": "The links to other resources that are related to this resource.", 104 "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.", 105 "patternProperties": { 106 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 107 "description": "This property shall specify a valid odata or Redfish property.", 108 "type": [ 109 "array", 110 "boolean", 111 "integer", 112 "number", 113 "null", 114 "object", 115 "string" 116 ] 117 } 118 }, 119 "properties": { 120 "ActiveSoftwareImage": { 121 "$ref": "http://redfish.dmtf.org/schemas/v1/SoftwareInventory.json#/definitions/SoftwareInventory", 122 "description": "The link to the software inventory resource that represents the active firmware image for this controller.", 123 "longDescription": "This property shall contain a link to a resource of type `SoftwareInventory` that represents the active firmware image for this controller.", 124 "readonly": false, 125 "versionAdded": "v1_10_0" 126 }, 127 "NetworkDeviceFunctions": { 128 "description": "An array of links to the network device functions associated with this network controller.", 129 "items": { 130 "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.json#/definitions/NetworkDeviceFunction" 131 }, 132 "longDescription": "This property shall contain an array of links to resources of type `NetworkDeviceFunction` that represent the network device functions associated with this network controller.", 133 "readonly": true, 134 "type": "array" 135 }, 136 "NetworkDeviceFunctions@odata.count": { 137 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 138 }, 139 "NetworkPorts": { 140 "deprecated": "This property has been deprecated in favor of the `Ports` property.", 141 "description": "An array of links to the network ports associated with this network controller.", 142 "items": { 143 "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkPort.json#/definitions/NetworkPort" 144 }, 145 "longDescription": "This property shall contain an array of links to resources of type `NetworkPort` that represent the network ports associated with this network controller.", 146 "readonly": true, 147 "type": "array", 148 "versionDeprecated": "v1_5_0" 149 }, 150 "NetworkPorts@odata.count": { 151 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 152 }, 153 "Oem": { 154 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 155 "description": "The OEM extension property.", 156 "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements." 157 }, 158 "PCIeDevices": { 159 "description": "An array of links to the PCIe devices associated with this network controller.", 160 "items": { 161 "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeDevice" 162 }, 163 "longDescription": "This property shall contain an array of links to resources of type `PCIeDevice` that represent the PCIe devices associated with this network controller.", 164 "readonly": true, 165 "type": "array" 166 }, 167 "PCIeDevices@odata.count": { 168 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 169 }, 170 "Ports": { 171 "description": "An array of links to the ports associated with this network controller.", 172 "items": { 173 "$ref": "http://redfish.dmtf.org/schemas/v1/Port.json#/definitions/Port" 174 }, 175 "longDescription": "This property shall contain an array of links to resources of type `Port` that represent the ports associated with this network controller.", 176 "readonly": true, 177 "type": "array", 178 "versionAdded": "v1_5_0" 179 }, 180 "Ports@odata.count": { 181 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 182 }, 183 "SoftwareImages": { 184 "description": "The images that are associated with this controller.", 185 "items": { 186 "$ref": "http://redfish.dmtf.org/schemas/v1/SoftwareInventory.json#/definitions/SoftwareInventory" 187 }, 188 "longDescription": "This property shall contain an array of links to resource of type `SoftwareInventory` that represent the firmware images that apply to this controller.", 189 "readonly": true, 190 "type": "array", 191 "versionAdded": "v1_10_0" 192 }, 193 "SoftwareImages@odata.count": { 194 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 195 } 196 }, 197 "type": "object" 198 }, 199 "Controllers": { 200 "additionalProperties": false, 201 "description": "A network controller ASIC that makes up part of a network adapter.", 202 "longDescription": "This type shall describe a network controller ASIC that makes up part of a network adapter.", 203 "patternProperties": { 204 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 205 "description": "This property shall specify a valid odata or Redfish property.", 206 "type": [ 207 "array", 208 "boolean", 209 "integer", 210 "number", 211 "null", 212 "object", 213 "string" 214 ] 215 } 216 }, 217 "properties": { 218 "ControllerCapabilities": { 219 "$ref": "#/definitions/ControllerCapabilities", 220 "description": "The capabilities of this controller.", 221 "longDescription": "This property shall contain the capabilities of this controller." 222 }, 223 "FirmwarePackageVersion": { 224 "description": "The version of the user-facing firmware package.", 225 "longDescription": "This property shall contain the version number of the user-facing firmware package.", 226 "readonly": true, 227 "type": [ 228 "string", 229 "null" 230 ] 231 }, 232 "Identifiers": { 233 "description": "The durable names for the network adapter controller.", 234 "items": { 235 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Identifier" 236 }, 237 "longDescription": "This property shall contain a list of all known durable names for the controller associated with the network adapter.", 238 "type": "array", 239 "versionAdded": "v1_3_0" 240 }, 241 "Links": { 242 "$ref": "#/definitions/ControllerLinks", 243 "description": "The links to other resources that are related to this resource.", 244 "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource." 245 }, 246 "Location": { 247 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location", 248 "description": "The location of the network adapter controller.", 249 "longDescription": "This property shall contain the location information of the controller associated with the network adapter.", 250 "versionAdded": "v1_1_0" 251 }, 252 "PCIeInterface": { 253 "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeInterface", 254 "description": "The PCIe interface details for this controller.", 255 "longDescription": "This property shall contain details for the PCIe interface that connects this PCIe-based controller to its host.", 256 "versionAdded": "v1_2_0" 257 } 258 }, 259 "type": "object" 260 }, 261 "DataCenterBridging": { 262 "additionalProperties": false, 263 "description": "Data center bridging (DCB) for capabilities of a controller.", 264 "longDescription": "This type shall describe the capability, status, and configuration values related to data center bridging (DCB) for a controller.", 265 "patternProperties": { 266 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 267 "description": "This property shall specify a valid odata or Redfish property.", 268 "type": [ 269 "array", 270 "boolean", 271 "integer", 272 "number", 273 "null", 274 "object", 275 "string" 276 ] 277 } 278 }, 279 "properties": { 280 "Capable": { 281 "description": "An indication of whether this controller is capable of data center bridging (DCB).", 282 "longDescription": "This property shall indicate whether this controller is capable of data center bridging (DCB).", 283 "readonly": true, 284 "type": [ 285 "boolean", 286 "null" 287 ] 288 } 289 }, 290 "type": "object" 291 }, 292 "NPIV": { 293 "additionalProperties": false, 294 "description": "N_Port ID Virtualization (NPIV) capabilities for a controller.", 295 "longDescription": "This type shall contain N_Port ID Virtualization (NPIV) capabilities for a controller.", 296 "patternProperties": { 297 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 298 "description": "This property shall specify a valid odata or Redfish property.", 299 "type": [ 300 "array", 301 "boolean", 302 "integer", 303 "number", 304 "null", 305 "object", 306 "string" 307 ] 308 } 309 }, 310 "properties": { 311 "MaxDeviceLogins": { 312 "description": "The maximum number of N_Port ID Virtualization (NPIV) logins allowed simultaneously from all ports on this controller.", 313 "longDescription": "This property shall contain the maximum number of N_Port ID Virtualization (NPIV) logins allowed simultaneously from all ports on this controller.", 314 "readonly": true, 315 "type": [ 316 "integer", 317 "null" 318 ] 319 }, 320 "MaxPortLogins": { 321 "description": "The maximum number of N_Port ID Virtualization (NPIV) logins allowed per physical port on this controller.", 322 "longDescription": "This property shall contain the maximum number of N_Port ID Virtualization (NPIV) logins allowed per physical port on this controller.", 323 "readonly": true, 324 "type": [ 325 "integer", 326 "null" 327 ] 328 } 329 }, 330 "type": "object" 331 }, 332 "NetworkAdapter": { 333 "additionalProperties": false, 334 "description": "The `NetworkAdapter` schema represents a physical network adapter capable of connecting to a computer network. Examples include but are not limited to Ethernet, Fibre Channel, and converged network adapters.", 335 "longDescription": "This resource shall represent a physical network adapter capable of connecting to a computer network in a Redfish implementation. Services should represent adapters that contain multiple controllers with independent management interfaces as multiple `NetworkAdapter` resources.", 336 "patternProperties": { 337 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 338 "description": "This property shall specify a valid odata or Redfish property.", 339 "type": [ 340 "array", 341 "boolean", 342 "integer", 343 "number", 344 "null", 345 "object", 346 "string" 347 ] 348 } 349 }, 350 "properties": { 351 "@odata.context": { 352 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" 353 }, 354 "@odata.etag": { 355 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" 356 }, 357 "@odata.id": { 358 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" 359 }, 360 "@odata.type": { 361 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" 362 }, 363 "Actions": { 364 "$ref": "#/definitions/Actions", 365 "description": "The available actions for this resource.", 366 "longDescription": "This property shall contain the available actions for this resource." 367 }, 368 "Assembly": { 369 "$ref": "http://redfish.dmtf.org/schemas/v1/Assembly.json#/definitions/Assembly", 370 "description": "The link to the assembly resource associated with this adapter.", 371 "longDescription": "This property shall contain a link to a resource of type `Assembly`.", 372 "readonly": true, 373 "versionAdded": "v1_1_0" 374 }, 375 "Certificates": { 376 "$ref": "http://redfish.dmtf.org/schemas/v1/CertificateCollection.json#/definitions/CertificateCollection", 377 "description": "The link to a collection of certificates for device identity and attestation.", 378 "longDescription": "This property shall contain a link to a resource collection of type `CertificateCollection` that contains certificates for device identity and attestation.", 379 "readonly": true, 380 "versionAdded": "v1_6_0" 381 }, 382 "Controllers": { 383 "description": "The set of network controllers ASICs that make up this NetworkAdapter.", 384 "items": { 385 "$ref": "#/definitions/Controllers" 386 }, 387 "longDescription": "This property shall contain the set of network controllers ASICs that make up this network adapter.", 388 "type": "array" 389 }, 390 "Description": { 391 "anyOf": [ 392 { 393 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" 394 }, 395 { 396 "type": "null" 397 } 398 ], 399 "readonly": true 400 }, 401 "EnvironmentMetrics": { 402 "$ref": "http://redfish.dmtf.org/schemas/v1/EnvironmentMetrics.json#/definitions/EnvironmentMetrics", 403 "description": "The link to the environment metrics for this network adapter.", 404 "longDescription": "This property shall contain a link to a resource of type `EnvironmentMetrics` that specifies the environment metrics for this network adapter.", 405 "readonly": true, 406 "versionAdded": "v1_7_0" 407 }, 408 "Id": { 409 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", 410 "readonly": true 411 }, 412 "Identifiers": { 413 "description": "The durable names for the network adapter.", 414 "items": { 415 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Identifier" 416 }, 417 "longDescription": "This property shall contain a list of all known durable names for the network adapter.", 418 "type": "array", 419 "versionAdded": "v1_4_0" 420 }, 421 "LLDPEnabled": { 422 "description": "Enable or disable LLDP globally for an adapter.", 423 "longDescription": "This property shall contain the state indicating whether LLDP is globally enabled on a network adapter. If set to `false`, the `LLDPEnabled` value for the ports associated with this adapter shall be disregarded.", 424 "readonly": false, 425 "type": "boolean", 426 "versionAdded": "v1_7_0" 427 }, 428 "Location": { 429 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location", 430 "description": "The location of the network adapter.", 431 "longDescription": "This property shall contain the location information of the network adapter.", 432 "versionAdded": "v1_4_0" 433 }, 434 "Manufacturer": { 435 "description": "The manufacturer or OEM of this network adapter.", 436 "longDescription": "This property shall contain a value that represents the manufacturer of the network adapter.", 437 "readonly": true, 438 "type": [ 439 "string", 440 "null" 441 ] 442 }, 443 "Measurements": { 444 "deprecated": "This property has been deprecated in favor of the `ComponentIntegrity` resource.", 445 "description": "An array of DSP0274-defined measurement blocks.", 446 "items": { 447 "$ref": "http://redfish.dmtf.org/schemas/v1/SoftwareInventory.json#/definitions/MeasurementBlock" 448 }, 449 "longDescription": "This property shall contain an array of DSP0274-defined measurement blocks.", 450 "type": "array", 451 "versionAdded": "v1_6_0", 452 "versionDeprecated": "v1_9_0" 453 }, 454 "Metrics": { 455 "anyOf": [ 456 { 457 "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkAdapterMetrics.json#/definitions/NetworkAdapterMetrics" 458 }, 459 { 460 "type": "null" 461 } 462 ], 463 "description": "The link to the metrics associated with this adapter.", 464 "longDescription": "This property shall contain a link to a resource of type `NetworkAdapterMetrics` that contains the metrics associated with this adapter.", 465 "readonly": true, 466 "versionAdded": "v1_7_0" 467 }, 468 "Model": { 469 "description": "The model string for this network adapter.", 470 "longDescription": "This property shall contain the information about how the manufacturer refers to this network adapter.", 471 "readonly": true, 472 "type": [ 473 "string", 474 "null" 475 ] 476 }, 477 "Name": { 478 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", 479 "readonly": true 480 }, 481 "NetworkDeviceFunctions": { 482 "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunctionCollection.json#/definitions/NetworkDeviceFunctionCollection", 483 "description": "The link to the collection of network device functions associated with this network adapter.", 484 "longDescription": "This property shall contain a link to a resource collection of type `NetworkDeviceFunctionCollection`.", 485 "readonly": true 486 }, 487 "NetworkPorts": { 488 "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkPortCollection.json#/definitions/NetworkPortCollection", 489 "deprecated": "This property has been deprecated in favor of the `Ports` property.", 490 "description": "The link to the collection of network ports associated with this network adapter.", 491 "longDescription": "This property shall contain a link to a resource collection of type `NetworkPortCollection`.", 492 "readonly": true, 493 "versionDeprecated": "v1_5_0" 494 }, 495 "Oem": { 496 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 497 "description": "The OEM extension property.", 498 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." 499 }, 500 "PartNumber": { 501 "description": "Part number for this network adapter.", 502 "longDescription": "This property shall contain the part number for the network adapter as defined by the manufacturer.", 503 "readonly": true, 504 "type": [ 505 "string", 506 "null" 507 ] 508 }, 509 "PortSplitting": { 510 "anyOf": [ 511 { 512 "$ref": "#/definitions/PortSplitting" 513 }, 514 { 515 "type": "null" 516 } 517 ], 518 "description": "The port splitting capabilities for this controller.", 519 "longDescription": "This property shall contain capability, status, and configuration values related to physically subdividing the lanes of ports on this controller.", 520 "versionAdded": "v1_13_0" 521 }, 522 "Ports": { 523 "$ref": "http://redfish.dmtf.org/schemas/v1/PortCollection.json#/definitions/PortCollection", 524 "description": "The link to the collection of ports associated with this network adapter.", 525 "longDescription": "This property shall contain a link to a resource collection of type `PortCollection`.", 526 "readonly": true, 527 "versionAdded": "v1_5_0" 528 }, 529 "Processors": { 530 "$ref": "http://redfish.dmtf.org/schemas/v1/ProcessorCollection.json#/definitions/ProcessorCollection", 531 "description": "The link to the collection of offload processors contained in this network adapter.", 532 "longDescription": "This property shall contain a link to a resource collection of type `ProcessorCollection` that represent the offload processors contained in this network adapter.", 533 "readonly": true, 534 "versionAdded": "v1_8_0" 535 }, 536 "SKU": { 537 "description": "The manufacturer SKU for this network adapter.", 538 "longDescription": "This property shall contain the SKU for the network adapter.", 539 "readonly": true, 540 "type": [ 541 "string", 542 "null" 543 ] 544 }, 545 "SerialNumber": { 546 "description": "The serial number for this network adapter.", 547 "longDescription": "This property shall contain the serial number for the network adapter.", 548 "readonly": true, 549 "type": [ 550 "string", 551 "null" 552 ] 553 }, 554 "Status": { 555 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", 556 "description": "The status and health of the resource and its subordinate or dependent resources.", 557 "longDescription": "This property shall contain any status or health properties of the resource." 558 } 559 }, 560 "required": [ 561 "@odata.id", 562 "@odata.type", 563 "Id", 564 "Name" 565 ], 566 "type": "object" 567 }, 568 "NicPartitioning": { 569 "additionalProperties": false, 570 "description": "NIC Partitioning capability, status, and configuration for a controller.", 571 "longDescription": "This type shall contain the capability, status, and configuration values for a controller.", 572 "patternProperties": { 573 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 574 "description": "This property shall specify a valid odata or Redfish property.", 575 "type": [ 576 "array", 577 "boolean", 578 "integer", 579 "number", 580 "null", 581 "object", 582 "string" 583 ] 584 } 585 }, 586 "properties": { 587 "NparCapable": { 588 "description": "An indication of whether the controller supports NIC function partitioning.", 589 "longDescription": "This property shall indicate whether the controller supports NIC function partitioning.", 590 "readonly": true, 591 "type": [ 592 "boolean", 593 "null" 594 ], 595 "versionAdded": "v1_2_0" 596 }, 597 "NparEnabled": { 598 "description": "An indication of whether NIC function partitioning is active on this controller.", 599 "longDescription": "This property shall indicate whether NIC function partitioning is active on this controller.", 600 "readonly": false, 601 "type": [ 602 "boolean", 603 "null" 604 ], 605 "versionAdded": "v1_2_0" 606 } 607 }, 608 "type": "object" 609 }, 610 "OemActions": { 611 "additionalProperties": true, 612 "description": "The available OEM-specific actions for this resource.", 613 "longDescription": "This type shall contain the available OEM-specific actions for this resource.", 614 "patternProperties": { 615 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 616 "description": "This property shall specify a valid odata or Redfish property.", 617 "type": [ 618 "array", 619 "boolean", 620 "integer", 621 "number", 622 "null", 623 "object", 624 "string" 625 ] 626 } 627 }, 628 "properties": {}, 629 "type": "object" 630 }, 631 "PortSplitting": { 632 "additionalProperties": false, 633 "description": "The port splitting capabilities for a controller.", 634 "longDescription": "This type shall contain capability, status, and configuration values related to physically subdividing the lanes of ports on a controller.", 635 "patternProperties": { 636 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 637 "description": "This property shall specify a valid odata or Redfish property.", 638 "type": [ 639 "array", 640 "boolean", 641 "integer", 642 "number", 643 "null", 644 "object", 645 "string" 646 ] 647 } 648 }, 649 "properties": { 650 "CurrentConfiguration": { 651 "description": "The current port splitting configuration for this controller.", 652 "items": { 653 "$ref": "#/definitions/PortSplittingSubconfiguration" 654 }, 655 "longDescription": "This property shall contain the current port splitting configuration for this controller.", 656 "type": "array", 657 "versionAdded": "v1_13_0" 658 }, 659 "MaximumSubports": { 660 "description": "The maximum number of subdivided ports that this controller supports.", 661 "longDescription": "This property shall contain the maximum number of subdivided ports that this controller supports.", 662 "readonly": true, 663 "type": [ 664 "integer", 665 "null" 666 ], 667 "versionAdded": "v1_13_0" 668 }, 669 "MaximumSubportsPerPort": { 670 "description": "The maximum number of subdivided ports split from a single physical port that this controller supports.", 671 "longDescription": "This property shall contain the maximum number of subdivided ports split from a single physical port that this controller supports.", 672 "readonly": true, 673 "type": [ 674 "integer", 675 "null" 676 ], 677 "versionAdded": "v1_13_0" 678 }, 679 "SupportedConfigurations": { 680 "description": "The port splitting configurations this controller supports.", 681 "items": { 682 "$ref": "#/definitions/PortSplittingSubconfigurationList" 683 }, 684 "longDescription": "This property shall contain the port splitting configurations that this controller supports. Properties contained in this property shall be read-only.", 685 "type": "array", 686 "versionAdded": "v1_13_0" 687 } 688 }, 689 "type": "object" 690 }, 691 "PortSplittingSubconfiguration": { 692 "additionalProperties": false, 693 "description": "A port splitting subconfiguration for one or more physical ports on a controller.", 694 "longDescription": "This type shall contain a port splitting subconfiguration for one or more physical ports on a controller.", 695 "patternProperties": { 696 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 697 "description": "This property shall specify a valid odata or Redfish property.", 698 "type": [ 699 "array", 700 "boolean", 701 "integer", 702 "number", 703 "null", 704 "object", 705 "string" 706 ] 707 } 708 }, 709 "properties": { 710 "EndingPhysicalPort": { 711 "description": "The last physical port to which this subconfiguration applies.", 712 "longDescription": "This property shall contain the last physical port to which this subconfiguration applies. Specifically, the splitting for ports `StartPort` through `EndPort`, inclusive, is characterized by this subconfiguration. Each set of subconfigurations shall cover all physical ports on the controller and shall describe splitting for each port exactly once.", 713 "readonly": false, 714 "type": [ 715 "integer", 716 "null" 717 ], 718 "versionAdded": "v1_13_0" 719 }, 720 "FirstSubportId": { 721 "description": "The first identifier to assign to subports in this subconfiguration. Subport identifiers are assigned sequentially to the subports starting with those for `StartPort` and working through to those for `EndPort`.", 722 "longDescription": "This property shall contain the first identifier to assign to subports in this subconfiguration. Subport identifiers shall be assigned sequentially to the subports starting with those for `StartPort` and working through to those for `EndPort`.", 723 "readonly": false, 724 "type": [ 725 "integer", 726 "null" 727 ], 728 "versionAdded": "v1_13_0" 729 }, 730 "Lanes": { 731 "description": "The number of lanes for each subport.", 732 "items": { 733 "type": [ 734 "integer", 735 "null" 736 ] 737 }, 738 "longDescription": "This property shall contain the number of lanes for each subport. The number of members in this array shall equal the value contained in `SubportsPerPort` in the enclosing subconfiguration.", 739 "readonly": false, 740 "type": "array", 741 "versionAdded": "v1_13_0" 742 }, 743 "LinkSpeedGbps": { 744 "description": "The configured link speed for each subport.", 745 "items": { 746 "type": [ 747 "integer", 748 "null" 749 ] 750 }, 751 "longDescription": "This property shall contain the configured link speed for each subport. The number of members in this array shall equal the value contained in `SubportsPerPort` in the enclosing subconfiguration.", 752 "readonly": false, 753 "type": "array", 754 "versionAdded": "v1_13_0" 755 }, 756 "StartingPhysicalPort": { 757 "description": "The first physical port to which this subconfiguration applies.", 758 "longDescription": "This property shall contain the first physical port to which this subconfiguration applies.", 759 "readonly": false, 760 "type": [ 761 "integer", 762 "null" 763 ], 764 "versionAdded": "v1_13_0" 765 }, 766 "SubportsPerPort": { 767 "description": "The number of subports created from each port in this subconfiguration.", 768 "longDescription": "This property shall contain the number of subports created from each port in this subconfiguration.", 769 "readonly": false, 770 "type": [ 771 "integer", 772 "null" 773 ], 774 "versionAdded": "v1_13_0" 775 } 776 }, 777 "type": "object" 778 }, 779 "PortSplittingSubconfigurationList": { 780 "additionalProperties": false, 781 "description": "A port splitting configuration for a controller.", 782 "longDescription": "This type shall contain a port splitting configuration for a controller.", 783 "patternProperties": { 784 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 785 "description": "This property shall specify a valid odata or Redfish property.", 786 "type": [ 787 "array", 788 "boolean", 789 "integer", 790 "number", 791 "null", 792 "object", 793 "string" 794 ] 795 } 796 }, 797 "properties": { 798 "Subconfigurations": { 799 "description": "The set of subconfigurations that collectively define a port splitting configuration for this controller.", 800 "items": { 801 "$ref": "#/definitions/PortSplittingSubconfiguration" 802 }, 803 "longDescription": "This property shall contain the set of subconfigurations that collectively define a port splitting configuration for this controller.", 804 "type": "array", 805 "versionAdded": "v1_13_0" 806 } 807 }, 808 "type": "object" 809 }, 810 "Reset": { 811 "additionalProperties": false, 812 "description": "This action resets the network adapter.", 813 "longDescription": "This action shall reset a network adapter.", 814 "parameters": { 815 "ResetType": { 816 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/ResetType", 817 "description": "The type of reset.", 818 "longDescription": "This parameter shall contain the type of reset. The service can accept a request without the parameter and shall perform a `GracefulRestart`." 819 } 820 }, 821 "patternProperties": { 822 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 823 "description": "This property shall specify a valid odata or Redfish property.", 824 "type": [ 825 "array", 826 "boolean", 827 "integer", 828 "number", 829 "null", 830 "object", 831 "string" 832 ] 833 } 834 }, 835 "properties": { 836 "target": { 837 "description": "Link to invoke action", 838 "format": "uri-reference", 839 "type": "string" 840 }, 841 "title": { 842 "description": "Friendly action name", 843 "type": "string" 844 } 845 }, 846 "type": "object", 847 "versionAdded": "v1_11_0" 848 }, 849 "ResetSettingsToDefault": { 850 "additionalProperties": false, 851 "description": "This action is to clear the settings back to factory defaults.", 852 "longDescription": "This action shall reset of all active and pending settings back to factory default settings upon reset of the network adapter.", 853 "parameters": {}, 854 "patternProperties": { 855 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 856 "description": "This property shall specify a valid odata or Redfish property.", 857 "type": [ 858 "array", 859 "boolean", 860 "integer", 861 "number", 862 "null", 863 "object", 864 "string" 865 ] 866 } 867 }, 868 "properties": { 869 "target": { 870 "description": "Link to invoke action", 871 "format": "uri-reference", 872 "type": "string" 873 }, 874 "title": { 875 "description": "Friendly action name", 876 "type": "string" 877 } 878 }, 879 "type": "object" 880 }, 881 "SRIOV": { 882 "additionalProperties": false, 883 "description": "Single-root input/output virtualization (SR-IOV) capabilities.", 884 "longDescription": "This type shall contain single-root input/output virtualization (SR-IOV) capabilities.", 885 "patternProperties": { 886 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 887 "description": "This property shall specify a valid odata or Redfish property.", 888 "type": [ 889 "array", 890 "boolean", 891 "integer", 892 "number", 893 "null", 894 "object", 895 "string" 896 ] 897 } 898 }, 899 "properties": { 900 "SRIOVEnabled": { 901 "description": "An indication of whether single root input/output virtualization (SR-IOV) is enabled for this controller.", 902 "longDescription": "This property shall indicate whether single root input/output virtualization (SR-IOV) is enabled for this controller.", 903 "readonly": false, 904 "type": "boolean", 905 "versionAdded": "v1_12_0" 906 }, 907 "SRIOVVEPACapable": { 908 "description": "An indication of whether this controller supports single root input/output virtualization (SR-IOV) in Virtual Ethernet Port Aggregator (VEPA) mode.", 909 "longDescription": "This property shall indicate whether this controller supports single root input/output virtualization (SR-IOV) in Virtual Ethernet Port Aggregator (VEPA) mode.", 910 "readonly": true, 911 "type": [ 912 "boolean", 913 "null" 914 ] 915 } 916 }, 917 "type": "object" 918 }, 919 "VirtualFunction": { 920 "additionalProperties": false, 921 "description": "A virtual function of a controller.", 922 "longDescription": "This type shall describe the capability, status, and configuration values related to a virtual function for a controller.", 923 "patternProperties": { 924 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 925 "description": "This property shall specify a valid odata or Redfish property.", 926 "type": [ 927 "array", 928 "boolean", 929 "integer", 930 "number", 931 "null", 932 "object", 933 "string" 934 ] 935 } 936 }, 937 "properties": { 938 "DeviceMaxCount": { 939 "description": "The maximum number of virtual functions supported by this controller.", 940 "longDescription": "This property shall contain the maximum number of virtual functions supported by this controller.", 941 "readonly": true, 942 "type": [ 943 "integer", 944 "null" 945 ] 946 }, 947 "MinAssignmentGroupSize": { 948 "description": "The minimum number of virtual functions that can be allocated or moved between physical functions for this controller.", 949 "longDescription": "This property shall contain the minimum number of virtual functions that can be allocated or moved between physical functions for this controller.", 950 "readonly": true, 951 "type": [ 952 "integer", 953 "null" 954 ] 955 }, 956 "NetworkPortMaxCount": { 957 "description": "The maximum number of virtual functions supported per network port for this controller.", 958 "longDescription": "This property shall contain the maximum number of virtual functions supported per network port for this controller.", 959 "readonly": true, 960 "type": [ 961 "integer", 962 "null" 963 ] 964 } 965 }, 966 "type": "object" 967 }, 968 "VirtualizationOffload": { 969 "additionalProperties": false, 970 "description": "A Virtualization offload capability of a controller.", 971 "longDescription": "This type shall describe the capability, status, and configuration values related to a virtualization offload for a controller.", 972 "patternProperties": { 973 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 974 "description": "This property shall specify a valid odata or Redfish property.", 975 "type": [ 976 "array", 977 "boolean", 978 "integer", 979 "number", 980 "null", 981 "object", 982 "string" 983 ] 984 } 985 }, 986 "properties": { 987 "SRIOV": { 988 "$ref": "#/definitions/SRIOV", 989 "description": "Single-root input/output virtualization (SR-IOV) capabilities.", 990 "longDescription": "This property shall contain single-root input/output virtualization (SR-IOV) capabilities." 991 }, 992 "VirtualFunction": { 993 "$ref": "#/definitions/VirtualFunction", 994 "description": "The virtual function of the controller.", 995 "longDescription": "This property shall describe the capability, status, and configuration values related to the virtual function for this controller." 996 } 997 }, 998 "type": "object" 999 } 1000 }, 1001 "language": "en", 1002 "owningEntity": "DMTF", 1003 "release": "2025.3", 1004 "title": "#NetworkAdapter.v1_13_0.NetworkAdapter" 1005}