Firmware

async OPNsenseClient.get_host_firmware_version()

Return the cached OPNsense firmware version.

Returns:

Installed firmware version, falling back to the product

series for non-SemVer version strings, or None when the firmware status endpoint is unavailable.

Return type:

None | str

async OPNsenseClient.get_firmware_update_info()

Return firmware status and trigger a refresh when cached data is stale.

Returns:

Firmware status payload from OPNsense,

including product version, latest version, check status, and update metadata when available. Returns an empty mapping when the firmware status endpoint is unavailable.

Return type:

MutableMapping[str, Any]

async OPNsenseClient.upgrade_firmware(type='update')

Trigger a firmware upgrade.

Parameters:

type (str) – Firmware action to trigger. update applies minor updates on the current series, while upgrade starts a major series upgrade.

Returns:

Firmware action response for

supported action types, or None when type is not update or upgrade.

Return type:

MutableMapping[str, Any] | None

async OPNsenseClient.upgrade_status()

Return the status of the active firmware upgrade.

Returns:

Upgrade status payload, or an empty

mapping when the upgrade-status endpoint is unavailable.

Return type:

MutableMapping[str, Any]

async OPNsenseClient.firmware_changelog(version)

Return the changelog for the firmware upgrade.

Parameters:

version (str) – Firmware version whose changelog should be fetched.

Returns:

Changelog response for the requested

firmware version.

Return type:

MutableMapping[str, Any]