Telemetry

async OPNsenseClient.get_telemetry()

Return consolidated system telemetry from OPNsense.

Returns:

Mapping containing mbuf,

pfstate, memory, system, cpu, filesystems, and temps sections populated from the corresponding diagnostics endpoints.

Return type:

MutableMapping[str, Any]

async OPNsenseClient.get_interfaces()

Return normalized interface status and counters.

Returns:

Mapping keyed by OPNsense interface

identifier. Each interface includes packet and byte counters, error counters, status, addresses, media, gateway and route metadata, MAC address, enabled flag, and VLAN tag when available.

Return type:

MutableMapping[str, Any]

async OPNsenseClient.get_gateways()

Return OPNsense gateway status details.

Returns:

Mapping keyed by gateway name, with each

gateway row preserved from OPNsense and status normalized from the translated status when available.

Return type:

MutableMapping[str, Any]