8.3.1.6. RX Statistics

This module contains the L23 port RX statistics classes that provide quantitative information about the received packets on a port.

The command names all have the form PR_<xxx> and require both a module index id and a port index id. Those commands dealing with a specific received test payload id and a specific filter also have a sub-index id.

All bit-and byte-level statistics are at layer-2, so they include the full Ethernet frame, and exclude the inter-frame gap and preamble.

class PR_CALIBRATE[source]

Bases: object

Calibrate the latency calculation for packets received on a port. The lowest detected latency value (across all Test Payload IDs) will be set as the new base.

class SetDataAttr[source]: Bases: RequestBodyStruct

set()[source]: Calibrate the latency calculation for packets received on a port. The lowest detected latency value (across all Test Payload IDs) will be set as the new base.

class PR_CLEAR[source]

Bases: object

Clear all the receive statistics for a port. The byte and packet counts will restart at zero.

class SetDataAttr[source]: Bases: RequestBodyStruct

set()[source]: Clear all the receive statistics for a port. The byte and packet counts will restart at zero.

class PR_EXTRA[source]

Bases: object

Obtains statistics concerning special errors received on a port since received statistics were cleared.

class GetDataAttr[source]

Bases: ResponseBodyStruct

fcs_error_count: long integer, number of packets with frame checksum errors.

gap_count: long integer, number of gap-monitored gaps encountered.

gap_duration: long integer, combined duration of gap-monitored gaps encountered, microseconds.

pause_frame_count: long integer, number of Ethernet pause frames.

rx_arp_reply_count: long integer, number of ARP reply packets received.

rx_arp_request_count: long integer, number of ARP request packets received.

rx_ping_reply_count: long integer, number of PING reply packets received.

rx_ping_request_count: long integer, number of PING request packets received.

get()[source]

Get statistics concerning special packets received on a port since statistics were cleared.

Returns:: number of packets with fcs error frames, pause frames, arp rxreq, arp rxrsp, ping rxreq, ping rxrsp, gap events, and gap microseconds.
Return type:: PR_EXTRA.GetDataAttr

class PR_FILTER[source]

Bases: object

Obtains statistics concerning the packets satisfying the condition of a particular filter for a port.

class GetDataAttr[source]

Bases: ResponseBodyStruct

bit_count_last_sec: long integer, number of bits received in the last second.

byte_count_since_cleared: long integer, number of bytes received since statistics were cleared.

packet_count_last_sec: long integer, number of packets received in the last second.

packet_count_since_cleared: long integer, number of packets received since statistics were cleared.

get()[source]

Get statistics concerning the packets satisfying the condition of a particular filter for a port

Returns:: number of bits received in the last second, number of packets received in the last second, number of bytes received since statistics were cleared, number of packets received since statistics were cleared
Return type:: PR_FILTER.GetDataAttr

class PR_FILTEREXT[source]

Bases: object

An extension of PR_FILTER that also includes a calculation of bytes received in the last second. PR_FILTEREXT returns list of long integers. This list may be expanded in future software releases.

class GetDataAttr[source]

Bases: ResponseBodyStruct

bit_count_last_sec: long integer, number of bits received in the last second.

byte_count_last_sec: long integer, number of bytes received in the last second.

byte_count_since_cleared: long integer, number of bytes received since statistics were cleared.

packet_count_last_sec: long integer, number of packets received in the last second.

packet_count_since_cleared: long integer, number of packets received since statistics were cleared.

get()[source]

Get statistics concerning the packets satisfying the condition of a particular filter for a port

Returns:: number of bits received in the last second, number of bytes received in the last second, number of packets received in the last second, number of bytes received since statistics were cleared, number of packets received since statistics were cleared
Return type:: PR_FILTEREXT.GetDataAttr

class PR_NOTPLD[source]

Bases: object

Obtains statistics concerning the packets without a test payload received on a port.

class GetDataAttr[source]

Bases: ResponseBodyStruct

bit_count_last_sec: long integer, number of bits received in the last second.

byte_count_since_cleared: long integer, number of bytes received since statistics were cleared.

packet_count_last_sec: long integer, number of packets received in the last second.

packet_count_since_cleared: long integer, number of packets received since statistics were cleared.

get()[source]

Get statistics concerning the packets without a test payload received on a port.

Returns:: number of bits received in the last second, number of packets received in the last second, number of bytes received since statistics were cleared, and number of packets received since statistics were cleared.
Return type:: PR_NOTPLD.GetDataAttr

class PR_NOTPLDEXT[source]

Bases: object

An extension of PR_NOTPLD that also includes a calculation of bytes received in the last second. PR_NOTPLDEXT returns list of long integers. This list may be expanded in future software releases.

class GetDataAttr[source]

Bases: ResponseBodyStruct

bit_count_last_sec: long integer, number of bits received in the last second.

byte_count_last_sec: long integer, number of bytes received in the last second.

