{ "$id": "http://redfish.dmtf.org/schemas/v1/PortMetrics.v1_8_1.json", "$ref": "#/definitions/PortMetrics", "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", "copyright": "Copyright 2014-2025 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", "definitions": { "Actions": { "additionalProperties": false, "description": "The available actions for this resource.", "longDescription": "This type shall contain the available actions for this resource.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "#PortMetrics.ResetMetrics": { "$ref": "#/definitions/ResetMetrics" }, "Oem": { "$ref": "#/definitions/OemActions", "description": "The available OEM-specific actions for this resource.", "longDescription": "This property shall contain the available OEM-specific actions for this resource." } }, "type": "object" }, "CXL": { "additionalProperties": false, "description": "The port metrics specific to CXL ports.", "longDescription": "This type shall contain the port metrics specific to CXL ports.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "BackpressureAveragePercentage": { "description": "The average congestion of the port as a percentage.", "longDescription": "This property shall contain CXL Specification-defined 'Backpressure Average Percentage' as a percentage, typically `0` to `100`.", "readonly": true, "type": "integer", "units": "%", "versionAdded": "v1_4_0" } }, "type": "object" }, "FibreChannel": { "additionalProperties": false, "description": "The Fibre Channel-specific port metrics for network ports.", "longDescription": "This type shall describe Fibre Channel-specific metrics for network ports.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "CorrectableFECErrors": { "description": "The total number of correctable forward error correction (FEC) errors.", "longDescription": "This property shall contain the total number of times this port has received traffic with correctable forward error correction (FEC) errors.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_2_0" }, "InvalidCRCs": { "description": "The total number of invalid cyclic redundancy checks (CRCs).", "longDescription": "This property shall contain the total number of invalid cyclic redundancy checks (CRCs) observed on this port.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_2_0" }, "InvalidTXWords": { "description": "The total number of invalid transmission words.", "longDescription": "This property shall contain the total number of times this port has received invalid transmission words.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_2_0" }, "LinkFailures": { "description": "The total number of link failures.", "longDescription": "This property shall contain the total number of link failures observed on this port.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_2_0" }, "LossesOfSignal": { "description": "The total number of losses of signal.", "longDescription": "This property shall contain the total number of times this port has lost signal.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_2_0" }, "LossesOfSync": { "description": "The total number of losses of sync.", "longDescription": "This property shall contain the total number of times this port has lost sync.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_2_0" }, "RXBBCreditZero": { "description": "The number of times the receive buffer-to-buffer credit count transitioned to zero.", "longDescription": "This property shall contain the number of times the receive buffer-to-buffer credit count transitioned to zero since last counter reset.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_2_0" }, "RXExchanges": { "description": "The total number of Fibre Channel exchanges received.", "longDescription": "This property shall contain the total number of Fibre Channel exchanges received.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_2_0" }, "RXSequences": { "description": "The total number of Fibre Channel sequences received.", "longDescription": "This property shall contain the total number of Fibre Channel sequences received.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_2_0" }, "TXBBCreditZero": { "description": "The number of times the transmit buffer-to-buffer credit count transitioned to zero.", "longDescription": "This property shall contain the number of times the transmit buffer-to-buffer credit count transitioned to zero since last counter reset.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_2_0" }, "TXBBCreditZeroDurationMilliseconds": { "description": "The total amount of time the port has been blocked from transmitting due to lack of buffer credits.", "longDescription": "This property shall contain the total amount of time in milliseconds the port has been blocked from transmitting due to lack of buffer credits since the last counter reset.", "readonly": true, "type": [ "integer", "null" ], "units": "ms", "versionAdded": "v1_2_0" }, "TXBBCredits": { "description": "The number of transmit buffer-to-buffer credits the port is configured to use.", "longDescription": "This property shall contain the number of transmit buffer-to-buffer credits the port is configured to use.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_2_0" }, "TXExchanges": { "description": "The total number of Fibre Channel exchanges transmitted.", "longDescription": "This property shall contain the total number of Fibre Channel exchanges transmitted.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_2_0" }, "TXSequences": { "description": "The total number of Fibre Channel sequences transmitted.", "longDescription": "This property shall contain the total number of Fibre Channel sequences transmitted.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_2_0" }, "UncorrectableFECErrors": { "description": "The total number of uncorrectable forward error correction (FEC) errors.", "longDescription": "This property shall contain the total number of times this port has received traffic with uncorrectable forward error correction (FEC) errors.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_2_0" } }, "type": "object" }, "GenZ": { "additionalProperties": false, "description": "The port metrics for a Gen-Z interface.", "longDescription": "This type shall describe the Gen-Z related port metrics.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "AccessKeyViolations": { "description": "The total number of Access Key Violations detected.", "longDescription": "This property shall contain the total number of Access Key Violations detected for packets received or transmitted on this interface.", "readonly": true, "type": [ "integer", "null" ] }, "EndToEndCRCErrors": { "description": "The total number of ECRC transient errors detected.", "longDescription": "This property shall contain total number of ECRC transient errors detected in received link-local and end-to-end packets.", "readonly": true, "type": [ "integer", "null" ] }, "LLRRecovery": { "description": "The total number of times Link-Level Reliability (LLR) recovery has been initiated.", "longDescription": "This property shall contain the total number of times Link-level Reliability (LLR) recovery has been initiated by this interface. This is not to be confused with the number of packets retransmitted due to initiating LLR recovery.", "readonly": true, "type": [ "integer", "null" ] }, "LinkNTE": { "description": "The total number of link-local non-transient errors detected.", "longDescription": "This property shall contain the total number of link-local non-transient errors detected on this interface.", "readonly": true, "type": [ "integer", "null" ] }, "MarkedECN": { "description": "The number of packets with the Congestion ECN bit set.", "longDescription": "This property shall contain the number of packets that the component set the Congestion ECN bit prior to transmission through this interface.", "readonly": true, "type": [ "integer", "null" ] }, "NonCRCTransientErrors": { "description": "The total number transient errors detected that are unrelated to CRC validation.", "longDescription": "This property shall contain the total number of transient errors detected that are unrelated to CRC validation, which covers link-local and end-to-end packets, such as malformed Link Idle packets or PLA signal errors.", "readonly": true, "type": [ "integer", "null" ] }, "PacketCRCErrors": { "description": "The total number of PCRC transient errors detected.", "longDescription": "This property shall contain the total number of PCRC transient errors detected in received link-local and end-to-end packets.", "readonly": true, "type": [ "integer", "null" ] }, "PacketDeadlineDiscards": { "description": "The number of packets discarded due to the Congestion Deadline subfield reaching zero.", "longDescription": "This property shall contain the number of packets discarded by this interface due to the Congestion Deadline subfield reaching zero prior to packet transmission.", "readonly": true, "type": [ "integer", "null" ] }, "RXStompedECRC": { "description": "The total number of packets received with a stomped ECRC field.", "longDescription": "This property shall contain the total number of packets that this interface received with a stomped ECRC field.", "readonly": true, "type": [ "integer", "null" ] }, "ReceivedECN": { "description": "The number of packets received on this interface with the Congestion ECN bit set.", "longDescription": "This property shall contain the number of packets received on this interface with the Congestion ECN bit set.", "readonly": true, "type": [ "integer", "null" ] }, "TXStompedECRC": { "description": "The total number of packets that this interface stomped the ECRC field.", "longDescription": "This property shall contain the total number of packets that this interfaced stomped the ECRC field.", "readonly": true, "type": [ "integer", "null" ] } }, "type": "object" }, "Networking": { "additionalProperties": false, "description": "The port metrics for network ports, including Ethernet, Fibre Channel, and InfiniBand, that are not specific to one of these protocols.", "longDescription": "This type shall describe the metrics for network ports, including Ethernet, Fibre Channel, and InfiniBand, that are not specific to one of these protocols.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "RDMAProtectionErrors": { "description": "The total number of RDMA protection errors.", "longDescription": "This property shall contain the total number of RDMA protection errors.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "RDMAProtocolErrors": { "description": "The total number of RDMA protocol errors.", "longDescription": "This property shall contain the total number of RDMA protocol errors.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "RDMARXBytes": { "description": "The total number of RDMA bytes received on a port since reset.", "longDescription": "This property shall contain the total number of RDMA bytes received on a port since reset.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "RDMARXRequests": { "description": "The total number of RDMA requests received on a port since reset.", "longDescription": "This property shall contain the total number of RDMA requests received on a port since reset.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "RDMATXBytes": { "description": "The total number of RDMA bytes transmitted on a port since reset.", "longDescription": "This property shall contain the total number of RDMA bytes transmitted on a port since reset.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "RDMATXReadRequests": { "description": "The total number of RDMA read requests transmitted on a port since reset.", "longDescription": "This property shall contain the total number of RDMA read requests transmitted on a port since reset.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "RDMATXRequests": { "description": "The total number of RDMA requests transmitted on a port since reset.", "longDescription": "This property shall contain the total number of RDMA requests transmitted on a port since reset.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "RDMATXSendRequests": { "description": "The total number of RDMA send requests transmitted on a port since reset.", "longDescription": "This property shall contain the total number of RDMA send requests transmitted on a port since reset.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "RDMATXWriteRequests": { "description": "The total number of RDMA write requests transmitted on a port since reset.", "longDescription": "This property shall contain the total number of RDMA write requests transmitted on a port since reset.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "RXBroadcastFrames": { "description": "The total number of valid broadcast frames received on a port since reset.", "longDescription": "This property shall contain the total number of valid broadcast frames received on a port since reset, including host and remote management passthrough traffic.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "RXDiscards": { "description": "The total number of frames discarded in a port's receive path since reset.", "longDescription": "This property shall contain the total number of frames discarded in a port's receive path since reset.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "RXFCSErrors": { "description": "The total number of frames received with frame check sequence (FCS) errors on a port since reset.", "longDescription": "This property shall contain the total number of frames received with frame check sequence (FCS) errors on a port since reset.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "RXFalseCarrierErrors": { "description": "The total number of false carrier errors received from phy on a port since reset.", "longDescription": "This property shall contain the total number of false carrier errors received from phy on a port since reset.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "RXFrameAlignmentErrors": { "description": "The total number of frames received with alignment errors on a port since reset.", "longDescription": "This property shall contain the total number of frames received with alignment errors on a port since reset.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "RXFrames": { "description": "The total number of frames received on a port since reset.", "longDescription": "This property shall contain the total number of frames received on a port since reset.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "RXMulticastFrames": { "description": "The total number of valid multicast frames received on a port since reset.", "longDescription": "This property shall contain the total number of valid multicast frames received on a port since reset, including host and remote management passthrough traffic.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "RXOversizeFrames": { "description": "The total number of frames that exceed the maximum frame size.", "longDescription": "This property shall contain the total number of frames that exceed the maximum frame size.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "RXPFCFrames": { "description": "The total number of priority flow control (PFC) frames received on a port since reset.", "longDescription": "This property shall contain the total number of priority flow control (PFC) frames received on a port since reset.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "RXPauseXOFFFrames": { "description": "The total number of flow control frames from the network to pause transmission.", "longDescription": "This property shall contain the total number of flow control frames from the network to pause transmission.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "RXPauseXONFrames": { "description": "The total number of flow control frames from the network to resume transmission.", "longDescription": "This property shall contain the total number of flow control frames from the network to resume transmission.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "RXUndersizeFrames": { "description": "The total number of frames that are smaller than the minimum frame size of 64 bytes.", "longDescription": "This property shall contain the total number of frames that are smaller than the minimum frame size of 64 bytes.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "RXUnicastFrames": { "description": "The total number of valid unicast frames received on a port since reset.", "longDescription": "This property shall contain the total number of valid unicast frames received on a port since reset.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "TXBroadcastFrames": { "description": "The total number of good broadcast frames transmitted on a port since reset.", "longDescription": "This property shall contain the total number of good broadcast frames transmitted on a port since reset, including host and remote management passthrough traffic.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "TXDiscards": { "description": "The total number of frames discarded in a port's transmit path since reset.", "longDescription": "This property shall contain the total number of frames discarded in a port's transmit path since reset.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "TXExcessiveCollisions": { "description": "The number of times a single transmitted frame encountered more than 15 collisions.", "longDescription": "This property shall contain the number of times a single transmitted frame encountered more than 15 collisions.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "TXFrames": { "description": "The total number of frames transmitted on a port since reset.", "longDescription": "This property shall contain the total number of frames transmitted on a port since reset.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "TXLateCollisions": { "description": "The total number of collisions that occurred after one slot time as defined by IEEE 802.3.", "longDescription": "This property shall contain the total number of collisions that occurred after one slot time as defined by IEEE 802.3.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "TXMulticastFrames": { "description": "The total number of good multicast frames transmitted on a port since reset.", "longDescription": "This property shall contain the total number of good multicast frames transmitted on a port since reset, including host and remote management passthrough traffic.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "TXMultipleCollisions": { "description": "The times that a transmitted frame encountered 2-15 collisions.", "longDescription": "This property shall contain the times that a transmitted frame encountered 2-15 collisions.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "TXPFCFrames": { "description": "The total number of priority flow control (PFC) frames sent on a port since reset.", "longDescription": "This property shall contain the total number of priority flow control (PFC) frames sent on a port since reset.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "TXPauseXOFFFrames": { "description": "The total number of XOFF frames transmitted to the network.", "longDescription": "This property shall contain the total number of XOFF frames transmitted to the network.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "TXPauseXONFrames": { "description": "The total number of XON frames transmitted to the network.", "longDescription": "This property shall contain the total number of XON frames transmitted to the network.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "TXSingleCollisions": { "description": "The times that a successfully transmitted frame encountered a single collision.", "longDescription": "This property shall contain the times that a successfully transmitted frame encountered a single collision.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "TXUnicastFrames": { "description": "The total number of good unicast frames transmitted on a port since reset.", "longDescription": "This property shall contain the total number of good unicast frames transmitted on a port since reset, including host and remote management passthrough traffic.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" } }, "type": "object" }, "OemActions": { "additionalProperties": true, "description": "The available OEM-specific actions for this resource.", "longDescription": "This type shall contain the available OEM-specific actions for this resource.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": {}, "type": "object" }, "PortMetrics": { "additionalProperties": false, "description": "The `PortMetrics` schema contains usage and health statistics for a switch device or component port summary.", "longDescription": "This resource shall represent the port metrics for a switch device or component port summary in a Redfish implementation.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "@odata.context": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "@odata.type": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" }, "Actions": { "$ref": "#/definitions/Actions", "description": "The available actions for this resource.", "longDescription": "This property shall contain the available actions for this resource." }, "CXL": { "$ref": "#/definitions/CXL", "description": "The port metrics specific to CXL ports.", "longDescription": "This property shall contain the port metrics specific to CXL ports.", "versionAdded": "v1_4_0" }, "Description": { "anyOf": [ { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" }, { "type": "null" } ], "readonly": true }, "FibreChannel": { "$ref": "#/definitions/FibreChannel", "description": "The Fibre Channel-specific port metrics for network ports.", "longDescription": "This property shall contain Fibre Channel-specific port metrics for network ports.", "versionAdded": "v1_2_0" }, "GenZ": { "$ref": "#/definitions/GenZ", "description": "The port metrics specific to Gen-Z ports.", "longDescription": "This property shall contain the port metrics specific to Gen-Z ports." }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", "readonly": true }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", "readonly": true }, "Networking": { "$ref": "#/definitions/Networking", "description": "The port metrics for network ports, including Ethernet, Fibre Channel, and InfiniBand, that are not specific to one of these protocols.", "longDescription": "This property shall contain port metrics for network ports, including Ethernet, Fibre Channel, and InfiniBand, that are not specific to one of these protocols.", "versionAdded": "v1_1_0" }, "Oem": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", "description": "The OEM extension property.", "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." }, "PCIeErrors": { "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeErrors", "description": "The PCIe errors associated with this port.", "longDescription": "This property shall contain the PCIe errors associated with this port.", "versionAdded": "v1_3_0" }, "PCIeMetrics": { "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeMetrics", "description": "The PCIe metrics associated with this port.", "longDescription": "This property shall contain the PCIe metrics associated with this port.", "versionAdded": "v1_8_0" }, "RXBytes": { "description": "The total number of bytes received on a port since reset.", "longDescription": "This property shall contain the total number of bytes received on a port since reset, including host and remote management passthrough traffic, and inclusive of all protocol overhead.", "readonly": true, "type": [ "integer", "null" ], "units": "By", "versionAdded": "v1_1_0" }, "RXErrors": { "description": "The total number of received errors on a port since reset.", "longDescription": "This property shall contain the total number of received errors on a port since reset.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "SAS": { "description": "The physical (phy) metrics for Serial Attached SCSI (SAS). Each member represents a single phy.", "items": { "$ref": "#/definitions/SAS" }, "longDescription": "This property shall contain an array of physical-related metrics for Serial Attached SCSI (SAS). Each member in the array shall represent a single phy.", "type": "array", "versionAdded": "v1_1_0" }, "TXBytes": { "description": "The total number of bytes transmitted on a port since reset.", "longDescription": "This property shall contain the total number of bytes transmitted on a port since reset, including host and remote management passthrough traffic, and inclusive of all protocol overhead.", "readonly": true, "type": [ "integer", "null" ], "units": "By", "versionAdded": "v1_1_0" }, "TXErrors": { "description": "The total number of transmission errors on a port since reset.", "longDescription": "This property shall contain the total number of transmission errors on a port since reset.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "Transceivers": { "description": "The metrics for the transceivers in this port. Each member represents a single transceiver.", "items": { "$ref": "#/definitions/Transceiver" }, "longDescription": "This property shall contain an array of transceiver-related metrics for this port. Each member in the array shall represent a single transceiver.", "type": "array", "versionAdded": "v1_1_0" } }, "required": [ "@odata.id", "@odata.type", "Id", "Name" ], "type": "object" }, "ResetMetrics": { "additionalProperties": false, "description": "This action resets the summary metrics related to this device.", "longDescription": "This action shall reset any time intervals or counted values for this device.", "parameters": {}, "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "target": { "description": "Link to invoke action", "format": "uri-reference", "type": "string" }, "title": { "description": "Friendly action name", "type": "string" } }, "type": "object", "versionAdded": "v1_6_0" }, "SAS": { "additionalProperties": false, "description": "The physical metrics for Serial Attached SCSI (SAS).", "longDescription": "This type shall describe physical (phy) related metrics for Serial Attached SCSI (SAS).", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "InvalidDwordCount": { "description": "The number of invalid dwords that have been received by the phy outside of phy reset sequences.", "longDescription": "This property shall contain the number of invalid dwords that have been received by the phy outside of phy reset sequences.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "LossOfDwordSynchronizationCount": { "description": "The number of times the phy has restarted the link reset sequence because it lost dword synchronization.", "longDescription": "This property shall contain the number of times the phy has restarted the link reset sequence because it lost dword synchronization.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" }, "PhyResetProblemCount": { "description": "The number of times a phy reset problem has occurred.", "longDescription": "This property shall contain the number of times a phy reset problem has occurred.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_5_0" }, "RunningDisparityErrorCount": { "description": "The number of dwords containing running disparity errors that have been received by the phy outside of phy reset sequences.", "longDescription": "This property shall contain the number of dwords containing running disparity errors that have been received by the phy outside of phy reset sequences.", "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_1_0" } }, "type": "object" }, "Transceiver": { "additionalProperties": false, "description": "The transceiver metrics.", "longDescription": "This type shall describe the transceiver-related metrics.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "ByLane": { "description": "The metrics for the lanes in this port that are part of this transceiver. Each member represents a single lane.", "items": { "$ref": "#/definitions/TransceiverLaneMetrics" }, "longDescription": "This property shall contain an array of lane-related metrics for a transceiver in this port. Each member in the array shall represent a single lane.", "type": "array", "versionAdded": "v1_8_0" }, "RXInputPowerMilliWatts": { "description": "The RX input power value of the transceiver, aggregated across all lanes of this port.", "longDescription": "This property shall contain the RX input power value of the transceiver, aggregated across all lanes of this port.", "minimum": 0, "readonly": true, "type": [ "number", "null" ], "units": "mW", "versionAdded": "v1_1_0" }, "SupplyVoltage": { "description": "The supply voltage for the transceiver.", "longDescription": "This property shall contain the supply voltage for the transceiver.", "readonly": true, "type": [ "number", "null" ], "units": "V", "versionAdded": "v1_1_0" }, "TXBiasCurrentMilliAmps": { "description": "The TX bias current value of the transceiver, aggregated across all lanes of this port.", "longDescription": "This property shall contain the TX bias current value of the transceiver, aggregated across all lanes of this port.", "minimum": 0, "readonly": true, "type": [ "number", "null" ], "units": "mA", "versionAdded": "v1_1_0" }, "TXOutputPowerMilliWatts": { "description": "The TX output power value of the transceiver, aggregated across all lanes of this port.", "longDescription": "This property shall contain the TX output power value of the transceiver, aggregated across all lanes of this port.", "minimum": 0, "readonly": true, "type": [ "number", "null" ], "units": "mW", "versionAdded": "v1_1_0" }, "WavelengthNanometers": { "description": "The laser wavelength, in nanometers, for the transceiver.", "longDescription": "This property shall contain the laser wavelength, in nanometers, for the transceiver. This property shall not be present for non-optic transceiver mediums.", "readonly": true, "type": [ "string", "null" ], "units": "nm", "versionAdded": "v1_7_0" } }, "type": "object" }, "TransceiverLaneMetrics": { "additionalProperties": false, "description": "The per-lane transceiver metrics.", "longDescription": "This type shall describe transceiver-related metrics on a per-lane basis.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "LaneId": { "description": "The transceiver lane for which metrics are being supplied.", "longDescription": "This property shall contain the transceiver lane for which metrics are being supplied.", "minimum": 0, "readonly": true, "type": [ "integer", "null" ], "versionAdded": "v1_8_0" }, "RXInputPowerMilliWatts": { "description": "The RX input power value of the transceiver for the lane identified as `LaneId`.", "longDescription": "This property shall contain the RX input power value of the transceiver for the lane identified as `LaneId`.", "minimum": 0, "readonly": true, "type": [ "number", "null" ], "units": "mW", "versionAdded": "v1_8_0" }, "TXBiasCurrentMilliAmps": { "description": "The TX bias current value of the transceiver for the lane identified as `LaneId`.", "longDescription": "This property shall contain the TX bias current value of the transceiver for the lane identified as `LaneId`.", "minimum": 0, "readonly": true, "type": [ "number", "null" ], "units": "mA", "versionAdded": "v1_8_0" }, "TXOutputPowerMilliWatts": { "description": "The TX output power value of the transceiver for the lane identified as `LaneId`.", "longDescription": "This property shall contain the TX output power value of the transceiver for the lane identified as `LaneId`.", "minimum": 0, "readonly": true, "type": [ "number", "null" ], "units": "mW", "versionAdded": "v1_8_0" } }, "type": "object" } }, "language": "en", "owningEntity": "DMTF", "release": "2025.3", "title": "#PortMetrics.v1_8_1.PortMetrics" }