Skip to content

opx show interface stats

Jump to bottom
Amy Buck edited this page Jan 9, 2019 · 15 revisions

COMMAND

opx-show-interface-stats — Displays the statistics for the given front-panel Ethernet interfaces

SYNOPSIS

opx-show-interface-stats [-h,--help]
[--port <port-list>] 
[--nonzero]

OPTIONS

Option Description
-h,--help Displays help text
--port <port-list> Specify front-panel Ethernet interface(s) to display; a <port-list> is a comma-separated list of one more ranges; each range is either a single interface, or a pair of interfaces of the form <from..to>, which specifies all interfaces from <from> to <to> inclusive. Examples:
e101-001-0 — expands to e101-001-0
e101-001-0,e101-010-0 — expands to e101-001-0,e101-010-0
e101-001-0,e101-004-0..e101-006-0 — expands to e101-001-0,e101-004-0,e101-005-0,e101-006-0
If the port list is not specified, all Ethernet front-panel ports are shown
--nonzero Display only those counters that are not zero

STATISTICS COUNTERS

Counter Description
Alignment errors Number of inbound Ethernet frames that are not an integral number of octets in length and do not pass the FCS check
Carrier sense errors Number of times that the carrier sense condition was lost or never asserted when attempting to transmit a frame; counter is incremented at most once per transmission attempt, even if the carrier sense condition fluctuates during a transmission attempt; counter does not increment when the interface is operating in full-duplex mode
Deferred transmissions Number of Ethernet frames for which the first transmission attempt is delayed because the medium is busy; count does not include frames involved in collisions; counter does not increment when the interface is operating in full-duplex mode
ECN marked packets Number of packets marked with explicit congestion notification (ECN)
Ethernet broadcast packets Number of Ethernet broadcast frames
Ethernet collisions Number of Ethernet media access collisions
Ethernet CRC align errors Number of CRC align errors
Ethernet drop events Number of Ethernet drop events
Ethernet fragments Number of Ethernet fragments
Ethernet in packets (64 octets) Number of inbound Ethernet frames exactly 64 octets in length
Ethernet in packets (65 to 127 octets) Number of inbound Ethernet frames between 65 and 127 octets in length (inclusive)
Ethernet in packets (128 to 255 octets) Number of inbound Ethernet frames between 128 and 255 octets in length (inclusive)
Ethernet in packets (256 to 511 octets) Number of inbound Ethernet frames between 256 and 511 octets in length (inclusive)
Ethernet in packets (512 to 1023 octets) Number of inbound Ethernet frames between 512 and 1023 octets in length (inclusive)
Ethernet in packets (1024 to 1518 octets) Number of inbound Ethernet frames between 1024 and 1518 octets in length (inclusive)
Ethernet in packets (1519 to 2047 octets) Number of inbound Ethernet frames between 1519 and 2047 octets in length (inclusive)
Ethernet in packets (2048 to 4095 octets) Number of inbound Ethernet frames between 2048 and 4095 octets in length (inclusive)
Ethernet in packets (4096 to 9216 octets) Number of inbound Ethernet frames between 4096 and 9216 octets in length (inclusive)
Ethernet jabbers Number of frames received that were longer than the MTU (excluding framing bits, but including FCS octets), and had either a bad frame; check Sequence (FCS) with an integral number of octets (FCS Error) or a bad FCS with a non-integral number of octets (Alignment Error)
Ethernet multicast packets Number of Ethernet multicast frames
Ethernet octets Number of octets in all Ethernet frames
Ethernet out packets (64 octets) Number of transmitted Ethernet frames exactly 64 octets in length
Ethernet out packets (65 to 127 octets) Number of transmitted Ethernet frames between 65 and 127 octets in length
Ethernet out packets (128 to 255 octets) Number of transmitted Ethernet frames between 128 and 255 octets in length
Ethernet out packets (256 to 511 octets) Number of transmitted Ethernet frames between 256 and 511 octets in length
Ethernet out packets (512 to 1023 octets) Number of transmitted Ethernet frames between 512 and 1023 octets in length
Ethernet out packets (1024 to 1518 octets) Number of transmitted Ethernet frames between 1024 and 1518 octets in length
Ethernet out packets (1519 to 2047 octets) Number of transmitted Ethernet frames between 1519 and 2047 octets in length
Ethernet out packets (2048 to 4095 octets) Number of transmitted Ethernet frames between 2048 and 4095 octets in length
Ethernet out packets (4096 to 9216 octets) Number of transmitted Ethernet frames between 4096 and 9216 octets in length
Ethernet oversize packets Number of oversized Ethernet frames
Ethernet packets Number of Ethernet frames
Ethernet rx no errors Number of incoming Ethernet frames received with no error
Ethernet rx oversize packets Number of oversized incoming Ethernet frames
Ethernet tx no errors Number of outgoing Ethernet frames transmitted with no error
Ethernet tx oversize packets Number of oversized outgoing Ethernet frames
Ethernet undersize packets Number of undersized Ethernet frames
Excessive collisions Number of outbound Ethernet frames for which transmission fails due to excessive collisions; counter does not increment when the interface is operating in full-duplex mode
FCS errors Number of inbound Ethernet frames that are an integral number of octets in length but do not pass the FCS check; count does not include frames received with frame-too-long or frame-too-short error
Frame too long Number of inbound Ethernet frames that exceed the maximum permitted frame size; counter is incremented when the frameTooLong status is returned by the MAC service to the LLC (or other MAC user); received frames for which multiple error conditions pertain are, according to the conventions of IEEE 802.3 Layer Management, counted exclusively according to the error status presented to the LLC
Green discard dropped packets Number of green packets discarded
In broadcast packets Number of inbound Ethernet frames that were addressed to a broadcast address
In discards Number of inbound frames that were chosen to be discarded even though no errors had been detected to prevent their being deliverable to a higher-layer protocol; one possible reason for discarding such a frame could be to free up buffer space
In errors Number of inbound Ethernet frames that contained errors preventing them from being deliverable to a higher-layer protocol
In multicast packets Number of packets, delivered by this sub-layer to a higher (sub)layer, that were addressed to a multicast address at this sub-layer; for a MAC-layer protocol this includes both Group and Functional addresses
In octets Total number of octets inbound on the interface, including framing characters
In unicast packets Number of packets, delivered by this sub-layer to a higher (sub)layer, that were not addressed to a multicast or broadcast address at this sub-layer
In unknown opcodes Number of inbound Ethernet MAC Control frames that contain an opcode that is not supported
In unknown protos For packet-oriented interfaces, the number of packets received via the interface that were discarded because of an unknown or unsupported protocol; for character-oriented or fixed-length interfaces that support protocol multiplexing, the number of transmission units received via the interface that were discarded because of an unknown or unsupported protocol; for any interface that does not support protocol multiplexing, this counter is not present
Internal MAC receive errors Number of inbound Ethernet frames for which reception fails due to an internal MAC sub-layer receive error; a frame is only counted by this counter if it is not counted by "Frame too long", "Alignment errors", or `FCS error"; the precise meaning of this counter is implementation-specific; this counter may count of receive errors that are not otherwise counted
Internal MAC transmit errors Number of outbound Ethernet frames for which transmission fails due to an internal MAC sub-layer transmit error; a frame is only counted by this counter if it is not counted by either "Late collisions", "Excessive collisions", or "Carrier sense errors"; the precise meaning of this counter is implementation-specific; this counter may represent a count of transmission errors that are not otherwise counted
IP in discards Number of IP in discards
IP in forwarded datagrams Number of forwarded IP datagrams
IP in header errors Number of incoming IP packets with header errors
IP in receives Number of received IP packets
IPv6 in address errors Number of IP address errors
IPv6 in discards Number of discarded incoming IP packets
IPv6 in header errors Number of incoming IPv6 packets with header errors
IPv6 in multicast packets Number of incoming IPv6 multicast packets
IPv6 in receives Number of received IPv6 packets
IPv6 out discards Number of discarded outgoing IPv6 packets
IPv6 out forwarded datagrams Number of forwarded IPv6 datagrams
IPv6 out multicast packets Number of outgoing IPv6 multicast packets
Late collisions Number of times that a collision is detected on later than one slotTime into the transmission of a packet; a (late) collision is also considered as a (generic) collision for purposes of other collision-related statistics: this counter does not increment when the interface is operating in full-duplex mode
Multiple collision frames Number of inbound Ethernet frames that are involved in more than one collision and are subsequently transmitted successfully; a frame that is counted by this counter is also counted by "Out unicast packets", "Out multicast packets", or "Out broadcast packets", and is not counted by "Single collision frames"; this counter does not increment when the interface is operating in full-duplex mode
Out broadcast packets Total number of packets that higher-level protocols requested be transmitted, and that were addressed to a broadcast address at this sub-layer, including those that were discarded or not sent
Out discards Number of outbound packets that were chosen to be discarded even though no errors had been detected to prevent their being transmitted; one possible reason for discarding such a packet could be to free up buffer space
Out errors For packet-oriented interfaces, the number of outbound packets that could not be transmitted because of errors; for character-oriented or fixed-length interfaces, the number of outbound transmission units that could not be transmitted because of errors
Out multicast packets Total number of packets that higher-level protocols requested be transmitted, and that were addressed to a multicast address at this sub-layer, including those that were discarded or not sent; for a MAC-layer protocol, this includes both Group and Functional addresses
Out octets Total number of octets transmitted out of the interface, including framing characters
Out queue length Transmit queue length
Out unicast packets Total number of packets that higher-level protocols requested be transmitted, and that were not addressed to a multicast or broadcast address at this sub-layer, including those that were discarded or not sent
Pause rx frames Count of MAC Control frames received with an opcode indicating the PAUSE operation; this counter does not increment when the interface is operating in half-duplex mode
Pause tx frames Count of MAC Control frames transmitted with an opcode indicating the PAUSE operation; this counter does not increment when the interface is operating in half-duplex mode
PFC 0 rx packets Number of received level 0 priority-based flow control frames
PFC 0 tx packets Number of transmitted level 0 priority-based flow control frames
PFC 1 rx packets Number of received level 1 priority-based flow control frames
PFC 1 tx packets Number of transmitted level 1 priority-based flow control frames
PFC 2 rx packets Number of received level 2 priority-based flow control frames
PFC 2 tx packets Number of transmitted level 2 priority-based flow control frames
PFC 3 rx packets Number of received level 3 priority-based flow control frames
PFC 3 tx packets Number of transmitted level 3 priority-based flow control frames
PFC 4 rx packets Number of received level 4 priority-based flow control frames
PFC 4 tx packets Number of transmitted level 4 priority-based flow control frames
PFC 5 rx packets Number of received level 5 priority-based flow control frames
PFC 5 tx packets Number of transmitted level 5 priority-based flow control frames
PFC 6 rx packets Number of received level 6 priority-based flow control frames
PFC 6 tx packets Number of transmitted level 6 priority-based flow control frames
PFC 7 rx packets Number of received level 7 priority-based flow control frames
PFC 7 tx packets Number of transmitted level 7 priority-based flow control frames
RED discard dropped packets Number of packets dropped due to RED
Rx LPI count Number of times state changed from high power mode to low power mode in RX direction
Rx LPI duration Low power mode duration (in microseconds) in RX direction; this duration is cumulative since EEE enable or last clear of statistics
Single collision frames Number of inbound Ethernet frames that are involved in a single collision, and are subsequently transmitted successfully; a frame that is counted by an instance of this counter is also counted by "Out unicast packets", "Out multicast packets", or "Out broadcast packets", and is not counted by "Multiple collision frames"; this counter does not increment when the interface is operating in full-duplex mode
SQE test errors Number of times that the SQE TEST ERROR is received; SQE TEST ERROR is set in accordance with the rules for verification of the SQE detection mechanism in the PLS Carrier Sense Function as described in IEEE Std. 802.3, 2000 Edition, section 7.2.4.6; this counter does not increment on interfaces operating at speeds greater than 10 Mb/s, or on interfaces operating in full-duplex mode
Symbol errors For an interface operating at 100 Mb/s, the number of times there was an invalid data symbol when a valid carrier was present; for an interface operating in half-duplex mode at 1000 Mb/s, the number of times the receiving media is non-idle (a carrier event) for a period of time equal to or greater than slotTime, and during which there was at least one occurrence of an event that causes the PHY to indicate 'Data reception error' or 'carrier extend error' on the GMII. For an interface operating in full-duplex mode at 1000 Mb/s, the number of times the receiving media is non-idle (a carrier event) for a period of time equal to or greater than minFrameSize, and during which there was at least one occurrence of an event that causes the PHY to indicate 'Data reception error' on the GMII. For an interface operating at 10 Gb/s, the number of times the receiving media is non-idle (a carrier event) for a period of time equal to or greater than minFrameSize, and during which there was at least one occurrence of an event that causes the PHY to indicate 'Receive Error' on the XGMII. This counter is incremented at most once per carrier event, even if multiple symbol errors occur during the carrier event. This counter does not increment if a collision is present; this counter does not increment when the interface is operating at 10 Mb/s.
Time stamp Timestamp
Tx LPI count Number of times state changed from high power mode to low power mode in TX direction
Tx LPI duration Low power mode duration (in microseconds) in TX direction; this duration is cumulative since EEE enable or last clear of statistics
Yellow discard dropped packets Number of yellow packets discarded

EXIT STATUS

If an invalid port list is specified, the exit status shall be 1.
If there is a syntax error in the given arguments, the exit status shall be 2.
Otherwise, the exit status is 0.

EXAMPLE

$ opx-show-interface-stats --port e101-001-0
Port e101-001-0
        Alignment errors:                           0
        Carrier sense errors:                       0
        Deferred transmissions:                     0
        ECN marked packets:                         0
        Ethernet broadcast packets:                 0
        Ethernet collisions:                        0
        Ethernet CRC align errors:                  0
        Ethernet drop events:                       0
        Ethernet fragments:                         0
        Ethernet in packets (64 octets):            0
        Ethernet in packets (65 to 127 octets):     330704
        Ethernet in packets (128 to 255 octets):    82857
        Ethernet in packets (256 to 511 octets):    0
        Ethernet in packets (512 to 1023 octets):   0
        Ethernet in packets (1024 to 1518 octets):  0
        Ethernet in packets (1519 to 2047 octets):  0
        Ethernet in packets (2048 to 4095 octets):  0
        Ethernet in packets (4096 to 9216 octets):  0
        Ethernet jabbers:                           0
        Ethernet multicast packets:                 662274
        Ethernet octets:                            94138869
        Ethernet out packets (64 octets):           0
        Ethernet out packets (65 to 127 octets):    316757
        Ethernet out packets (128 to 255 octets):   82850
        Ethernet out packets (256 to 511 octets):   0
        Ethernet out packets (512 to 1023 octets):  0
        Ethernet out packets (1024 to 1518 octets): 0
        Ethernet out packets (1519 to 2047 octets): 0
        Ethernet out packets (2048 to 4095 octets): 0
        Ethernet out packets (4096 to 9216 octets): 0
        Ethernet oversize packets:                  0
        Ethernet packets:                           813168
        Ethernet rx no errors:                      413561
        Ethernet rx oversize packets:               0
        Etherent tx no errors:                      399607
        Ethernet tx oversize packets:               0
        Ethernet undersize packets:                 0
        Excessive collisions:                       0
        FCS errors:                                 0
        Frame too long:                             0
        Green discard dropped packets:              0
        In broadcast packets:                       0
        In discards:                                0
        In errors:                                  0
        In multicast packets:                       330986
        In octets:                                  47697992
        In unicast packets:                         82575
        In unknown opcodes:                         0
        In unknown protocols:                       0
        Internal MAC receive errors:                0
        Internal MAC transmit errors:               0
        IP in discards:                             0
        IP in forwarded datagrams:                  0
        IP in header errors:                        0
        IP in receives:                             13
        IPv6 in address errors:                     0
        IPv6 in discards:                           0
        IPv6 in header errors:                      0
        IPv6 in multicast packets:                  0
        IPv6 in receives:                           39
        IPv6 out discards:                          0
        IPv6 out forwarded datagrams:               0
        IPv6 out multicast packets:                 0
        Late collisions:                            0
        Multiple collision frames:                  0
        Out broadcast packets:                      0
        Out discards:                               0
        Out errors:                                 0
        Out multicast packets:                      331288
        Out octets:                                 46440877
        Out queue length:                           0
        Out unicast packets:                        68319
        Pause rx packets:                           0
        Pause tx packets:                           0
        PFC 0 rx packets:                           0
        PFC 0 tx packets:                           0
        PFC 1 rx packets:                           0
        PFC 1 tx packets:                           0
        PFC 2 rx packets:                           0
        PFC 2 tx packets:                           0
        PFC 3 rx packets:                           0
        PFC 3 tx packets:                           0
        PFC 4 rx packets:                           0
        PFC 4 tx packets:                           0
        PFC 5 rx packets:                           0
        PFC 5 tx packets:                           0
        PFC 6 rx packets:                           0
        PFC 6 tx packets:                           0
        PFC 7 rx packets:                           0
        PFC 7 tx packets:                           0
        RED discard dropped packets:                0
        Rx LPI count:                               0
        Rx LPI duration:                            0
        Single collision frames:                    0
        SQE test errors:                            0
        Symbol errors:                              0
        Time stamp:                                 4049502
        Tx LPI count:                               0
        Tx LPI duration:                            0
        Yellow discard dropped packets:             0

REPORT BUGS

To report any OPX software bugs, see Report bugs.

SEE ALSO

opx-config-interface

© 2019 OpenSwitch project. All information is contributed to and made available by OPX under the Creative Commons Attribution 4.0 International License (available at http://creativecommons.org/licenses/by/4.0/).

Clone this wiki locally