System

async OPNsenseClient.get_device_unique_id(expected_id=None)

Get the OPNsense Unique ID.

Parameters:

expected_id (str | None, optional) – Identifier for the related expected entry.

Returns:

Normalized data returned by the related OPNsense endpoint.

Return type:

str | None

async OPNsenseClient.get_system_info()

Return the system info from OPNsense.

Returns:

Normalized data returned by the related OPNsense endpoint.

Return type:

dict[str, Any]

async OPNsenseClient.get_carp()

Fetch one CARP snapshot and return both interfaces and aggregate summary.

Returns:

Snapshot payload containing interfaces and status_summary derived from one backend fetch.

Return type:

dict[str, Any]

async OPNsenseClient.system_reboot()

Reboot OPNsense.

Returns:

True when the operation succeeds; otherwise, False.

Return type:

bool

async OPNsenseClient.system_halt()

Shutdown OPNsense.

Return type:

None

async OPNsenseClient.send_wol(interface, mac)

Send a wake on lan packet to the specified MAC address.

Parameters:

• interface (str) – Interface identifier to reload or inspect.

• mac (str) – MAC address to use for Wake-on-LAN.

Returns:

True when the operation succeeds; otherwise, False.

Return type:

bool

async OPNsenseClient.get_notices()

Get active OPNsense notices.

Returns:

Normalized data returned by the related OPNsense endpoint.

Return type:

dict[str, Any]

async OPNsenseClient.close_notice(id)

Close selected notices.

Parameters:

id (str) – Identifier of the notice to close.

Returns:

True when the operation succeeds; otherwise, False.

Return type:

bool

async OPNsenseClient.reload_interface(if_name)

Reload the specified interface.

Parameters:

if_name (str) – Interface name to select rows for.

Returns:

True when the operation succeeds; otherwise, False.

Return type:

bool

async OPNsenseClient.get_certificates()

Return the active encryption certificates.

Returns:

Normalized data returned by the related OPNsense endpoint.

Return type:

dict[str, Any]