1{ 2 "$id": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunctionMetrics.v1_2_0.json", 3 "$ref": "#/definitions/NetworkDeviceFunctionMetrics", 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 "#NetworkDeviceFunctionMetrics.ResetMetrics": { 27 "$ref": "#/definitions/ResetMetrics" 28 }, 29 "Oem": { 30 "$ref": "#/definitions/OemActions", 31 "description": "The available OEM-specific actions for this resource.", 32 "longDescription": "This property shall contain the available OEM-specific actions for this resource." 33 } 34 }, 35 "type": "object" 36 }, 37 "Ethernet": { 38 "additionalProperties": false, 39 "description": "The network function metrics for an Ethernet interface.", 40 "longDescription": "This type shall describe the Ethernet-related network function metrics.", 41 "patternProperties": { 42 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 43 "description": "This property shall specify a valid odata or Redfish property.", 44 "type": [ 45 "array", 46 "boolean", 47 "integer", 48 "number", 49 "null", 50 "object", 51 "string" 52 ] 53 } 54 }, 55 "properties": { 56 "NumOffloadedIPv4Conns": { 57 "description": "The total number of offloaded TCP/IPv4 connections.", 58 "longDescription": "This property shall contain the total number of offloaded TCP/IPv4 connections.", 59 "readonly": true, 60 "type": [ 61 "integer", 62 "null" 63 ] 64 }, 65 "NumOffloadedIPv6Conns": { 66 "description": "The total number of offloaded TCP/IPv6 connections.", 67 "longDescription": "This property shall contain the total number of offloaded TCP/IPv6 connections.", 68 "readonly": true, 69 "type": [ 70 "integer", 71 "null" 72 ] 73 } 74 }, 75 "type": "object" 76 }, 77 "FibreChannel": { 78 "additionalProperties": false, 79 "description": "The network function metrics for a Fibre Channel interface.", 80 "longDescription": "This type shall describe the Fibre Channel-related network function metrics.", 81 "patternProperties": { 82 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 83 "description": "This property shall specify a valid odata or Redfish property.", 84 "type": [ 85 "array", 86 "boolean", 87 "integer", 88 "number", 89 "null", 90 "object", 91 "string" 92 ] 93 } 94 }, 95 "properties": { 96 "PortLoginAccepts": { 97 "description": "The total number of port login (PLOGI) accept (ACC) responses.", 98 "longDescription": "This property shall contain the total number of PLOGI ACC responses received by this Fibre Channel function.", 99 "readonly": true, 100 "type": [ 101 "integer", 102 "null" 103 ], 104 "versionAdded": "v1_1_0" 105 }, 106 "PortLoginRejects": { 107 "description": "The total number of port login (PLOGI) reject (RJT) responses.", 108 "longDescription": "This property shall contain the total number of PLOGI RJT responses received by this Fibre Channel function.", 109 "readonly": true, 110 "type": [ 111 "integer", 112 "null" 113 ], 114 "versionAdded": "v1_1_0" 115 }, 116 "PortLoginRequests": { 117 "description": "The total number of port login (PLOGI) requests transmitted.", 118 "longDescription": "This property shall contain the total number of PLOGI requests sent by this function.", 119 "readonly": true, 120 "type": [ 121 "integer", 122 "null" 123 ], 124 "versionAdded": "v1_1_0" 125 }, 126 "RXCongestionFPINs": { 127 "description": "The total number of Congestion Fabric Performance Impact Notifications (FPINs) received.", 128 "longDescription": "This property shall contain the total number of Congestion FPINs received by this Fibre Channel function.", 129 "readonly": true, 130 "type": [ 131 "integer", 132 "null" 133 ], 134 "versionAdded": "v1_1_0" 135 }, 136 "RXDeliveryFPINs": { 137 "description": "The total number of Delivery Fabric Performance Impact Notifications (FPINs) received.", 138 "longDescription": "This property shall contain the total number of Delivery FPINs received by this Fibre Channel function.", 139 "readonly": true, 140 "type": [ 141 "integer", 142 "null" 143 ], 144 "versionAdded": "v1_1_0" 145 }, 146 "RXExchanges": { 147 "description": "The total number of Fibre Channel exchanges received.", 148 "longDescription": "This property shall contain the total number of Fibre Channel exchanges received.", 149 "readonly": true, 150 "type": [ 151 "integer", 152 "null" 153 ], 154 "versionAdded": "v1_1_0" 155 }, 156 "RXLinkIntegrityFPINs": { 157 "description": "The total number of Link Integrity Fabric Performance Impact Notifications (FPINs) received.", 158 "longDescription": "This property shall contain the total number of Link Integrity FPINs received by this Fibre Channel function.", 159 "readonly": true, 160 "type": [ 161 "integer", 162 "null" 163 ], 164 "versionAdded": "v1_1_0" 165 }, 166 "RXPeerCongestionFPINs": { 167 "description": "The total number of Peer Congestion Fabric Performance Impact Notifications (FPINs) received.", 168 "longDescription": "This property shall contain the total number of Peer Congestion FPINs received by this Fibre Channel function.", 169 "readonly": true, 170 "type": [ 171 "integer", 172 "null" 173 ], 174 "versionAdded": "v1_1_0" 175 }, 176 "RXSequences": { 177 "description": "The total number of Fibre Channel sequences received.", 178 "longDescription": "This property shall contain the total number of Fibre Channel sequences received.", 179 "readonly": true, 180 "type": [ 181 "integer", 182 "null" 183 ], 184 "versionAdded": "v1_1_0" 185 }, 186 "TXCongestionFPINs": { 187 "description": "The total number of Congestion Fabric Performance Impact Notifications (FPINs) sent.", 188 "longDescription": "This property shall contain the total number of Congestion FPINs sent by this Fibre Channel function.", 189 "readonly": true, 190 "type": [ 191 "integer", 192 "null" 193 ], 194 "versionAdded": "v1_1_0" 195 }, 196 "TXDeliveryFPINs": { 197 "description": "The total number of Delivery Fabric Performance Impact Notifications (FPINs) sent.", 198 "longDescription": "This property shall contain the total number of Delivery FPINs sent by this Fibre Channel function.", 199 "readonly": true, 200 "type": [ 201 "integer", 202 "null" 203 ], 204 "versionAdded": "v1_1_0" 205 }, 206 "TXExchanges": { 207 "description": "The total number of Fibre Channel exchanges transmitted.", 208 "longDescription": "This property shall contain the total number of Fibre Channel exchanges transmitted.", 209 "readonly": true, 210 "type": [ 211 "integer", 212 "null" 213 ], 214 "versionAdded": "v1_1_0" 215 }, 216 "TXLinkIntegrityFPINs": { 217 "description": "The total number of Link Integrity Fabric Performance Impact Notifications (FPINs) sent.", 218 "longDescription": "This property shall contain the total number of Link Integrity FPINs sent by this Fibre Channel function.", 219 "readonly": true, 220 "type": [ 221 "integer", 222 "null" 223 ], 224 "versionAdded": "v1_1_0" 225 }, 226 "TXPeerCongestionFPINs": { 227 "description": "The total number of Peer Congestion Fabric Performance Impact Notifications (FPINs) sent.", 228 "longDescription": "This property shall contain the total number of Peer Congestion FPINs sent by this Fibre Channel function.", 229 "readonly": true, 230 "type": [ 231 "integer", 232 "null" 233 ], 234 "versionAdded": "v1_1_0" 235 }, 236 "TXSequences": { 237 "description": "The total number of Fibre Channel sequences transmitted.", 238 "longDescription": "This property shall contain the total number of Fibre Channel sequences transmitted.", 239 "readonly": true, 240 "type": [ 241 "integer", 242 "null" 243 ], 244 "versionAdded": "v1_1_0" 245 } 246 }, 247 "type": "object" 248 }, 249 "NetworkDeviceFunctionMetrics": { 250 "additionalProperties": false, 251 "description": "The `NetworkDeviceFunctionMetrics` schema contains usage and health statistics for a network function of a network adapter.", 252 "longDescription": "This resource shall represent the network metrics for a single network function of a network adapter in a Redfish implementation.", 253 "patternProperties": { 254 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 255 "description": "This property shall specify a valid odata or Redfish property.", 256 "type": [ 257 "array", 258 "boolean", 259 "integer", 260 "number", 261 "null", 262 "object", 263 "string" 264 ] 265 } 266 }, 267 "properties": { 268 "@odata.context": { 269 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" 270 }, 271 "@odata.etag": { 272 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" 273 }, 274 "@odata.id": { 275 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" 276 }, 277 "@odata.type": { 278 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" 279 }, 280 "Actions": { 281 "$ref": "#/definitions/Actions", 282 "description": "The available actions for this resource.", 283 "longDescription": "This property shall contain the available actions for this resource." 284 }, 285 "Description": { 286 "anyOf": [ 287 { 288 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" 289 }, 290 { 291 "type": "null" 292 } 293 ], 294 "readonly": true 295 }, 296 "Ethernet": { 297 "$ref": "#/definitions/Ethernet", 298 "description": "The network function metrics specific to Ethernet adapters.", 299 "longDescription": "This property shall contain network function metrics specific to Ethernet adapters." 300 }, 301 "FibreChannel": { 302 "$ref": "#/definitions/FibreChannel", 303 "description": "The network function metrics specific to Fibre Channel adapters.", 304 "longDescription": "This property shall contain network function metrics specific to Fibre Channel adapters.", 305 "versionAdded": "v1_1_0" 306 }, 307 "Id": { 308 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", 309 "readonly": true 310 }, 311 "Name": { 312 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", 313 "readonly": true 314 }, 315 "Oem": { 316 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 317 "description": "The OEM extension property.", 318 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." 319 }, 320 "RXAvgQueueDepthPercent": { 321 "description": "The average RX queue depth as the percentage.", 322 "longDescription": "This property shall contain the average RX queue depth as a percentage, typically `0` to `100`.", 323 "minimum": 0, 324 "readonly": true, 325 "type": [ 326 "number", 327 "null" 328 ], 329 "units": "%" 330 }, 331 "RXBytes": { 332 "description": "The total number of bytes received on a network function.", 333 "longDescription": "This property shall contain the total number of bytes received on a network function, inclusive of all protocol overhead.", 334 "readonly": true, 335 "type": [ 336 "integer", 337 "null" 338 ], 339 "units": "By" 340 }, 341 "RXFrames": { 342 "description": "The total number of frames received on a network function.", 343 "longDescription": "This property shall contain the total number of frames received on a network function.", 344 "readonly": true, 345 "type": [ 346 "integer", 347 "null" 348 ] 349 }, 350 "RXMulticastFrames": { 351 "description": "The total number of good multicast frames received on a network function since reset.", 352 "longDescription": "This property shall contain the total number of good multicast frames received on a network function since reset, including host and remote management passthrough traffic.", 353 "readonly": true, 354 "type": [ 355 "integer", 356 "null" 357 ] 358 }, 359 "RXQueuesEmpty": { 360 "description": "Whether nothing is in a network function's RX queues to DMA.", 361 "longDescription": "This property shall indicate whether nothing is in a network function's RX queues to DMA.", 362 "readonly": true, 363 "type": [ 364 "boolean", 365 "null" 366 ] 367 }, 368 "RXQueuesFull": { 369 "description": "The number of RX queues that are full.", 370 "longDescription": "This property shall contain the number of RX queues that are full.", 371 "readonly": true, 372 "type": [ 373 "integer", 374 "null" 375 ] 376 }, 377 "RXUnicastFrames": { 378 "description": "The total number of good unicast frames received on a network function since reset.", 379 "longDescription": "This property shall contain the total number of good unicast frames received on a network function since reset.", 380 "readonly": true, 381 "type": [ 382 "integer", 383 "null" 384 ] 385 }, 386 "TXAvgQueueDepthPercent": { 387 "description": "The average TX queue depth as the percentage.", 388 "longDescription": "This property shall contain the average TX queue depth as a percentage, typically `0` to `100`.", 389 "minimum": 0, 390 "readonly": true, 391 "type": [ 392 "number", 393 "null" 394 ], 395 "units": "%" 396 }, 397 "TXBytes": { 398 "description": "The total number of bytes sent on a network function.", 399 "longDescription": "This property shall contain the total number of bytes sent on a network function, inclusive of all protocol overhead.", 400 "readonly": true, 401 "type": [ 402 "integer", 403 "null" 404 ], 405 "units": "By" 406 }, 407 "TXFrames": { 408 "description": "The total number of frames sent on a network function.", 409 "longDescription": "This property shall contain the total number of frames sent on a network function.", 410 "readonly": true, 411 "type": [ 412 "integer", 413 "null" 414 ] 415 }, 416 "TXMulticastFrames": { 417 "description": "The total number of good multicast frames transmitted on a network function since reset.", 418 "longDescription": "This property shall contain the total number of good multicast frames transmitted on a network function since reset, including host and remote management passthrough traffic.", 419 "readonly": true, 420 "type": [ 421 "integer", 422 "null" 423 ] 424 }, 425 "TXQueuesEmpty": { 426 "description": "Whether all TX queues for a network function are empty.", 427 "longDescription": "This property shall indicate whether all TX queues for a network function are empty.", 428 "readonly": true, 429 "type": [ 430 "boolean", 431 "null" 432 ] 433 }, 434 "TXQueuesFull": { 435 "description": "The number of TX queues that are full.", 436 "longDescription": "This property shall contain the number of TX queues that are full.", 437 "readonly": true, 438 "type": [ 439 "integer", 440 "null" 441 ] 442 }, 443 "TXUnicastFrames": { 444 "description": "The total number of good unicast frames transmitted on a network function since reset.", 445 "longDescription": "This property shall contain the total number of good unicast frames transmitted on a network function since reset, including host and remote management passthrough traffic.", 446 "readonly": true, 447 "type": [ 448 "integer", 449 "null" 450 ] 451 } 452 }, 453 "required": [ 454 "@odata.id", 455 "@odata.type", 456 "Id", 457 "Name" 458 ], 459 "type": "object" 460 }, 461 "OemActions": { 462 "additionalProperties": true, 463 "description": "The available OEM-specific actions for this resource.", 464 "longDescription": "This type shall contain the available OEM-specific actions for this resource.", 465 "patternProperties": { 466 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 467 "description": "This property shall specify a valid odata or Redfish property.", 468 "type": [ 469 "array", 470 "boolean", 471 "integer", 472 "number", 473 "null", 474 "object", 475 "string" 476 ] 477 } 478 }, 479 "properties": {}, 480 "type": "object" 481 }, 482 "ResetMetrics": { 483 "additionalProperties": false, 484 "description": "This action resets the summary metrics related to this device.", 485 "longDescription": "This action shall reset any time intervals or counted values for this device.", 486 "parameters": {}, 487 "patternProperties": { 488 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 489 "description": "This property shall specify a valid odata or Redfish property.", 490 "type": [ 491 "array", 492 "boolean", 493 "integer", 494 "number", 495 "null", 496 "object", 497 "string" 498 ] 499 } 500 }, 501 "properties": { 502 "target": { 503 "description": "Link to invoke action", 504 "format": "uri-reference", 505 "type": "string" 506 }, 507 "title": { 508 "description": "Friendly action name", 509 "type": "string" 510 } 511 }, 512 "type": "object", 513 "versionAdded": "v1_2_0" 514 } 515 }, 516 "language": "en", 517 "owningEntity": "DMTF", 518 "release": "2024.1", 519 "title": "#NetworkDeviceFunctionMetrics.v1_2_0.NetworkDeviceFunctionMetrics" 520}