byte_count_since_cleared: long integer, number of bytes received since statistics were cleared.

packet_count_last_sec: long integer, number of packets received in the last second.

packet_count_since_cleared: long integer, number of packets received since statistics were cleared.

get()[source]

Get statistics concerning the packets without a test payload received on a port.

Returns:: number of bits received in the last second, number of bytes received in the last second, number of packets received in the last second, number of bytes received since statistics were cleared, and number of packets received since statistics were cleared.
Return type:: PR_NOTPLDEXT.GetDataAttr

class PR_PFCSTATS[source]

Bases: object

Obtains statistics of received Priority Flow Control (PFC) packets on a port.

Changed in version 1.1.

class GetDataAttr[source]

Bases: ResponseBodyStruct

packet_count: long integer, the total number of Priority Flow Control (PFC) packets received since statistics were cleared.

quanta_pri_0: the total number of valid PFC quanta received on the port for priority level 0 since statistics were cleared

quanta_pri_1: the total number of valid PFC quanta received on the port for priority level 1 since statistics were cleared

quanta_pri_2: the total number of valid PFC quanta received on the port for priority level 2 since statistics were cleared

quanta_pri_3: the total number of valid PFC quanta received on the port for priority level 3 since statistics were cleared

quanta_pri_4: the total number of valid PFC quanta received on the port for priority level 4 since statistics were cleared

quanta_pri_5: the total number of valid PFC quanta received on the port for priority level 5 since statistics were cleared

quanta_pri_6: the total number of valid PFC quanta received on the port for priority level 6 since statistics were cleared

quanta_pri_7: the total number of valid PFC quanta received on the port for priority level 7 since statistics were cleared

get()[source]

Get the statistics of received Priority Flow Control (PFC) packets on a port.

Returns:: the total number of Priority Flow Control (PFC) packets received since statistics were cleared
Return type:: PR_PFCSTATS.GetDataAttr

class PR_TOTAL[source]

Bases: object

Obtains statistics concerning all the packets received on a port.

class GetDataAttr[source]

Bases: ResponseBodyStruct

bit_count_last_sec: long integer, number of bits received in the last second.

byte_count_since_cleared: long integer, number of bytes received since statistics were cleared.

packet_count_last_sec: long integer, number of packets received in the last second.

packet_count_since_cleared: long integer, number of packets received since statistics were cleared.

get()[source]

Get statistics concerning all the packets received on a port.

Returns:: number of bits received in the last second, number of packets received in the last second, number of bytes received since statistics were cleared, and number of packets received since statistics were cleared.
Return type:: PR_TOTAL.GetDataAttr

class PR_TOTALEXT[source]

Bases: object

An extension of PR_TOTAL that also includes a calculation of bytes received in the last second, as well as a number of port error counters. PR_TOTALEXT returns list of long integers. This list may be expanded in future software releases.

class GetDataAttr[source]

Bases: ResponseBodyStruct

bit_count_last_sec: long integer, number of bits received in the last second.

byte_count_last_sec: long integer, number of bytes received in the last second.

byte_count_since_cleared: long integer, number of bytes received since statistics were cleared.

packet_count_last_sec: long integer, number of packets received in the last second.

packet_count_since_cleared: long integer, number of packets received since statistics were cleared.

get()[source]

Get statistics concerning all the packets received on a port.

Returns:: number of bits received in the last second, number of bytes received in the last second, number of packets received in the last second, number of bytes received since statistics were cleared, number of packets received since statistics were cleared, number of packets received with fcs error frames, number of oversize packets received since last clear (-1 if this counter is not supported by the tester), number of undersize packets received since last clear (-1 if this counter is not supported by the tester), number of jabber packets received since last clear (-1 if this counter is not supported by the tester).
Return type:: PR_TOTALEXT.GetDataAttr

class PR_TPLDERRORS[source]

Bases: object

Obtains statistics concerning errors in the packets with a particular test payload id received on a port. The error information is derived from analyzing the various fields contained in the embedded test payloads of the received packets, independent of which chassis and port may have originated the packets. Note that packet-lost statistics involve both a transmitting port and a receiving port, and in particular knowing which port originated the packets with a particular test payload identifier. This information requires knowledge of the global test environment, and is not supported at the port-level.

class GetDataAttr[source]

Bases: ResponseBodyStruct

dummy: long integer, not in use.

non_incre_payload_packet_count: long integer, number of packets with non-incrementing payload content.

non_incre_seq_event_count: long integer, number of non-incrementing-sequence-number events.

swapped_seq_misorder_event_count: long integer, number of swapped-sequence-number misorder events.

get()[source]

Get statistics concerning errors in the packets with a particular test payload id received on a port.

Returns:: dummy value not in use, number of non-incrementing-sequence-number events, number of swapped-sequence-number misorder events, number of packets with non-incrementing payload content
Return type:: PR_TPLDERRORS.GetDataAttr

class PR_TPLDJITTER[source]

