Firmware

async OPNsenseClient.get_host_firmware_version()

Return the OPNsense Firmware version.

Returns:: Normalized data returned by the related OPNsense endpoint.
Return type:: None | str

async OPNsenseClient.get_firmware_update_info()

Get the details of available firmware updates.

Returns:: Normalized data returned by the related OPNsense endpoint.
Return type:: MutableMapping[str, Any]

async OPNsenseClient.upgrade_firmware(type='update')

Trigger a firmware upgrade.

Parameters:: type (str) – Requested firmware upgrade type.
Returns:: Mapping containing normalized fields for downstream use.
Return type:: MutableMapping[str, Any] | None

async OPNsenseClient.upgrade_status()

Return the status of the firmware upgrade.

Returns:: The status of the firmware upgrade.
Return type:: MutableMapping[str, Any]

async OPNsenseClient.firmware_changelog(version)

Return the changelog for the firmware upgrade.

Parameters:: version (str) – Firmware version string to cache.
Returns:: The changelog for the firmware upgrade.
Return type:: MutableMapping[str, Any]