TX Statistics

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

The command names all have the form PT_<xxx> and require both a module index id and a port index id. Those commands dealing with a specific transmitted stream also have a sub-index.

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 PT_CLEAR[source]

Bases: object

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

class SetDataAttr[source]: Bases: RequestBodyStruct

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

class PT_EXTRA[source]

Bases: object

Obtains additional statistics for packets transmitted on a port.

class GetDataAttr[source]

Bases: ResponseBodyStruct

tx_arp_req_count: long integer, number of ARP requests transmitted

get()[source]

Get additional statistics for packets transmitted on a port.

Returns:: number of ARP requests transmitted
Return type:: PT_EXTRA.GetDataAttr

class PT_NOTPLD[source]

Bases: object

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

class GetDataAttr[source]

Bases: ResponseBodyStruct

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

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

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

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

get()[source]

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

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

class PT_NOTPLDEXT[source]

Bases: object

An extension to PT_NOTPLD that also includes a calculation of bytes transmitted in the last second. It 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 transmitted in the last second.

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

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

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

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

get()[source]

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

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

class PT_STREAM[source]

Bases: object

Obtains statistics concerning the packets of a specific stream transmitted on a port.

class GetDataAttr[source]

Bases: ResponseBodyStruct

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

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

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

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

get()[source]

Get statistics concerning the packets of a specific stream transmitted on a port.

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

class PT_STREAMEXT[source]

Bases: object

An extension to PT_STREAM that also includes a calculation of bytes transmitted in the last second. It 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 transmitted in the last second.

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

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

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

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

get()[source]

Get statistics concerning the packets of a specific stream transmitted on a port.

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

class PT_TOTAL[source]

Bases: object

Obtains statistics concerning all the packets transmitted on a port.

class GetDataAttr[source]

Bases: ResponseBodyStruct

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

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

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

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

get()[source]

Get statistics concerning all the packets transmitted on a port.

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

class PT_TOTALEXT[source]

Bases: object

An extension to PT_TOTAL that also includes a calculation of bytes transmitted in the last second. It 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 transmitted in the last second.

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

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

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

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

get()[source]

Get statistics concerning all the packets transmitted on a port.

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