aiopnsense

GitHub Release GitHub Release Date GitHub Activity Coverage Documentation License

PyPI

aiopnsense is an async Python client library for OPNsense.

What this library does

aiopnsense wraps supported OPNsense REST endpoints behind a single async client, OPNsenseClient. It is designed for applications that need to query router state or trigger supported OPNsense actions without manually building HTTP requests.

The client currently includes helpers for:

  • system information, notices, certificates, CARP, Wake-on-LAN, reboot, and interface reloads
  • firmware version checks, update status, and upgrade actions
  • interface, gateway, CPU, memory, filesystem, and temperature telemetry
  • diagnostics traffic snapshots and live interface traffic stream samples
  • DHCP lease and ARP table access
  • firewall rules, NAT rules, alias toggling, and state killing
  • service status lookup and service start/stop/restart operations
  • SMART device listing and per-device SMART detail queries
  • Unbound blocklist management
  • OpenVPN and WireGuard status plus VPN instance toggling
  • vnStat metrics, captive portal vouchers, and speed test data

Requirements

  • Requires OPNsense Firmware >= 25.1

  • Recommended OPNsense Firmware >= 26.1.1

    • For firmware < 26.1.1, the Firewall and NAT methods will return empty data.

Documentation

Live test scripts

The scripts/ directory includes live diagnostic helpers for maintainers:

  • aiopnsense_dump.py runs supported aiopnsense client endpoints and prints the raw data returned by the library.
  • opnsense_api_call.py calls an arbitrary OPNsense API endpoint with a specified method and optional POST payload.

Both scripts read credentials from scripts/aiopnsense.env by default. Copy scripts/aiopnsense.env.example to create your local env file; it is ignored by git. Full CLI reference is in the Read the Docs script documentation.

Origin and Purpose

aiopnsense was extracted from the hass-opnsense integration. It is primarily used as an external dependency by hass-opnsense and Home Assistant for its OPNsense Integration.

Project links

Data verified by PyPI on Jul 16, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.1.7)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for Snuffy2 from gravatar.com Snuffy2

Credits

Author: Snuffy2

GitHub Statistics

Data verified by PyPI on Jul 16, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

Apache-2.0
View SPDX License List

Requires

Python >=3.14

Provides Extra

docs

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiopnsense-1.1.3.tar.gz (136.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aiopnsense-1.1.3-py3-none-any.whl (72.8 kB view details)

Uploaded Python 3

File details

Details for the file aiopnsense-1.1.3.tar.gz.

File metadata

  • Download URL: aiopnsense-1.1.3.tar.gz
  • Upload date:
  • Size: 136.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for aiopnsense-1.1.3.tar.gz
Algorithm Hash digest
SHA256 eb60927f5fd07252caa0e8549f7b345762b4edcf44daed19cbcb799e5de0b110
MD5 398ab09205ff8b99199d4c60eedcd9f9
BLAKE2b-256 67d4d148b692e2eed4a75b4d1a1789ce8431956c7a9e24b884eb15dfd2dd06f3

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiopnsense-1.1.3.tar.gz:

Publisher: release.yml on Snuffy2/aiopnsense

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aiopnsense-1.1.3-py3-none-any.whl.

File metadata

  • Download URL: aiopnsense-1.1.3-py3-none-any.whl
  • Upload date:
  • Size: 72.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for aiopnsense-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a8ca5df829f13a332192805caf6c6e0a4bc2c8546e0e8f5f194ac5a913ecbc42
MD5 300ead425ebbb45d5f42e3e435e3bf12
BLAKE2b-256 962b7522ffc70fedc1cee4596584b82d3345e2d4c0bbf47934b3e2721cf352e1

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiopnsense-1.1.3-py3-none-any.whl:

Publisher: release.yml on Snuffy2/aiopnsense

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page