SMART

async OPNsenseClient.get_smart()

Return SMART device data from the OPNsense SMART plugin.

Returns:

SMART device rows returned by the detailed API.

Return type:

list[dict[str, Any]]

async OPNsenseClient.get_smart_result()

Return SMART device data with authoritative availability metadata.

Return type:

CategoryResult[list[dict[str, Any]]]

async OPNsenseClient.get_smart_info(device, info_type='a')

Return SMART detail data for a single device.

Parameters:
  • device (str) – SMART device name, such as nvme0 or ada0.

  • info_type (str) – SMART info selector supported by the plugin. Valid values are: - i: Device info - H: Health - c: SMART capabilities - A: Attributes - a: All (default) - x: Extended

Returns:

Decoded SMART detail payload. Non-mapping outputs

are wrapped under output to preserve a stable mapping API.

Return type:

dict[str, Any]

async OPNsenseClient.get_smart_info_result(device, info_type='a')

Return SMART detail data with authoritative availability metadata.

Parameters:
  • device (str) – SMART device name, such as nvme0 or ada0.

  • info_type (str) – SMART info selector supported by the plugin.

Returns:

Normalized detail data and its

authoritative availability state.

Return type:

CategoryResult[dict[str, Any]]