1{ 2 "$id": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.v1_9_2.json", 3 "$ref": "#/definitions/NetworkDeviceFunction", 4 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", 5 "copyright": "Copyright 2014-2024 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 "Oem": { 27 "$ref": "#/definitions/OemActions", 28 "description": "The available OEM-specific actions for this resource.", 29 "longDescription": "This property shall contain the available OEM-specific actions for this resource.", 30 "versionAdded": "v1_1_0" 31 } 32 }, 33 "type": "object" 34 }, 35 "AuthenticationMethod": { 36 "enum": [ 37 "None", 38 "CHAP", 39 "MutualCHAP" 40 ], 41 "enumDescriptions": { 42 "CHAP": "iSCSI Challenge Handshake Authentication Protocol (CHAP) authentication is used.", 43 "MutualCHAP": "iSCSI Mutual Challenge Handshake Authentication Protocol (CHAP) authentication is used.", 44 "None": "No iSCSI authentication is used." 45 }, 46 "type": "string" 47 }, 48 "BootMode": { 49 "enum": [ 50 "Disabled", 51 "PXE", 52 "iSCSI", 53 "FibreChannel", 54 "FibreChannelOverEthernet", 55 "HTTP" 56 ], 57 "enumDescriptions": { 58 "Disabled": "Do not indicate to UEFI/BIOS that this device is bootable.", 59 "FibreChannel": "Boot this device by using the embedded Fibre Channel support and configuration. Only applicable if the `NetDevFuncType` is `FibreChannel`.", 60 "FibreChannelOverEthernet": "Boot this device by using the embedded Fibre Channel over Ethernet (FCoE) boot support and configuration. Only applicable if the `NetDevFuncType` is `FibreChannelOverEthernet`.", 61 "HTTP": "Boot this device by using the embedded HTTP/HTTPS support. Only applicable if the `NetDevFuncType` is `Ethernet`.", 62 "PXE": "Boot this device by using the embedded PXE support. Only applicable if the `NetDevFuncType` is `Ethernet` or `InfiniBand`.", 63 "iSCSI": "Boot this device by using the embedded iSCSI boot support and configuration. Only applicable if the `NetDevFuncType` is `iSCSI` or `Ethernet`." 64 }, 65 "enumVersionAdded": { 66 "HTTP": "v1_9_0" 67 }, 68 "type": "string" 69 }, 70 "BootTargets": { 71 "additionalProperties": false, 72 "description": "A Fibre Channel boot target configured for a network device function.", 73 "longDescription": "This type shall describe a Fibre Channel boot target configured for a network device function.", 74 "patternProperties": { 75 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 76 "description": "This property shall specify a valid odata or Redfish property.", 77 "type": [ 78 "array", 79 "boolean", 80 "integer", 81 "number", 82 "null", 83 "object", 84 "string" 85 ] 86 } 87 }, 88 "properties": { 89 "BootPriority": { 90 "description": "The relative priority for this entry in the boot targets array.", 91 "longDescription": "This property shall contain the relative priority for this entry in the boot targets array. Lower numbers shall represent higher priority, with zero being the highest priority. The `BootPriority` shall be unique for all entries of the `BootTargets` array.", 92 "readonly": false, 93 "type": [ 94 "integer", 95 "null" 96 ] 97 }, 98 "LUNID": { 99 "description": "The logical unit number (LUN) ID from which to boot on the device to which the corresponding WWPN refers.", 100 "longDescription": "This property shall contain the logical unit number (LUN) ID from which to boot on the device to which the corresponding WWPN refers.", 101 "readonly": false, 102 "type": [ 103 "string", 104 "null" 105 ] 106 }, 107 "WWPN": { 108 "description": "The World Wide Port Name (WWPN) from which to boot.", 109 "longDescription": "This property shall contain World Wide Port Name (WWPN) from which to boot.", 110 "readonly": false, 111 "type": [ 112 "string", 113 "null" 114 ] 115 } 116 }, 117 "type": "object" 118 }, 119 "DataDirection": { 120 "enum": [ 121 "None", 122 "Ingress", 123 "Egress" 124 ], 125 "enumDescriptions": { 126 "Egress": "Indicates that this limit is enforced on packets and bytes transmitted by the network device function.", 127 "Ingress": "Indicates that this limit is enforced on packets and bytes received by the network device function.", 128 "None": "Indicates that this limit not enforced." 129 }, 130 "type": "string" 131 }, 132 "Ethernet": { 133 "additionalProperties": false, 134 "description": "This type describes Ethernet capabilities, status, and configuration for a network device function.", 135 "longDescription": "This type shall describe the Ethernet capabilities, status, and configuration values for a network device function.", 136 "patternProperties": { 137 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 138 "description": "This property shall specify a valid odata or Redfish property.", 139 "type": [ 140 "array", 141 "boolean", 142 "integer", 143 "number", 144 "null", 145 "object", 146 "string" 147 ] 148 } 149 }, 150 "properties": { 151 "EthernetInterfaces": { 152 "anyOf": [ 153 { 154 "$ref": "http://redfish.dmtf.org/schemas/v1/EthernetInterfaceCollection.json#/definitions/EthernetInterfaceCollection" 155 }, 156 { 157 "type": "null" 158 } 159 ], 160 "description": "The Ethernet interface collection that contains the interfaces on this network device function.", 161 "longDescription": "This property shall contain a link to a collection of type `EthernetInterfaceCollection` that represent the Ethernet interfaces present on this network device function. This property shall not be present if this network device function is not referenced by a `NetworkInterface` resource.", 162 "readonly": true, 163 "versionAdded": "v1_7_0" 164 }, 165 "MACAddress": { 166 "description": "The currently configured MAC address.", 167 "longDescription": "This property shall contain the effective current MAC address of this network device function. If an assignable MAC address is not supported, this is a read-only alias of the `PermanentMACAddress`.", 168 "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$", 169 "readonly": false, 170 "type": [ 171 "string", 172 "null" 173 ] 174 }, 175 "MTUSize": { 176 "description": "The hardware maximum transmission unit (MTU) configured for this network device function.", 177 "longDescription": "The hardware maximum transmission unit (MTU) configured for this network device function. This value serves as a default for the OS driver when booting, but may be overridden by the OS. After the OS boots and while the driver is loaded, the effective MTU size may be found in the associated `EthernetInterface` resource.", 178 "readonly": false, 179 "type": [ 180 "integer", 181 "null" 182 ] 183 }, 184 "MTUSizeMaximum": { 185 "description": "The largest maximum transmission unit (MTU) size supported for this network device function.", 186 "longDescription": "This property shall contain the largest maximum transmission unit (MTU) size supported for this network device function.", 187 "readonly": true, 188 "type": [ 189 "integer", 190 "null" 191 ], 192 "versionAdded": "v1_5_0" 193 }, 194 "PermanentMACAddress": { 195 "description": "The permanent MAC address assigned to this function.", 196 "longDescription": "This property shall contain the permanent MAC Address of this function. Typically, this value is programmed during manufacturing. This address is not assignable.", 197 "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$", 198 "readonly": true, 199 "type": [ 200 "string", 201 "null" 202 ] 203 }, 204 "VLAN": { 205 "$ref": "http://redfish.dmtf.org/schemas/v1/VLanNetworkInterface.json#/definitions/VLAN", 206 "description": "The VLAN information for this interface. If this network interface supports more than one VLAN, this property is not present.", 207 "longDescription": "This property shall contain the VLAN for this interface. If this interface supports more than one VLAN, the `VLAN` property shall not be present and the `VLANs` property shall be present instead.", 208 "versionAdded": "v1_3_0" 209 }, 210 "VLANs": { 211 "$ref": "http://redfish.dmtf.org/schemas/v1/VLanNetworkInterfaceCollection.json#/definitions/VLanNetworkInterfaceCollection", 212 "deprecated": "This property has been deprecated in favor of representing multiple VLANs as `EthernetInterface` resources.", 213 "description": "The link to a collection of VLANs. This property is used only if the interface supports more than one VLAN.", 214 "longDescription": "This property shall contain a link to a resource collection of type `VLanNetworkInterfaceCollection`. If this property is used, the VLANEnabled and VLAN Id property shall not be used.", 215 "readonly": true, 216 "versionAdded": "v1_3_0", 217 "versionDeprecated": "v1_7_0" 218 } 219 }, 220 "type": "object" 221 }, 222 "FibreChannel": { 223 "additionalProperties": false, 224 "description": "This type describes Fibre Channel capabilities, status, and configuration for a network device function.", 225 "longDescription": "This type shall describe the Fibre Channel capabilities, status, and configuration values for a network device function.", 226 "patternProperties": { 227 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 228 "description": "This property shall specify a valid odata or Redfish property.", 229 "type": [ 230 "array", 231 "boolean", 232 "integer", 233 "number", 234 "null", 235 "object", 236 "string" 237 ] 238 } 239 }, 240 "properties": { 241 "AllowFIPVLANDiscovery": { 242 "description": "An indication of whether the FCoE Initialization Protocol (FIP) populates the FCoE VLAN ID.", 243 "longDescription": "For FCoE connections, this boolean property shall indicate whether the FIP VLAN Discovery Protocol determines the FCoE VLAN ID selected by the network device function for the FCoE connection. If `true` and the FIP VLAN discovery succeeds, the `FCoEActiveVLANId` property shall reflect the FCoE VLAN ID to use for all FCoE traffic. If `false` or if the FIP VLAN Discovery protocol fails, the `FCoELocalVLANId` shall be used for all FCoE traffic and the `FCoEActiveVLANId` shall reflect the `FCoELocalVLANId`.", 244 "readonly": false, 245 "type": [ 246 "boolean", 247 "null" 248 ] 249 }, 250 "BootTargets": { 251 "description": "An array of Fibre Channel boot targets configured for this network device function.", 252 "items": { 253 "anyOf": [ 254 { 255 "$ref": "#/definitions/BootTargets" 256 }, 257 { 258 "type": "null" 259 } 260 ] 261 }, 262 "longDescription": "This property shall contain an array of Fibre Channel boot targets configured for this network device function.", 263 "type": "array" 264 }, 265 "FCoEActiveVLANId": { 266 "description": "The active FCoE VLAN ID.", 267 "longDescription": "For FCoE connections, this property shall contain `null` or a VLAN ID currently being used for FCoE traffic. When the FCoE link is down this value shall be `null`. When the FCoE link is up this value shall be either the `FCoELocalVLANId` property or a VLAN discovered through the FIP protocol.", 268 "maximum": 4094, 269 "minimum": 0, 270 "readonly": true, 271 "type": [ 272 "integer", 273 "null" 274 ] 275 }, 276 "FCoELocalVLANId": { 277 "description": "The locally configured FCoE VLAN ID.", 278 "longDescription": "For FCoE connections, this property shall contain the VLAN ID configured locally by setting this property. This value shall be used for FCoE traffic to this network device function during boot unless AllowFIPVLANDiscovery is `true` and a valid FCoE VLAN ID is found through the FIP VLAN Discovery Protocol.", 279 "maximum": 4094, 280 "minimum": 0, 281 "readonly": false, 282 "type": [ 283 "integer", 284 "null" 285 ] 286 }, 287 "FibreChannelId": { 288 "description": "The Fibre Channel ID that the switch assigns for this interface.", 289 "longDescription": "This property shall indicate the Fibre Channel ID that the switch assigns for this interface.", 290 "readonly": true, 291 "type": [ 292 "string", 293 "null" 294 ], 295 "versionAdded": "v1_3_0" 296 }, 297 "PermanentWWNN": { 298 "description": "The permanent World Wide Node Name (WWNN) address assigned to this function.", 299 "longDescription": "This property shall contain the permanent World Wide Node Name (WWNN) of this function. Typically, this value is programmed during manufacturing. This address is not assignable.", 300 "pattern": "^([0-9A-Fa-f]{2}[:-]){7}([0-9A-Fa-f]{2})$", 301 "readonly": true, 302 "type": [ 303 "string", 304 "null" 305 ] 306 }, 307 "PermanentWWPN": { 308 "description": "The permanent World Wide Port Name (WWPN) address assigned to this function.", 309 "longDescription": "This property shall contain the permanent World Wide Port Name (WWPN) of this function. Typically, this value is programmed during manufacturing. This address is not assignable.", 310 "readonly": true, 311 "type": [ 312 "string", 313 "null" 314 ] 315 }, 316 "WWNN": { 317 "description": "The currently configured World Wide Node Name (WWNN) address of this function.", 318 "longDescription": "This property shall contain the effective current World Wide Node Name (WWNN) of this function. If an assignable WWNN is not supported, this is a read-only alias of the permanent WWNN.", 319 "pattern": "^([0-9A-Fa-f]{2}[:-]){7}([0-9A-Fa-f]{2})$", 320 "readonly": false, 321 "type": [ 322 "string", 323 "null" 324 ] 325 }, 326 "WWNSource": { 327 "anyOf": [ 328 { 329 "$ref": "#/definitions/WWNSource" 330 }, 331 { 332 "type": "null" 333 } 334 ], 335 "description": "The configuration source of the World Wide Names (WWN) for this World Wide Node Name (WWNN) and World Wide Port Name (WWPN) connection.", 336 "longDescription": "This property shall contain the configuration source of the World Wide Name (WWN) for this World Wide Node Name (WWNN) and World Wide Port Name (WWPN) connection.", 337 "readonly": false 338 }, 339 "WWPN": { 340 "description": "The currently configured World Wide Port Name (WWPN) address of this function.", 341 "longDescription": "This property shall contain the effective current World Wide Port Name (WWPN) of this function. If an assignable WWPN is not supported, this is a read-only alias of the permanent WWPN.", 342 "pattern": "^([0-9A-Fa-f]{2}[:-]){7}([0-9A-Fa-f]{2})$", 343 "readonly": false, 344 "type": [ 345 "string", 346 "null" 347 ] 348 } 349 }, 350 "type": "object" 351 }, 352 "HTTPBoot": { 353 "additionalProperties": false, 354 "description": "The HTTP and HTTPS boot capabilities, status, and configuration for a network device function.", 355 "longDescription": "This type shall describe the HTTP and HTTPS boot capabilities, status, and configuration values for a network device function.", 356 "patternProperties": { 357 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 358 "description": "This property shall specify a valid odata or Redfish property.", 359 "type": [ 360 "array", 361 "boolean", 362 "integer", 363 "number", 364 "null", 365 "object", 366 "string" 367 ] 368 } 369 }, 370 "properties": { 371 "BootMediaURI": { 372 "description": "The URI of the boot media loaded with this network device function.", 373 "format": "uri-reference", 374 "longDescription": "This property shall contain the URI of the boot media loaded with this network device function. An empty string shall indicate no boot media is configured. All other values shall begin with `http://` or `https://`.", 375 "readonly": false, 376 "type": [ 377 "string", 378 "null" 379 ], 380 "versionAdded": "v1_9_0" 381 } 382 }, 383 "type": "object" 384 }, 385 "IPAddressType": { 386 "enum": [ 387 "IPv4", 388 "IPv6" 389 ], 390 "enumDescriptions": { 391 "IPv4": "IPv4 addressing is used for all IP-fields in this object.", 392 "IPv6": "IPv6 addressing is used for all IP-fields in this object." 393 }, 394 "type": "string" 395 }, 396 "InfiniBand": { 397 "additionalProperties": false, 398 "description": "This type describes InfiniBand capabilities, status, and configuration of a network device function.", 399 "longDescription": "This type shall describe the InfiniBand capabilities, status, and configuration values for a network device function.", 400 "patternProperties": { 401 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 402 "description": "This property shall specify a valid odata or Redfish property.", 403 "type": [ 404 "array", 405 "boolean", 406 "integer", 407 "number", 408 "null", 409 "object", 410 "string" 411 ] 412 } 413 }, 414 "properties": { 415 "MTUSize": { 416 "description": "The maximum transmission unit (MTU) configured for this network device function.", 417 "longDescription": "The maximum transmission unit (MTU) configured for this network device function.", 418 "readonly": false, 419 "type": [ 420 "integer", 421 "null" 422 ], 423 "versionAdded": "v1_5_0" 424 }, 425 "NodeGUID": { 426 "description": "This is the currently configured node GUID of the network device function.", 427 "longDescription": "This property shall contain the effective current node GUID of this virtual port of this network device function. If an assignable node GUID is not supported, this is a read-only alias of the PermanentNodeGUID.", 428 "pattern": "^([0-9A-Fa-f]{4}[:-]){3}([0-9A-Fa-f]{4})$", 429 "readonly": true, 430 "type": [ 431 "string", 432 "null" 433 ], 434 "versionAdded": "v1_5_0" 435 }, 436 "PermanentNodeGUID": { 437 "description": "The permanent node GUID assigned to this network device function.", 438 "longDescription": "This property shall contain the permanent node GUID of this network device function. Typically, this value is programmed during manufacturing. This address is not assignable.", 439 "pattern": "^([0-9A-Fa-f]{4}[:-]){3}([0-9A-Fa-f]{4})$", 440 "readonly": true, 441 "type": [ 442 "string", 443 "null" 444 ], 445 "versionAdded": "v1_5_0" 446 }, 447 "PermanentPortGUID": { 448 "description": "The permanent port GUID assigned to this network device function.", 449 "longDescription": "This property shall contain the permanent port GUID of this network device function. Typically, this value is programmed during manufacturing. This address is not assignable.", 450 "pattern": "^([0-9A-Fa-f]{4}[:-]){3}([0-9A-Fa-f]{4})$", 451 "readonly": true, 452 "type": [ 453 "string", 454 "null" 455 ], 456 "versionAdded": "v1_5_0" 457 }, 458 "PermanentSystemGUID": { 459 "description": "The permanent system GUID assigned to this network device function.", 460 "longDescription": "This property shall contain the permanent system GUID of this network device function. Typically, this value is programmed during manufacturing. This address is not assignable.", 461 "pattern": "^([0-9A-Fa-f]{4}[:-]){3}([0-9A-Fa-f]{4})$", 462 "readonly": true, 463 "type": [ 464 "string", 465 "null" 466 ], 467 "versionAdded": "v1_5_0" 468 }, 469 "PortGUID": { 470 "description": "The currently configured port GUID of the network device function.", 471 "longDescription": "This property shall contain the effective current virtual port GUID of this network device function. If an assignable port GUID is not supported, this is a read-only alias of the PermanentPortGUID.", 472 "pattern": "^([0-9A-Fa-f]{4}[:-]){3}([0-9A-Fa-f]{4})$", 473 "readonly": true, 474 "type": [ 475 "string", 476 "null" 477 ], 478 "versionAdded": "v1_5_0" 479 }, 480 "SupportedMTUSizes": { 481 "description": "The maximum transmission unit (MTU) sizes supported for this network device function.", 482 "items": { 483 "type": [ 484 "integer", 485 "null" 486 ] 487 }, 488 "longDescription": "This property shall contain an array of the maximum transmission unit (MTU) sizes supported for this network device function.", 489 "readonly": true, 490 "type": "array", 491 "versionAdded": "v1_5_0" 492 }, 493 "SystemGUID": { 494 "description": "This is the currently configured system GUID of the network device function.", 495 "longDescription": "This property shall contain the effective current system GUID of this virtual port of this network device function. If an assignable system GUID is not supported, this is a read-only alias of the PermanentSystemGUID.", 496 "pattern": "^([0-9A-Fa-f]{4}[:-]){3}([0-9A-Fa-f]{4})$", 497 "readonly": true, 498 "type": [ 499 "string", 500 "null" 501 ], 502 "versionAdded": "v1_5_0" 503 } 504 }, 505 "type": "object" 506 }, 507 "Limit": { 508 "additionalProperties": false, 509 "description": "This type describes the packet and byte limit of a network device function.", 510 "longDescription": "This type shall describe a single array element of the packet and byte limits of a network device function.", 511 "patternProperties": { 512 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 513 "description": "This property shall specify a valid odata or Redfish property.", 514 "type": [ 515 "array", 516 "boolean", 517 "integer", 518 "number", 519 "null", 520 "object", 521 "string" 522 ] 523 } 524 }, 525 "properties": { 526 "BurstBytesPerSecond": { 527 "description": "The maximum number of bytes per second in a burst for this network device function.", 528 "longDescription": "This property shall contain the maximum number of bytes per second in a burst allowed for this network device function.", 529 "readonly": false, 530 "type": [ 531 "integer", 532 "null" 533 ], 534 "versionAdded": "v1_7_0" 535 }, 536 "BurstPacketsPerSecond": { 537 "description": "The maximum number of packets per second in a burst for this network device function.", 538 "longDescription": "This property shall contain the maximum number of packets per second in a burst allowed for this network device function.", 539 "readonly": false, 540 "type": [ 541 "integer", 542 "null" 543 ], 544 "versionAdded": "v1_7_0" 545 }, 546 "Direction": { 547 "anyOf": [ 548 { 549 "$ref": "#/definitions/DataDirection" 550 }, 551 { 552 "type": "null" 553 } 554 ], 555 "description": "Indicates the direction of the data to which this limit applies.", 556 "longDescription": "This property shall indicate the direction of the data to which this limit applies for this network device function.", 557 "readonly": false, 558 "versionAdded": "v1_7_0" 559 }, 560 "SustainedBytesPerSecond": { 561 "description": "The maximum number of sustained bytes per second for this network device function.", 562 "longDescription": "This property shall contain the maximum number of sustained bytes per second allowed for this network device function.", 563 "readonly": false, 564 "type": [ 565 "integer", 566 "null" 567 ], 568 "versionAdded": "v1_7_0" 569 }, 570 "SustainedPacketsPerSecond": { 571 "description": "The maximum number of sustained packets per second for this network device function.", 572 "longDescription": "This property shall contain the maximum number of sustained packets per second allowed for this network device function.", 573 "readonly": false, 574 "type": [ 575 "integer", 576 "null" 577 ], 578 "versionAdded": "v1_7_0" 579 } 580 }, 581 "type": "object" 582 }, 583 "Links": { 584 "additionalProperties": false, 585 "description": "The links to other resources that are related to this resource.", 586 "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.", 587 "patternProperties": { 588 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 589 "description": "This property shall specify a valid odata or Redfish property.", 590 "type": [ 591 "array", 592 "boolean", 593 "integer", 594 "number", 595 "null", 596 "object", 597 "string" 598 ] 599 } 600 }, 601 "properties": { 602 "Endpoints": { 603 "description": "An array of links to endpoints associated with this network device function.", 604 "items": { 605 "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint" 606 }, 607 "longDescription": "This property shall contain an array of links to resources of type `Endpoint` that are associated with this network device function.", 608 "readonly": true, 609 "type": "array", 610 "versionAdded": "v1_2_0" 611 }, 612 "Endpoints@odata.count": { 613 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 614 }, 615 "EthernetInterface": { 616 "$ref": "http://redfish.dmtf.org/schemas/v1/EthernetInterface.json#/definitions/EthernetInterface", 617 "deprecated": "This property has been deprecated in favor of `EthernetInterfaces` as each `NetworkDeviceFunction` could have more than one `EthernetInterface`.", 618 "description": "The link to a virtual Ethernet interface that was created when one of the network device function VLANs is represented as a virtual NIC for the purpose of showing the IP address associated with that VLAN.", 619 "longDescription": "This property shall contain a link to a resource of type `EthernetInterface` that represents a virtual interface that was created when one of the network device function VLANs is represented as a virtual NIC for the purpose of showing the IP address associated with that VLAN. The `EthernetInterfaceType` property of that resource shall contain the value `Virtual`.", 620 "versionAdded": "v1_4_0", 621 "versionDeprecated": "v1_7_0" 622 }, 623 "EthernetInterfaces": { 624 "description": "The links to Ethernet interfaces that were created when one of the network device function VLANs is represented as a virtual NIC for the purpose of showing the IP address associated with that VLAN.", 625 "items": { 626 "$ref": "http://redfish.dmtf.org/schemas/v1/EthernetInterface.json#/definitions/EthernetInterface" 627 }, 628 "longDescription": "This property shall contain an array of links to resources of type `EthernetInterface` that represent the virtual interfaces that were created when one of the network device function VLANs is represented as a virtual NIC for the purpose of showing the IP address associated with that VLAN.", 629 "type": "array", 630 "versionAdded": "v1_7_0" 631 }, 632 "EthernetInterfaces@odata.count": { 633 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 634 }, 635 "Oem": { 636 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 637 "description": "The OEM extension property.", 638 "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements." 639 }, 640 "OffloadProcessors": { 641 "description": "The processors that perform offload computation for this network function, such as with a SmartNIC.", 642 "items": { 643 "$ref": "http://redfish.dmtf.org/schemas/v1/Processor.json#/definitions/Processor" 644 }, 645 "longDescription": "This property shall contain an array of links to resources of type `Processor` that represent the processors that performs offload computation for this network function, such as with a SmartNIC. This property shall not be present if `OffloadSystem` is present.", 646 "readonly": true, 647 "type": "array", 648 "versionAdded": "v1_7_0" 649 }, 650 "OffloadProcessors@odata.count": { 651 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 652 }, 653 "OffloadSystem": { 654 "$ref": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.json#/definitions/ComputerSystem", 655 "description": "The system that performs offload computation for this network function, such as with a SmartNIC.", 656 "longDescription": "This property shall contain a link to a resource of type `ComputerSystem` that represents the system that performs offload computation for this network function, such as with a SmartNIC. The `SystemType` property contained in the referenced `ComputerSystem` resource should contain the value `DPU`. This property shall not be present if OffloadProcessors is present.", 657 "readonly": true, 658 "versionAdded": "v1_7_0" 659 }, 660 "PCIeFunction": { 661 "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeFunction.json#/definitions/PCIeFunction", 662 "description": "The link to the PCIe function associated with this network device function.", 663 "longDescription": "This property shall contain a link to a resource of type `PCIeFunction` that represents the PCIe function associated with this network device function.", 664 "readonly": true 665 }, 666 "PhysicalNetworkPortAssignment": { 667 "$ref": "http://redfish.dmtf.org/schemas/v1/Port.json#/definitions/Port", 668 "description": "The physical port to which this network device function is currently assigned.", 669 "longDescription": "This property shall contain a link to a resource of type `Port` to which this network device function is currently assigned. This value shall be one of the `AssignablePhysicalPorts` array members.", 670 "versionAdded": "v1_5_0" 671 }, 672 "PhysicalPortAssignment": { 673 "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkPort.json#/definitions/NetworkPort", 674 "deprecated": "This property has been deprecated in favor of the `PhysicalNetworkPortAssignment` property.", 675 "description": "The physical port to which this network device function is currently assigned.", 676 "longDescription": "This property shall contain a link to a resource of type `NetworkPort` to which this network device function is currently assigned. This value shall be one of the AssignablePhysicalPorts array members.", 677 "versionAdded": "v1_3_0", 678 "versionDeprecated": "v1_5_0" 679 } 680 }, 681 "type": "object" 682 }, 683 "NetworkDeviceFunction": { 684 "additionalProperties": false, 685 "description": "The `NetworkDeviceFunction` schema represents a logical interface that a network adapter exposes.", 686 "longDescription": "This resource shall represent a logical interface that a network adapter exposes in a Redfish implementation.", 687 "patternProperties": { 688 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 689 "description": "This property shall specify a valid odata or Redfish property.", 690 "type": [ 691 "array", 692 "boolean", 693 "integer", 694 "number", 695 "null", 696 "object", 697 "string" 698 ] 699 } 700 }, 701 "properties": { 702 "@odata.context": { 703 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" 704 }, 705 "@odata.etag": { 706 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" 707 }, 708 "@odata.id": { 709 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" 710 }, 711 "@odata.type": { 712 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" 713 }, 714 "Actions": { 715 "$ref": "#/definitions/Actions", 716 "description": "The available actions for this resource.", 717 "longDescription": "This property shall contain the available actions for this resource.", 718 "versionAdded": "v1_1_0" 719 }, 720 "AllowDeny": { 721 "$ref": "http://redfish.dmtf.org/schemas/v1/AllowDenyCollection.json#/definitions/AllowDenyCollection", 722 "description": "The link to the collection of allow and deny permissions for packets leaving and arriving to this network device function.", 723 "longDescription": "This property shall contain a link to a resource collection of type `AllowDenyCollection` that contains the permissions for packets leaving and arriving to this network device function.", 724 "readonly": true, 725 "versionAdded": "v1_7_0" 726 }, 727 "AssignablePhysicalNetworkPorts": { 728 "description": "An array of physical ports to which this network device function can be assigned.", 729 "items": { 730 "$ref": "http://redfish.dmtf.org/schemas/v1/Port.json#/definitions/Port" 731 }, 732 "longDescription": "This property shall contain an array of links to resources of type `Port` that are the physical ports to which this network device function can be assigned.", 733 "readonly": true, 734 "type": "array", 735 "versionAdded": "v1_5_0" 736 }, 737 "AssignablePhysicalNetworkPorts@odata.count": { 738 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 739 }, 740 "AssignablePhysicalPorts": { 741 "deprecated": "This property has been deprecated in favor of the `AssignablePhysicalNetworkPorts` property.", 742 "description": "An array of physical ports to which this network device function can be assigned.", 743 "items": { 744 "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkPort.json#/definitions/NetworkPort" 745 }, 746 "longDescription": "This property shall contain an array of links to resources of type `NetworkPort` that are the physical ports to which this network device function can be assigned.", 747 "readonly": true, 748 "type": "array", 749 "versionDeprecated": "v1_5_0" 750 }, 751 "AssignablePhysicalPorts@odata.count": { 752 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count" 753 }, 754 "BootMode": { 755 "anyOf": [ 756 { 757 "$ref": "#/definitions/BootMode" 758 }, 759 { 760 "type": "null" 761 } 762 ], 763 "description": "The boot mode configured for this network device function.", 764 "longDescription": "This property shall contain the boot mode configured for this network device function. If the value is not `Disabled`, this network device function shall be configured for boot by using the specified technology.", 765 "readonly": false 766 }, 767 "Description": { 768 "anyOf": [ 769 { 770 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" 771 }, 772 { 773 "type": "null" 774 } 775 ], 776 "readonly": true 777 }, 778 "DeviceEnabled": { 779 "description": "An indication of whether the network device function is enabled.", 780 "longDescription": "This property shall indicate whether the network device function is enabled. The operating system shall not enumerate or see disabled network device functions.", 781 "readonly": false, 782 "type": [ 783 "boolean", 784 "null" 785 ] 786 }, 787 "Ethernet": { 788 "$ref": "#/definitions/Ethernet", 789 "description": "The Ethernet capabilities, status, and configuration values for this network device function.", 790 "longDescription": "This property shall contain Ethernet capabilities, status, and configuration values for this network device function." 791 }, 792 "FibreChannel": { 793 "$ref": "#/definitions/FibreChannel", 794 "description": "The Fibre Channel capabilities, status, and configuration values for this network device function.", 795 "longDescription": "This property shall contain Fibre Channel capabilities, status, and configuration values for this network device function." 796 }, 797 "HTTPBoot": { 798 "$ref": "#/definitions/HTTPBoot", 799 "description": "The HTTP and HTTPS boot capabilities, status, and configuration values for this network device function.", 800 "longDescription": "This property shall contain HTTP and HTTPS boot capabilities, status, and configuration values for this network device function.", 801 "versionAdded": "v1_9_0" 802 }, 803 "Id": { 804 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", 805 "readonly": true 806 }, 807 "InfiniBand": { 808 "$ref": "#/definitions/InfiniBand", 809 "description": "The InfiniBand capabilities, status, and configuration values for this network device function.", 810 "longDescription": "This property shall contain InfiniBand capabilities, status, and configuration values for this network device function.", 811 "versionAdded": "v1_5_0" 812 }, 813 "Limits": { 814 "description": "The byte and packet limits for this network device function.", 815 "items": { 816 "anyOf": [ 817 { 818 "$ref": "#/definitions/Limit" 819 }, 820 { 821 "type": "null" 822 } 823 ] 824 }, 825 "longDescription": "This property shall contain an array of byte and packet limits for this network device function.", 826 "type": "array", 827 "versionAdded": "v1_7_0" 828 }, 829 "Links": { 830 "$ref": "#/definitions/Links", 831 "description": "The links to other resources that are related to this resource.", 832 "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource." 833 }, 834 "MaxVirtualFunctions": { 835 "description": "The number of virtual functions that are available for this network device function.", 836 "longDescription": "This property shall contain the number of virtual functions that are available for this network device function.", 837 "readonly": true, 838 "type": [ 839 "integer", 840 "null" 841 ] 842 }, 843 "Metrics": { 844 "anyOf": [ 845 { 846 "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunctionMetrics.json#/definitions/NetworkDeviceFunctionMetrics" 847 }, 848 { 849 "type": "null" 850 } 851 ], 852 "description": "The link to the metrics associated with this network function.", 853 "longDescription": "This property shall contain a link to a resource of type `NetworkDeviceFunctionMetrics` that contains the metrics associated with this network function.", 854 "readonly": true, 855 "versionAdded": "v1_6_0" 856 }, 857 "Name": { 858 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", 859 "readonly": true 860 }, 861 "NetDevFuncCapabilities": { 862 "description": "An array of capabilities for this network device function.", 863 "items": { 864 "anyOf": [ 865 { 866 "$ref": "#/definitions/NetworkDeviceTechnology" 867 }, 868 { 869 "type": "null" 870 } 871 ] 872 }, 873 "longDescription": "This property shall contain an array of capabilities for this network device function.", 874 "readonly": true, 875 "type": "array" 876 }, 877 "NetDevFuncType": { 878 "anyOf": [ 879 { 880 "$ref": "#/definitions/NetworkDeviceTechnology" 881 }, 882 { 883 "type": "null" 884 } 885 ], 886 "description": "The configured capability of this network device function.", 887 "longDescription": "This property shall contain the configured capability of this network device function.", 888 "readonly": false 889 }, 890 "Oem": { 891 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 892 "description": "The OEM extension property.", 893 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." 894 }, 895 "PhysicalNetworkPortAssignment": { 896 "$ref": "http://redfish.dmtf.org/schemas/v1/Port.json#/definitions/Port", 897 "deprecated": "This property has been deprecated in favor of `PhysicalNetworkPortAssignment` within `Links` to avoid loops on expand.", 898 "description": "The physical port to which this network device function is currently assigned.", 899 "longDescription": "This property shall contain a link to a resource of type `Port` that is the physical port to which this network device function is currently assigned. This value shall be one of the `AssignablePhysicalNetworkPorts` array members.", 900 "readonly": true, 901 "versionAdded": "v1_5_0", 902 "versionDeprecated": "v1_8_0" 903 }, 904 "PhysicalPortAssignment": { 905 "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkPort.json#/definitions/NetworkPort", 906 "deprecated": "This property has been deprecated and moved to the `Links` property to avoid loops on expand.", 907 "description": "The physical port to which this network device function is currently assigned.", 908 "longDescription": "This property shall contain a link to a resource of type `NetworkPort` that is the physical port to which this network device function is currently assigned. This value shall be one of the `AssignablePhysicalPorts` array members.", 909 "readonly": true, 910 "versionDeprecated": "v1_3_0" 911 }, 912 "SAVIEnabled": { 913 "description": "Indicates if Source Address Validation Improvement (SAVI) is enabled for this network device function.", 914 "longDescription": "This property shall indicate if the RFC7039-defined Source Address Validation Improvement (SAVI) is enabled for this network device function.", 915 "readonly": false, 916 "type": [ 917 "boolean", 918 "null" 919 ], 920 "versionAdded": "v1_7_0" 921 }, 922 "Status": { 923 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", 924 "description": "The status and health of the resource and its subordinate or dependent resources.", 925 "longDescription": "This property shall contain any status or health properties of the resource." 926 }, 927 "VirtualFunctionsEnabled": { 928 "description": "An indication of whether single root input/output virtualization (SR-IOV) virtual functions are enabled for this network device function.", 929 "longDescription": "This property shall indicate whether single root input/output virtualization (SR-IOV) virtual functions are enabled for this network device function.", 930 "readonly": true, 931 "type": [ 932 "boolean", 933 "null" 934 ] 935 }, 936 "iSCSIBoot": { 937 "$ref": "#/definitions/iSCSIBoot", 938 "description": "The iSCSI boot capabilities, status, and configuration values for this network device function.", 939 "longDescription": "This property shall contain iSCSI boot capabilities, status, and configuration values for this network device function." 940 } 941 }, 942 "required": [ 943 "@odata.id", 944 "@odata.type", 945 "Id", 946 "Name" 947 ], 948 "type": "object" 949 }, 950 "NetworkDeviceTechnology": { 951 "enum": [ 952 "Disabled", 953 "Ethernet", 954 "FibreChannel", 955 "iSCSI", 956 "FibreChannelOverEthernet", 957 "InfiniBand" 958 ], 959 "enumDescriptions": { 960 "Disabled": "Neither enumerated nor visible to the operating system.", 961 "Ethernet": "Appears to the operating system as an Ethernet device.", 962 "FibreChannel": "Appears to the operating system as a Fibre Channel device.", 963 "FibreChannelOverEthernet": "Appears to the operating system as an FCoE device.", 964 "InfiniBand": "Appears to the operating system as an InfiniBand device.", 965 "iSCSI": "Appears to the operating system as an iSCSI device." 966 }, 967 "enumVersionAdded": { 968 "InfiniBand": "v1_5_0" 969 }, 970 "type": "string" 971 }, 972 "OemActions": { 973 "additionalProperties": true, 974 "description": "The available OEM-specific actions for this resource.", 975 "longDescription": "This type shall contain the available OEM-specific actions for this resource.", 976 "patternProperties": { 977 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 978 "description": "This property shall specify a valid odata or Redfish property.", 979 "type": [ 980 "array", 981 "boolean", 982 "integer", 983 "number", 984 "null", 985 "object", 986 "string" 987 ] 988 } 989 }, 990 "properties": {}, 991 "type": "object" 992 }, 993 "WWNSource": { 994 "enum": [ 995 "ConfiguredLocally", 996 "ProvidedByFabric" 997 ], 998 "enumDescriptions": { 999 "ConfiguredLocally": "The set of FC/FCoE boot targets was applied locally through API or UI.", 1000 "ProvidedByFabric": "The set of FC/FCoE boot targets was applied by the Fibre Channel fabric." 1001 }, 1002 "type": "string" 1003 }, 1004 "iSCSIBoot": { 1005 "additionalProperties": false, 1006 "description": "The iSCSI boot capabilities, status, and configuration for a network device function.", 1007 "longDescription": "This type shall describe the iSCSI boot capabilities, status, and configuration values for a network device function.", 1008 "patternProperties": { 1009 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 1010 "description": "This property shall specify a valid odata or Redfish property.", 1011 "type": [ 1012 "array", 1013 "boolean", 1014 "integer", 1015 "number", 1016 "null", 1017 "object", 1018 "string" 1019 ] 1020 } 1021 }, 1022 "properties": { 1023 "AuthenticationMethod": { 1024 "anyOf": [ 1025 { 1026 "$ref": "#/definitions/AuthenticationMethod" 1027 }, 1028 { 1029 "type": "null" 1030 } 1031 ], 1032 "description": "The iSCSI boot authentication method for this network device function.", 1033 "longDescription": "This property shall contain the iSCSI boot authentication method for this network device function.", 1034 "readonly": false 1035 }, 1036 "CHAPSecret": { 1037 "description": "The shared secret for CHAP authentication.", 1038 "longDescription": "This property shall contain the shared secret for CHAP authentication.", 1039 "readonly": false, 1040 "type": [ 1041 "string", 1042 "null" 1043 ] 1044 }, 1045 "CHAPUsername": { 1046 "description": "The username for CHAP authentication.", 1047 "longDescription": "This property shall contain the username for CHAP authentication.", 1048 "readonly": false, 1049 "type": [ 1050 "string", 1051 "null" 1052 ] 1053 }, 1054 "IPAddressType": { 1055 "anyOf": [ 1056 { 1057 "$ref": "#/definitions/IPAddressType" 1058 }, 1059 { 1060 "type": "null" 1061 } 1062 ], 1063 "description": "The type of IP address being populated in the iSCSIBoot IP address fields.", 1064 "longDescription": "This property shall contain the type of IP address being populated in the iSCSIBoot IP address fields. Mixing IPv6 and IPv4 addresses on the same network device function shall not be permissible.", 1065 "readonly": false 1066 }, 1067 "IPMaskDNSViaDHCP": { 1068 "description": "An indication of whether the iSCSI boot initiator uses DHCP to obtain the initiator name, IP address, and netmask.", 1069 "longDescription": "This property shall indicate whether the iSCSI boot initiator uses DHCP to obtain the initiator name, IP address, and netmask.", 1070 "readonly": false, 1071 "type": [ 1072 "boolean", 1073 "null" 1074 ] 1075 }, 1076 "InitiatorDefaultGateway": { 1077 "description": "The IPv6 or IPv4 iSCSI boot default gateway.", 1078 "longDescription": "This property shall contain the IPv6 or IPv4 iSCSI boot default gateway.", 1079 "readonly": false, 1080 "type": [ 1081 "string", 1082 "null" 1083 ] 1084 }, 1085 "InitiatorIPAddress": { 1086 "description": "The IPv6 or IPv4 address of the iSCSI initiator.", 1087 "longDescription": "This property shall contain the IPv6 or IPv4 address of the iSCSI boot initiator.", 1088 "readonly": false, 1089 "type": [ 1090 "string", 1091 "null" 1092 ] 1093 }, 1094 "InitiatorName": { 1095 "description": "The iSCSI initiator name.", 1096 "longDescription": "This property shall contain the iSCSI boot initiator name. This property should match formats defined in RFC3720 or RFC3721.", 1097 "readonly": false, 1098 "type": [ 1099 "string", 1100 "null" 1101 ] 1102 }, 1103 "InitiatorNetmask": { 1104 "description": "The IPv6 or IPv4 netmask of the iSCSI boot initiator.", 1105 "longDescription": "This property shall contain the IPv6 or IPv4 netmask of the iSCSI boot initiator.", 1106 "readonly": false, 1107 "type": [ 1108 "string", 1109 "null" 1110 ] 1111 }, 1112 "MutualCHAPSecret": { 1113 "description": "The CHAP secret for two-way CHAP authentication.", 1114 "longDescription": "This property shall contain the CHAP secret for two-way CHAP authentication.", 1115 "readonly": false, 1116 "type": [ 1117 "string", 1118 "null" 1119 ] 1120 }, 1121 "MutualCHAPUsername": { 1122 "description": "The CHAP username for two-way CHAP authentication.", 1123 "longDescription": "This property shall contain the CHAP username for two-way CHAP authentication.", 1124 "readonly": false, 1125 "type": [ 1126 "string", 1127 "null" 1128 ] 1129 }, 1130 "PrimaryDNS": { 1131 "description": "The IPv6 or IPv4 address of the primary DNS server for the iSCSI boot initiator.", 1132 "longDescription": "This property shall contain the IPv6 or IPv4 address of the primary DNS server for the iSCSI boot initiator.", 1133 "readonly": false, 1134 "type": [ 1135 "string", 1136 "null" 1137 ] 1138 }, 1139 "PrimaryLUN": { 1140 "description": "The logical unit number (LUN) for the primary iSCSI boot target.", 1141 "longDescription": "This property shall contain the logical unit number (LUN) for the primary iSCSI boot target.", 1142 "readonly": false, 1143 "type": [ 1144 "integer", 1145 "null" 1146 ] 1147 }, 1148 "PrimaryTargetIPAddress": { 1149 "description": "The IPv4 or IPv6 address for the primary iSCSI boot target.", 1150 "longDescription": "This property shall contain the IPv4 or IPv6 address for the primary iSCSI boot target.", 1151 "readonly": false, 1152 "type": [ 1153 "string", 1154 "null" 1155 ] 1156 }, 1157 "PrimaryTargetName": { 1158 "description": "The name of the iSCSI primary boot target.", 1159 "longDescription": "This property shall contain the name of the primary iSCSI boot target. This property should match formats defined in RFC3720 or RFC3721.", 1160 "readonly": false, 1161 "type": [ 1162 "string", 1163 "null" 1164 ] 1165 }, 1166 "PrimaryTargetTCPPort": { 1167 "description": "The TCP port for the primary iSCSI boot target.", 1168 "longDescription": "This property shall contain the TCP port for the primary iSCSI boot target.", 1169 "readonly": false, 1170 "type": [ 1171 "integer", 1172 "null" 1173 ] 1174 }, 1175 "PrimaryVLANEnable": { 1176 "description": "An indication of whether the primary VLAN is enabled.", 1177 "longDescription": "This property shall indicate whether this VLAN is enabled for the primary iSCSI boot target.", 1178 "readonly": false, 1179 "type": [ 1180 "boolean", 1181 "null" 1182 ] 1183 }, 1184 "PrimaryVLANId": { 1185 "description": "The 802.1q VLAN ID to use for iSCSI boot from the primary target.", 1186 "longDescription": "This property shall contain the 802.1q VLAN ID to use for iSCSI boot from the primary target. This VLAN ID is only used if `PrimaryVLANEnable` is `true`.", 1187 "maximum": 4094, 1188 "minimum": 0, 1189 "readonly": false, 1190 "type": [ 1191 "integer", 1192 "null" 1193 ] 1194 }, 1195 "RouterAdvertisementEnabled": { 1196 "description": "An indication of whether IPv6 router advertisement is enabled for the iSCSI boot target.", 1197 "longDescription": "This property shall indicate whether IPv6 router advertisement is enabled for the iSCSI boot target. This setting shall apply to only IPv6 configurations.", 1198 "readonly": false, 1199 "type": [ 1200 "boolean", 1201 "null" 1202 ] 1203 }, 1204 "SecondaryDNS": { 1205 "description": "The IPv6 or IPv4 address of the secondary DNS server for the iSCSI boot initiator.", 1206 "longDescription": "This property shall contain the IPv6 or IPv4 address of the secondary DNS server for the iSCSI boot initiator.", 1207 "readonly": false, 1208 "type": [ 1209 "string", 1210 "null" 1211 ] 1212 }, 1213 "SecondaryLUN": { 1214 "description": "The logical unit number (LUN) for the secondary iSCSI boot target.", 1215 "longDescription": "This property shall contain the logical unit number (LUN) for the secondary iSCSI boot target.", 1216 "readonly": false, 1217 "type": [ 1218 "integer", 1219 "null" 1220 ] 1221 }, 1222 "SecondaryTargetIPAddress": { 1223 "description": "The IPv4 or IPv6 address for the secondary iSCSI boot target.", 1224 "longDescription": "This property shall contain the IPv4 or IPv6 address for the secondary iSCSI boot target.", 1225 "readonly": false, 1226 "type": [ 1227 "string", 1228 "null" 1229 ] 1230 }, 1231 "SecondaryTargetName": { 1232 "description": "The name of the iSCSI secondary boot target.", 1233 "longDescription": "This property shall contain the name of the secondary iSCSI boot target. This property should match formats defined in RFC3720 or RFC3721.", 1234 "readonly": false, 1235 "type": [ 1236 "string", 1237 "null" 1238 ] 1239 }, 1240 "SecondaryTargetTCPPort": { 1241 "description": "The TCP port for the secondary iSCSI boot target.", 1242 "longDescription": "This property shall contain the TCP port for the secondary iSCSI boot target.", 1243 "readonly": false, 1244 "type": [ 1245 "integer", 1246 "null" 1247 ] 1248 }, 1249 "SecondaryVLANEnable": { 1250 "description": "An indication of whether the secondary VLAN is enabled.", 1251 "longDescription": "This property shall indicate whether this VLAN is enabled for the secondary iSCSI boot target.", 1252 "readonly": false, 1253 "type": [ 1254 "boolean", 1255 "null" 1256 ] 1257 }, 1258 "SecondaryVLANId": { 1259 "description": "The 802.1q VLAN ID to use for iSCSI boot from the secondary target.", 1260 "longDescription": "This property shall contain the 802.1q VLAN ID to use for iSCSI boot from the secondary target. This VLAN ID is only used if `SecondaryVLANEnable` is `true`.", 1261 "maximum": 4094, 1262 "minimum": 0, 1263 "readonly": false, 1264 "type": [ 1265 "integer", 1266 "null" 1267 ] 1268 }, 1269 "TargetInfoViaDHCP": { 1270 "description": "An indication of whether the iSCSI boot target name, LUN, IP address, and netmask should be obtained from DHCP.", 1271 "longDescription": "This property shall indicate whether the iSCSI boot target name, LUN, IP address, and netmask should be obtained from DHCP.", 1272 "readonly": false, 1273 "type": [ 1274 "boolean", 1275 "null" 1276 ] 1277 } 1278 }, 1279 "type": "object" 1280 } 1281 }, 1282 "language": "en", 1283 "owningEntity": "DMTF", 1284 "release": "2022.2", 1285 "title": "#NetworkDeviceFunction.v1_9_2.NetworkDeviceFunction" 1286}