Traffic

async OPNsenseClient.get_interface_traffic()

Return a normalized diagnostics traffic snapshot.

Returns:

Normalized diagnostics traffic sample. Returns an

empty traffic sample when endpoint probing or response parsing fails.

Return type:

dict[str, Any]

async OPNsenseClient.stream_interface_traffic(poll_interval=1)

Yield normalized diagnostics traffic stream samples.

Parameters:

poll_interval (int) – OPNsense stream sample interval in seconds. Values less than 1 are clamped to 1.

Yields:

Normalized traffic samples. The first stream event is discarded because OPNsense stream endpoints commonly emit an initialization sample before interval deltas stabilize.

Return type:

AsyncIterator[dict[str, Any]]