1{ 2 "$id": "http://redfish.dmtf.org/schemas/v1/NetworkPort.v1_4_3.json", 3 "$ref": "#/definitions/NetworkPort", 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 "FlowControl": { 36 "enum": [ 37 "None", 38 "TX", 39 "RX", 40 "TX_RX" 41 ], 42 "enumDescriptions": { 43 "None": "No IEEE 802.3x flow control is enabled on this port.", 44 "RX": "The link partner can initiate IEEE 802.3x flow control.", 45 "TX": "This station can initiate IEEE 802.3x flow control.", 46 "TX_RX": "This station or the link partner can initiate IEEE 802.3x flow control." 47 }, 48 "type": "string" 49 }, 50 "LinkNetworkTechnology": { 51 "enum": [ 52 "Ethernet", 53 "InfiniBand", 54 "FibreChannel" 55 ], 56 "enumDescriptions": { 57 "Ethernet": "The port is capable of connecting to an Ethernet network.", 58 "FibreChannel": "The port is capable of connecting to a Fibre Channel network.", 59 "InfiniBand": "The port is capable of connecting to an InfiniBand network." 60 }, 61 "type": "string" 62 }, 63 "LinkStatus": { 64 "enum": [ 65 "Down", 66 "Up", 67 "Starting", 68 "Training" 69 ], 70 "enumDescriptions": { 71 "Down": "The port is enabled but link is down.", 72 "Starting": "This link on this interface is starting. A physical link has been established, but the port is not able to transfer data.", 73 "Training": "This physical link on this interface is training.", 74 "Up": "The port is enabled and link is good (up)." 75 }, 76 "enumVersionAdded": { 77 "Starting": "v1_3_0", 78 "Training": "v1_3_0" 79 }, 80 "type": "string" 81 }, 82 "NetDevFuncMaxBWAlloc": { 83 "additionalProperties": false, 84 "description": "A maximum bandwidth allocation percentage for a network device functions associated with a port.", 85 "longDescription": "This type shall describe a maximum bandwidth percentage allocation for a network device function associated with a port.", 86 "patternProperties": { 87 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 88 "description": "This property shall specify a valid odata or Redfish property.", 89 "type": [ 90 "array", 91 "boolean", 92 "integer", 93 "number", 94 "null", 95 "object", 96 "string" 97 ] 98 } 99 }, 100 "properties": { 101 "MaxBWAllocPercent": { 102 "description": "The maximum bandwidth allocation percentage allocated to the corresponding network device function instance.", 103 "longDescription": "This property shall contain the maximum bandwidth percentage allocation for the associated network device function.", 104 "readonly": false, 105 "type": [ 106 "integer", 107 "null" 108 ], 109 "units": "%" 110 }, 111 "NetworkDeviceFunction": { 112 "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.json#/definitions/NetworkDeviceFunction", 113 "description": "The link to the network device function associated with this bandwidth setting of this network port.", 114 "longDescription": "This property shall contain a link to a resource of type `NetworkDeviceFunction` that represents the network device function associated with this bandwidth setting of this network port.", 115 "readonly": true 116 } 117 }, 118 "type": "object" 119 }, 120 "NetDevFuncMinBWAlloc": { 121 "additionalProperties": false, 122 "description": "A minimum bandwidth allocation percentage for a network device functions associated with a port.", 123 "longDescription": "This type shall describe a minimum bandwidth percentage allocation for a network device function associated with a port.", 124 "patternProperties": { 125 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 126 "description": "This property shall specify a valid odata or Redfish property.", 127 "type": [ 128 "array", 129 "boolean", 130 "integer", 131 "number", 132 "null", 133 "object", 134 "string" 135 ] 136 } 137 }, 138 "properties": { 139 "MinBWAllocPercent": { 140 "description": "The minimum bandwidth allocation percentage allocated to the corresponding network device function instance.", 141 "longDescription": "This property shall contain the minimum bandwidth percentage allocation for the associated network device function. The sum total of all minimum percentages shall not exceed 100.", 142 "readonly": false, 143 "type": [ 144 "integer", 145 "null" 146 ], 147 "units": "%" 148 }, 149 "NetworkDeviceFunction": { 150 "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.json#/definitions/NetworkDeviceFunction", 151 "description": "The link to the network device function associated with this bandwidth setting of this network port.", 152 "longDescription": "This property shall contain a link to a resource of type `NetworkDeviceFunction` that represents the network device function associated with this bandwidth setting of this network port.", 153 "readonly": true 154 } 155 }, 156 "type": "object" 157 }, 158 "NetworkPort": { 159 "additionalProperties": false, 160 "deprecated": "This schema has been deprecated in favor of the `Port` schema.", 161 "description": "The `NetworkPort` schema describes a network port, which is a discrete physical port that can connect to a network.", 162 "longDescription": "This resource shall represent a discrete physical port that can connect to a network in a Redfish implementation.", 163 "patternProperties": { 164 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 165 "description": "This property shall specify a valid odata or Redfish property.", 166 "type": [ 167 "array", 168 "boolean", 169 "integer", 170 "number", 171 "null", 172 "object", 173 "string" 174 ] 175 } 176 }, 177 "properties": { 178 "@odata.context": { 179 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" 180 }, 181 "@odata.etag": { 182 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" 183 }, 184 "@odata.id": { 185 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" 186 }, 187 "@odata.type": { 188 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" 189 }, 190 "Actions": { 191 "$ref": "#/definitions/Actions", 192 "description": "The available actions for this resource.", 193 "longDescription": "This property shall contain the available actions for this resource.", 194 "versionAdded": "v1_1_0" 195 }, 196 "ActiveLinkTechnology": { 197 "anyOf": [ 198 { 199 "$ref": "#/definitions/LinkNetworkTechnology" 200 }, 201 { 202 "type": "null" 203 } 204 ], 205 "description": "Network port active link technology.", 206 "longDescription": "This property shall contain the configured link technology of this port.", 207 "readonly": false 208 }, 209 "AssociatedNetworkAddresses": { 210 "description": "An array of configured MAC or WWN network addresses that are associated with this network port, including the programmed address of the lowest-numbered network device function, the configured but not active address, if applicable, the address for hardware port teaming, or other network addresses.", 211 "items": { 212 "type": [ 213 "string", 214 "null" 215 ] 216 }, 217 "longDescription": "This property shall contain an array of configured network addresses that are associated with this network port, including the programmed address of the lowest-numbered network device function, the configured but not active address if applicable, the address for hardware port teaming, or other network addresses.", 218 "readonly": true, 219 "type": "array" 220 }, 221 "CurrentLinkSpeedMbps": { 222 "description": "Network port current link speed.", 223 "longDescription": "This property shall contain the current configured link speed of this port.", 224 "readonly": false, 225 "type": [ 226 "integer", 227 "null" 228 ], 229 "units": "Mbit/s", 230 "versionAdded": "v1_2_0" 231 }, 232 "Description": { 233 "anyOf": [ 234 { 235 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" 236 }, 237 { 238 "type": "null" 239 } 240 ], 241 "readonly": true 242 }, 243 "EEEEnabled": { 244 "description": "An indication of whether IEEE 802.3az Energy-Efficient Ethernet (EEE) is enabled for this network port.", 245 "longDescription": "This property shall indicate whether IEEE 802.3az Energy-Efficient Ethernet (EEE) is enabled for this network port.", 246 "readonly": false, 247 "type": [ 248 "boolean", 249 "null" 250 ] 251 }, 252 "FCFabricName": { 253 "description": "The FC Fabric Name provided by the switch.", 254 "longDescription": "This property shall indicate the FC Fabric Name provided by the switch.", 255 "readonly": true, 256 "type": [ 257 "string", 258 "null" 259 ], 260 "versionAdded": "v1_2_0" 261 }, 262 "FCPortConnectionType": { 263 "anyOf": [ 264 { 265 "$ref": "#/definitions/PortConnectionType" 266 }, 267 { 268 "type": "null" 269 } 270 ], 271 "description": "The connection type of this port.", 272 "longDescription": "This property shall contain the connection type for this port.", 273 "readonly": true, 274 "versionAdded": "v1_2_0" 275 }, 276 "FlowControlConfiguration": { 277 "anyOf": [ 278 { 279 "$ref": "#/definitions/FlowControl" 280 }, 281 { 282 "type": "null" 283 } 284 ], 285 "description": "The locally configured 802.3x flow control setting for this network port.", 286 "longDescription": "This property shall contain the locally configured 802.3x flow control setting for this network port.", 287 "readonly": false 288 }, 289 "FlowControlStatus": { 290 "anyOf": [ 291 { 292 "$ref": "#/definitions/FlowControl" 293 }, 294 { 295 "type": "null" 296 } 297 ], 298 "description": "The 802.3x flow control behavior negotiated with the link partner for this network port (Ethernet-only).", 299 "longDescription": "This property shall contain the 802.3x flow control behavior negotiated with the link partner for this network port (Ethernet-only).", 300 "readonly": true 301 }, 302 "Id": { 303 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", 304 "readonly": true 305 }, 306 "LinkStatus": { 307 "anyOf": [ 308 { 309 "$ref": "#/definitions/LinkStatus" 310 }, 311 { 312 "type": "null" 313 } 314 ], 315 "description": "The status of the link between this port and its link partner.", 316 "longDescription": "This property shall contain the link status between this port and its link partner.", 317 "readonly": true 318 }, 319 "MaxFrameSize": { 320 "description": "The maximum frame size supported by the port.", 321 "longDescription": "This property shall contain the maximum frame size supported by the port.", 322 "readonly": true, 323 "type": [ 324 "integer", 325 "null" 326 ], 327 "units": "By", 328 "versionAdded": "v1_2_0" 329 }, 330 "Name": { 331 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", 332 "readonly": true 333 }, 334 "NetDevFuncMaxBWAlloc": { 335 "description": "An array of maximum bandwidth allocation percentages for the network device functions associated with this port.", 336 "items": { 337 "$ref": "#/definitions/NetDevFuncMaxBWAlloc" 338 }, 339 "longDescription": "This property shall contain an array of maximum bandwidth allocation percentages for the network device functions associated with this port.", 340 "type": "array" 341 }, 342 "NetDevFuncMinBWAlloc": { 343 "description": "An array of minimum bandwidth allocation percentages for the network device functions associated with this port.", 344 "items": { 345 "$ref": "#/definitions/NetDevFuncMinBWAlloc" 346 }, 347 "longDescription": "This property shall contain an array of minimum bandwidth percentage allocations for each of the network device functions associated with this port.", 348 "type": "array" 349 }, 350 "NumberDiscoveredRemotePorts": { 351 "description": "The number of ports not on this adapter that this port has discovered.", 352 "longDescription": "This property shall contain the number of ports not on this adapter that this port has discovered.", 353 "readonly": true, 354 "type": [ 355 "integer", 356 "null" 357 ], 358 "versionAdded": "v1_2_0" 359 }, 360 "Oem": { 361 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 362 "description": "The OEM extension property.", 363 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." 364 }, 365 "PhysicalPortNumber": { 366 "description": "The physical port number label for this port.", 367 "longDescription": "This property shall contain the physical port number on the network adapter hardware that this network port corresponds to. This value should match a value visible on the hardware.", 368 "readonly": true, 369 "type": [ 370 "string", 371 "null" 372 ] 373 }, 374 "PortMaximumMTU": { 375 "description": "The largest maximum transmission unit (MTU) that can be configured for this network port.", 376 "longDescription": "This property shall contain the largest maximum transmission unit (MTU) that can be configured for this network port.", 377 "readonly": true, 378 "type": [ 379 "integer", 380 "null" 381 ] 382 }, 383 "SignalDetected": { 384 "description": "An indication of whether the port has detected enough signal on enough lanes to establish a link.", 385 "longDescription": "This property shall indicate whether the port has detected enough signal on enough lanes to establish a link.", 386 "readonly": true, 387 "type": [ 388 "boolean", 389 "null" 390 ] 391 }, 392 "Status": { 393 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", 394 "description": "The status and health of the resource and its subordinate or dependent resources.", 395 "longDescription": "This property shall contain any status or health properties of the resource." 396 }, 397 "SupportedEthernetCapabilities": { 398 "description": "The set of Ethernet capabilities that this port supports.", 399 "items": { 400 "anyOf": [ 401 { 402 "$ref": "#/definitions/SupportedEthernetCapabilities" 403 }, 404 { 405 "type": "null" 406 } 407 ] 408 }, 409 "longDescription": "This property shall contain an array of zero or more Ethernet capabilities supported by this port.", 410 "readonly": true, 411 "type": "array" 412 }, 413 "SupportedLinkCapabilities": { 414 "description": "The link capabilities of this port.", 415 "items": { 416 "$ref": "#/definitions/SupportedLinkCapabilities" 417 }, 418 "longDescription": "This property shall describe the static capabilities of the port, irrespective of transient conditions such as cabling, interface module presence, or remote link partner status or configuration.", 419 "type": "array" 420 }, 421 "VendorId": { 422 "description": "The vendor Identification for this port.", 423 "longDescription": "This property shall indicate the vendor identification string information as provided by the manufacturer of this port.", 424 "readonly": true, 425 "type": [ 426 "string", 427 "null" 428 ], 429 "versionAdded": "v1_2_0" 430 }, 431 "WakeOnLANEnabled": { 432 "description": "An indication of whether Wake on LAN (WoL) is enabled for this network port.", 433 "longDescription": "This property shall indicate whether Wake on LAN (WoL) is enabled for this network port.", 434 "readonly": false, 435 "type": [ 436 "boolean", 437 "null" 438 ] 439 } 440 }, 441 "required": [ 442 "@odata.id", 443 "@odata.type", 444 "Id", 445 "Name" 446 ], 447 "type": "object", 448 "versionDeprecated": "v1_4_0" 449 }, 450 "OemActions": { 451 "additionalProperties": true, 452 "description": "The available OEM-specific actions for this resource.", 453 "longDescription": "This type shall contain the available OEM-specific actions for this resource.", 454 "patternProperties": { 455 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 456 "description": "This property shall specify a valid odata or Redfish property.", 457 "type": [ 458 "array", 459 "boolean", 460 "integer", 461 "number", 462 "null", 463 "object", 464 "string" 465 ] 466 } 467 }, 468 "properties": {}, 469 "type": "object" 470 }, 471 "PortConnectionType": { 472 "enum": [ 473 "NotConnected", 474 "NPort", 475 "PointToPoint", 476 "PrivateLoop", 477 "PublicLoop", 478 "Generic", 479 "ExtenderFabric" 480 ], 481 "enumDescriptions": { 482 "ExtenderFabric": "This port connection type is an extender fabric port.", 483 "Generic": "This port connection type is a generic fabric port.", 484 "NPort": "This port connects through an N-port to a switch.", 485 "NotConnected": "This port is not connected.", 486 "PointToPoint": "This port connects in a point-to-point configuration.", 487 "PrivateLoop": "This port connects in a private loop configuration.", 488 "PublicLoop": "This port connects in a public configuration." 489 }, 490 "type": "string" 491 }, 492 "SupportedEthernetCapabilities": { 493 "enum": [ 494 "WakeOnLAN", 495 "EEE" 496 ], 497 "enumDescriptions": { 498 "EEE": "IEEE 802.3az Energy-Efficient Ethernet (EEE) is supported on this port.", 499 "WakeOnLAN": "Wake on LAN (WoL) is supported on this port." 500 }, 501 "type": "string" 502 }, 503 "SupportedLinkCapabilities": { 504 "additionalProperties": false, 505 "description": "The link capabilities of an associated port.", 506 "longDescription": "This type shall describe the static capabilities of an associated port, irrespective of transient conditions such as cabling, interface module presence, or remote link partner status or configuration.", 507 "patternProperties": { 508 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 509 "description": "This property shall specify a valid odata or Redfish property.", 510 "type": [ 511 "array", 512 "boolean", 513 "integer", 514 "number", 515 "null", 516 "object", 517 "string" 518 ] 519 } 520 }, 521 "properties": { 522 "AutoSpeedNegotiation": { 523 "description": "An indication of whether the port is capable of autonegotiating speed.", 524 "longDescription": "This property shall indicate whether the port is capable of autonegotiating speed.", 525 "readonly": true, 526 "type": [ 527 "boolean", 528 "null" 529 ], 530 "versionAdded": "v1_2_0" 531 }, 532 "CapableLinkSpeedMbps": { 533 "description": "The set of link speed capabilities of this port.", 534 "items": { 535 "type": [ 536 "integer", 537 "null" 538 ] 539 }, 540 "longDescription": "This property shall contain all of the possible network link speed capabilities of this port.", 541 "readonly": true, 542 "type": "array", 543 "versionAdded": "v1_2_0" 544 }, 545 "LinkNetworkTechnology": { 546 "anyOf": [ 547 { 548 "$ref": "#/definitions/LinkNetworkTechnology" 549 }, 550 { 551 "type": "null" 552 } 553 ], 554 "description": "The link network technology capabilities of this port.", 555 "longDescription": "This property shall contain a network technology capability of this port.", 556 "readonly": true 557 }, 558 "LinkSpeedMbps": { 559 "deprecated": "This property has been deprecated in favor of the `CapableLinkSpeedMbps` property.", 560 "description": "The speed of the link in Mbit/s when this link network technology is active.", 561 "longDescription": "This property shall contain the speed of the link in megabits per second (Mbit/s) units for this port when this link network technology is active.", 562 "readonly": true, 563 "type": [ 564 "integer", 565 "null" 566 ], 567 "units": "Mbit/s", 568 "versionDeprecated": "v1_2_0" 569 } 570 }, 571 "type": "object" 572 } 573 }, 574 "language": "en", 575 "owningEntity": "DMTF", 576 "release": "2020.4", 577 "title": "#NetworkPort.v1_4_3.NetworkPort" 578}