Bases: object

Obtains statistics concerning the jitter experienced by the packets with a particular test payload id received on a port. The values are the difference in packet-to-packet latency, and the minimum will usually be zero.A special value of -1 is returned if jitter numbers are not applicable. They are only available for TID values 0..31.

class GetDataAttr[source]

Bases: ResponseBodyStruct

avg_last_sec: long integer, nanoseconds, average jitter over last 1-second period

avg_val: long integer, nanoseconds, average jitter for test payload stream

max_last_sec: long integer, nanoseconds, maximum jitter during last 1-second period

max_val: long integer, nanoseconds, maximum jitter for test payload stream

min_last_sec: long integer, nanoseconds, minimum jitter during last 1-second period

min_val: long integer, nanoseconds, minimum jitter for test payload stream

get()[source]

Get statistics concerning the jitter experienced by the packets with a particular test payload id received on a port.

Returns:: minimum|average|maximum jitter (nanoseconds), average|average|maximum jitter over last 1-second period (nanoseconds)
Return type:: PR_TPLDJITTER.GetDataAttr

class PR_TPLDLATENCY[source]

Bases: object

Obtains statistics concerning the latency experienced by the packets with a particular test payload id received on a port. The values are adjusted by the port-level P_LATENCYOFFSET value. A special value of -1 is returned if latency numbers are not applicable. Latency is only meaningful when the clocks of the transmitter and receiver are synchronized. This requires the two ports to be on the same test module, and it requires knowledge of the global test environment to ensure that packets are in fact routed between these ports.

class GetDataAttr[source]

Bases: ResponseBodyStruct

avg_last_sec: long integer, nanoseconds, average latency over last 1-second period

avg_val: long integer, nanoseconds, average latency for test payload stream

max_last_sec: long integer, nanoseconds, maximum latency during last 1-second period

max_val: long integer, nanoseconds, maximum latency for test payload stream

min_last_sec: long integer, nanoseconds, minimum latency during last 1-second period

min_val: long integer, nanoseconds, minimum latency for test payload stream

get()[source]

Get statistics concerning the latency experienced by the packets with a particular test payload id received on a port.

Returns:: minimum|average|maximum latency (nanoseconds), average|average|maximum latency over last 1-second period (nanoseconds)
Return type:: PR_TPLDLATENCY.GetDataAttr

class PR_TPLDS[source]

Bases: object

Obtain the set of test payload IDs observed among the received packets since receive statistics were cleared. Traffic statistics for these test payload streams will have non-zero byte and packet count.

class GetDataAttr[source]

Bases: ResponseBodyStruct

test_payload_identifiers: list of integers, the identifiers of the test payload.

get()[source]

Get the set of test payload IDs observed among the received packets since receive statistics were cleared. Traffic statistics for these test payload streams will have non-zero byte and packet count.

Returns:: the identifiers of the test payload
Return type:: PR_TPLDS.GetDataAttr

class PR_TPLDTRAFFIC[source]

Bases: object

Obtains traffic statistics concerning the packets with a particular test payload identifier received on a port.

class GetDataAttr[source]

Bases: ResponseBodyStruct

bit_count_last_sec: long integer, number of bits received in the last second.

byte_count_since_cleared: long integer, number of bytes received since statistics were cleared.

packet_count_last_sec: long integer, number of packets received in the last second.

packet_count_since_cleared: long integer, number of packets received since statistics were cleared.

get()[source]

Get traffic statistics concerning the packets with a particular test payload identifier received on a port.

Returns:: number of bits received in the last second, number of packets received in the last second, number of bytes received since statistics were cleared, number of packets received since statistics were cleared
Return type:: PR_TPLDTRAFFIC.GetDataAttr

class PR_TPLDTRAFFICEXT[source]

Bases: object

An extension of PR_TPLDTRAFFIC that also includes a calculation of bytes received in the last second. PR_TPLDTRAFFICEXT returns list of long integers. This list may be expanded in future software releases.

class GetDataAttr[source]

Bases: ResponseBodyStruct

bit_count_last_sec: long integer, number of bits received in the last second.

byte_count_last_sec: long integer, number of bytes received in the last second.

byte_count_since_cleared: long integer, number of bytes received since statistics were cleared.

packet_count_last_sec: long integer, number of packets received in the last second.

packet_count_since_cleared: long integer, number of packets received since statistics were cleared.

get()[source]

Get traffic statistics concerning the packets with a particular test payload identifier received on a port.

Returns:: number of bits received in the last second, number of bytes received in the last second, number of packets received in the last second, number of bytes received since statistics were cleared, number of packets received since statistics were cleared
Return type:: PR_TPLDTRAFFICEXT.GetDataAttr

class PR_UAT_STATUS[source]

Bases: object

This command will show the current UAT (UnAvailable Time) state, which is used in Valkyrie1564

class GetDataAttr[source]

Bases: ResponseBodyStruct