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 21, 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 21, 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.5.tar.gz (139.8 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.5-py3-none-any.whl (74.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aiopnsense-1.1.5.tar.gz
Algorithm Hash digest
SHA256 7b915a9f8e3806f083bf06e5f5c16851af7a58e0d2f4ec43f0833e964605a9b9
MD5 ff058cb5470a5e9c0efdc231fa67edd8
BLAKE2b-256 0ce724dd188f17dfef1b54bb4a51422c088d7c7f9915604d498b384cf636c1f2

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiopnsense-1.1.5.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.5-py3-none-any.whl.

File metadata

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

File hashes

Hashes for aiopnsense-1.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 54bfe5d9f89f4289f03d482c4edb900c75de53baab071dd8924a5918a17da6d8
MD5 e0085bbe1f325072c78cce9027d5afd2
BLAKE2b-256 e4c4519fef3deec52ec1e0a46b95e47e885790a6dedc9be5cc2ffbd76602cf36

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiopnsense-1.1.5-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