components:
  schemas:
    PortMetrics_v1_1_4_Actions:
      additionalProperties: false
      description: The available actions for this resource.
      properties:
        Oem:
          $ref: '#/components/schemas/PortMetrics_v1_1_4_OemActions'
          description: The available OEM-specific actions for this resource.
          x-longDescription: This property shall contain the available OEM-specific
            actions for this resource.
      type: object
      x-longDescription: This type shall contain the available actions for this resource.
      x-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.
    PortMetrics_v1_1_4_GenZ:
      additionalProperties: false
      description: The port metrics for a Gen-Z interface.
      properties:
        AccessKeyViolations:
          description: The total number of Access Key Violations detected.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of Access
            Key Violations detected for packets received or transmitted on this interface.
        EndToEndCRCErrors:
          description: The total number of ECRC transient errors detected.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain total number of ECRC transient
            errors detected in received link-local and end-to-end packets.
        LLRRecovery:
          description: The total number of times Link-Level Reliability (LLR) recovery
            has been initiated.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-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.
        LinkNTE:
          description: The total number of link-local non-transient errors detected.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of link-local
            non-transient errors detected on this interface.
        MarkedECN:
          description: The number of packets with the Congestion ECN bit set.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the number of packets that
            the component set the Congestion ECN bit prior to transmission through
            this interface.
        NonCRCTransientErrors:
          description: The total number transient errors detected that are unrelated
            to CRC validation.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-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.
        PacketCRCErrors:
          description: The total number of PCRC transient errors detected.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of PCRC
            transient errors detected in received link-local and end-to-end packets.
        PacketDeadlineDiscards:
          description: The number of packets discarded due to the Congestion Deadline
            subfield reaching zero.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-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.
        RXStompedECRC:
          description: The total number of packets received with a stomped ECRC field.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of packets
            that this interface received with a stomped ECRC field.
        ReceivedECN:
          description: The number of packets received on this interface with the Congestion
            ECN bit set.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the number of packets received
            on this interface with the Congestion ECN bit set.
        TXStompedECRC:
          description: The total number of packets that this interface stomped the
            ECRC field.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of packets
            that this interfaced stomped the ECRC field.
      type: object
      x-longDescription: This type shall describe the Gen-Z related port metrics.
      x-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.
    PortMetrics_v1_1_4_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.
      properties:
        RDMAProtectionErrors:
          description: The total number of RDMA protection errors.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of RDMA
            protection errors.
          x-versionAdded: v1_1_0
        RDMAProtocolErrors:
          description: The total number of RDMA protocol errors.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of RDMA
            protocol errors.
          x-versionAdded: v1_1_0
        RDMARXBytes:
          description: The total number of RDMA bytes received on a port since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of RDMA
            bytes received on a port since reset.
          x-versionAdded: v1_1_0
        RDMARXRequests:
          description: The total number of RDMA requests received on a port since
            reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of RDMA
            requests received on a port since reset.
          x-versionAdded: v1_1_0
        RDMATXBytes:
          description: The total number of RDMA bytes transmitted on a port since
            reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of RDMA
            bytes transmitted on a port since reset.
          x-versionAdded: v1_1_0
        RDMATXReadRequests:
          description: The total number of RDMA read requests transmitted on a port
            since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of RDMA
            read requests transmitted on a port since reset.
          x-versionAdded: v1_1_0
        RDMATXRequests:
          description: The total number of RDMA requests transmitted on a port since
            reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of RDMA
            requests transmitted on a port since reset.
          x-versionAdded: v1_1_0
        RDMATXSendRequests:
          description: The total number of RDMA send requests transmitted on a port
            since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of RDMA
            send requests transmitted on a port since reset.
          x-versionAdded: v1_1_0
        RDMATXWriteRequests:
          description: The total number of RDMA write requests transmitted on a port
            since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of RDMA
            write requests transmitted on a port since reset.
          x-versionAdded: v1_1_0
        RXBroadcastFrames:
          description: The total number of valid broadcast frames received on a port
            since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-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.
          x-versionAdded: v1_1_0
        RXDiscards:
          description: The total number of frames discarded in a port's receive path
            since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of frames
            discarded in a port's receive path since reset.
          x-versionAdded: v1_1_0
        RXFCSErrors:
          description: The total number of frames received with frame check sequence
            (FCS) errors on a port since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of frames
            received with frame check sequence (FCS) errors on a port since reset.
          x-versionAdded: v1_1_0
        RXFalseCarrierErrors:
          description: The total number of false carrier errors received from phy
            on a port since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of false
            carrier errors received from phy on a port since reset.
          x-versionAdded: v1_1_0
        RXFrameAlignmentErrors:
          description: The total number of frames received with alignment errors on
            a port since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of frames
            received with alignment errors on a port since reset.
          x-versionAdded: v1_1_0
        RXFrames:
          description: The total number of frames received on a port since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of frames
            received on a port since reset.
          x-versionAdded: v1_1_0
        RXMulticastFrames:
          description: The total number of valid multicast frames received on a port
            since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-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.
          x-versionAdded: v1_1_0
        RXOversizeFrames:
          description: The total number of frames that exceed the maximum frame size.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of frames
            that exceed the maximum frame size.
          x-versionAdded: v1_1_0
        RXPFCFrames:
          description: The total number of priority flow control (PFC) frames received
            on a port since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of priority
            flow control (PFC) frames received on a port since reset.
          x-versionAdded: v1_1_0
        RXPauseXOFFFrames:
          description: The total number of flow control frames from the network to
            pause transmission.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of flow
            control frames from the network to pause transmission.
          x-versionAdded: v1_1_0
        RXPauseXONFrames:
          description: The total number of flow control frames from the network to
            resume transmission.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of flow
            control frames from the network to resume transmission.
          x-versionAdded: v1_1_0
        RXUndersizeFrames:
          description: The total number of frames that are smaller than the minimum
            frame size of 64 bytes.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of frames
            that are smaller than the minimum frame size of 64 bytes.
          x-versionAdded: v1_1_0
        RXUnicastFrames:
          description: The total number of valid unicast frames received on a port
            since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of valid
            unicast frames received on a port since reset.
          x-versionAdded: v1_1_0
        TXBroadcastFrames:
          description: The total number of good broadcast frames transmitted on a
            port since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-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.
          x-versionAdded: v1_1_0
        TXDiscards:
          description: The total number of frames discarded in a port's transmit path
            since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of frames
            discarded in a port's transmit path since reset.
          x-versionAdded: v1_1_0
        TXExcessiveCollisions:
          description: The number of times a single transmitted frame encountered
            more than 15 collisions.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the number of times a single
            transmitted frame encountered more than 15 collisions.
          x-versionAdded: v1_1_0
        TXFrames:
          description: The total number of frames transmitted on a port since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of frames
            transmitted on a port since reset.
          x-versionAdded: v1_1_0
        TXLateCollisions:
          description: The total number of collisions that occurred after one slot
            time as defined by IEEE 802.3.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of collisions
            that occurred after one slot time as defined by IEEE 802.3.
          x-versionAdded: v1_1_0
        TXMulticastFrames:
          description: The total number of good multicast frames transmitted on a
            port since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-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.
          x-versionAdded: v1_1_0
        TXMultipleCollisions:
          description: The times that a transmitted frame encountered 2-15 collisions.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the times that a transmitted
            frame encountered 2-15 collisions.
          x-versionAdded: v1_1_0
        TXPFCFrames:
          description: The total number of priority flow control (PFC) frames sent
            on a port since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of priority
            flow control (PFC) frames sent on a port since reset.
          x-versionAdded: v1_1_0
        TXPauseXOFFFrames:
          description: The total number of XOFF frames transmitted to the network.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of XOFF
            frames transmitted to the network.
          x-versionAdded: v1_1_0
        TXPauseXONFrames:
          description: The total number of XON frames transmitted to the network.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of XON frames
            transmitted to the network.
          x-versionAdded: v1_1_0
        TXSingleCollisions:
          description: The times that a successfully transmitted frame encountered
            a single collision.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the times that a successfully
            transmitted frame encountered a single collision.
          x-versionAdded: v1_1_0
        TXUnicastFrames:
          description: The total number of good unicast frames transmitted on a port
            since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-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.
          x-versionAdded: v1_1_0
      type: object
      x-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.
      x-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.
    PortMetrics_v1_1_4_OemActions:
      additionalProperties: true
      description: The available OEM-specific actions for this resource.
      properties: {}
      type: object
      x-longDescription: This type shall contain the available OEM-specific actions
        for this resource.
      x-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.
    PortMetrics_v1_1_4_PortMetrics:
      additionalProperties: false
      description: The `PortMetrics` schema contains usage and health statistics for
        a switch device or component port summary.
      properties:
        '@odata.context':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_context
        '@odata.etag':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_etag
        '@odata.id':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_id
        '@odata.type':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_type
        Actions:
          $ref: '#/components/schemas/PortMetrics_v1_1_4_Actions'
          description: The available actions for this resource.
          x-longDescription: This property shall contain the available actions for
            this resource.
        Description:
          oneOf:
          - $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Description
          - enum:
            - null
          readOnly: true
        GenZ:
          $ref: '#/components/schemas/PortMetrics_v1_1_4_GenZ'
          description: The port metrics specific to Gen-Z ports.
          x-longDescription: This property shall contain the port metrics specific
            to Gen-Z ports.
        Id:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Id
          readOnly: true
        Name:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Name
          readOnly: true
        Networking:
          $ref: '#/components/schemas/PortMetrics_v1_1_4_Networking'
          description: The port metrics for network ports, including Ethernet, Fibre
            Channel, and InfiniBand, that are not specific to one of these protocols.
          x-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.
          x-versionAdded: v1_1_0
        Oem:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Oem
          description: The OEM extension property.
          x-longDescription: This property shall contain the OEM extensions.  All
            values for properties that this object contains shall conform to the Redfish
            Specification-described requirements.
        RXBytes:
          description: The total number of bytes received on a port since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-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.
          x-units: By
          x-versionAdded: v1_1_0
        RXErrors:
          description: The total number of received errors on a port since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of received
            errors on a port since reset.
          x-versionAdded: v1_1_0
        SAS:
          description: The physical (phy) metrics for Serial Attached SCSI (SAS).  Each
            member represents a single phy.
          items:
            $ref: '#/components/schemas/PortMetrics_v1_1_4_SAS'
          type: array
          x-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.
          x-versionAdded: v1_1_0
        TXBytes:
          description: The total number of bytes transmitted on a port since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-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.
          x-units: By
          x-versionAdded: v1_1_0
        TXErrors:
          description: The total number of transmission errors on a port since reset.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the total number of transmission
            errors on a port since reset.
          x-versionAdded: v1_1_0
        Transceivers:
          description: The metrics for the transceivers in this port.  Each member
            represents a single transceiver.
          items:
            $ref: '#/components/schemas/PortMetrics_v1_1_4_Transceiver'
          type: array
          x-longDescription: This property shall contain an array of transceiver-related
            metrics for this port.  Each member in the array shall represent a single
            transceiver.
          x-versionAdded: v1_1_0
      required:
      - '@odata.id'
      - '@odata.type'
      - Id
      - Name
      type: object
      x-longDescription: This resource shall represent the port metrics for a switch
        device or component port summary in a Redfish implementation.
      x-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.
    PortMetrics_v1_1_4_SAS:
      additionalProperties: false
      description: The physical metrics for Serial Attached SCSI (SAS).
      properties:
        InvalidDwordCount:
          description: The number of invalid dwords that have been received by the
            phy outside of phy reset sequences.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the number of invalid dwords
            that have been received by the phy outside of phy reset sequences.
          x-versionAdded: v1_1_0
        LossOfDwordSynchronizationCount:
          description: The number of times the phy has restarted the link reset sequence
            because it lost dword synchronization.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-longDescription: This property shall contain the number of times the phy
            has restarted the link reset sequence because it lost dword synchronization.
          x-versionAdded: v1_1_0
        RunningDisparityErrorCount:
          description: The number of dwords containing running disparity errors that
            have been received by the phy outside of phy reset sequences.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-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.
          x-versionAdded: v1_1_0
      type: object
      x-longDescription: This type shall describe physical (phy) related metrics for
        Serial Attached SCSI (SAS).
      x-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.
    PortMetrics_v1_1_4_Transceiver:
      additionalProperties: false
      description: The transceiver metrics.
      properties:
        RXInputPowerMilliWatts:
          description: The RX input power value of the transceiver, aggregated across
            all lanes of this port.
          minimum: 0
          nullable: true
          readOnly: true
          type: number
          x-longDescription: This property shall contain the RX input power value
            of the transceiver, aggregated across all lanes of this port.
          x-units: mW
          x-versionAdded: v1_1_0
        SupplyVoltage:
          description: The supply voltage for the transceiver.
          nullable: true
          readOnly: true
          type: number
          x-longDescription: This property shall contain the supply voltage for the
            transceiver.
          x-units: V
          x-versionAdded: v1_1_0
        TXBiasCurrentMilliAmps:
          description: The TX bias current value of the transceiver, aggregated across
            all lanes of this port.
          minimum: 0
          nullable: true
          readOnly: true
          type: number
          x-longDescription: This property shall contain the TX bias current value
            of the transceiver, aggregated across all lanes of this port.
          x-units: mA
          x-versionAdded: v1_1_0
        TXOutputPowerMilliWatts:
          description: The TX output power value of the transceiver, aggregated across
            all lanes of this port.
          minimum: 0
          nullable: true
          readOnly: true
          type: number
          x-longDescription: This property shall contain the TX output power value
            of the transceiver, aggregated across all lanes of this port.
          x-units: mW
          x-versionAdded: v1_1_0
      type: object
      x-longDescription: This type shall describe the transceiver-related metrics.
      x-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.
title: '#PortMetrics.v1_1_4.PortMetrics'
x-copyright: Copyright 2014-2025 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright
x-language: en
x-owningEntity: DMTF
x-release: '2021.1'
