aiopnsense
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 NATmethods will return empty data.
- For firmware < 26.1.1, the
Documentation
- Read the Docs: https://aiopnsense.readthedocs.io
Live test scripts
The scripts/ directory includes live diagnostic helpers for maintainers:
aiopnsense_dump.pyruns supportedaiopnsenseclient endpoints and prints the raw data returned by the library.opnsense_api_call.pycalls 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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aiopnsense-1.1.1.tar.gz.
File metadata
- Download URL: aiopnsense-1.1.1.tar.gz
- Upload date:
- Size: 130.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
24dd7c43ccdd63c65b7921ffed1b9d903507d23c80bd250304b7703d81626dda
|
|
| MD5 |
8fc6ea521099a9b86b91a58312fe65b4
|
|
| BLAKE2b-256 |
bf8fa9ca4d6a1647daa9be9af7ea2e06caf777e03e31eba3d3a138bae3aba065
|
Provenance
The following attestation bundles were made for aiopnsense-1.1.1.tar.gz:
Publisher:
release.yml on Snuffy2/aiopnsense
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
aiopnsense-1.1.1.tar.gz -
Subject digest:
24dd7c43ccdd63c65b7921ffed1b9d903507d23c80bd250304b7703d81626dda - Sigstore transparency entry: 2156852572
- Sigstore integration time:
-
Permalink:
Snuffy2/aiopnsense@eba4d756589a214980f51ef667483970c2e7f9d0 -
Branch / Tag:
refs/tags/v1.1.1 - Owner: https://github.com/Snuffy2
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@eba4d756589a214980f51ef667483970c2e7f9d0 -
Trigger Event:
release
-
Statement type:
File details
Details for the file aiopnsense-1.1.1-py3-none-any.whl.
File metadata
- Download URL: aiopnsense-1.1.1-py3-none-any.whl
- Upload date:
- Size: 71.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0577f2648abf002bfeae966527418ec7b4b905a1a6ff2c7f29891e0ddced85da
|
|
| MD5 |
58928d1acf751f6f78858c08d1b3a572
|
|
| BLAKE2b-256 |
606a2c66f329c2c5b1b6818b3f7237ed0fa4cea157f6340da85761d523900d33
|
Provenance
The following attestation bundles were made for aiopnsense-1.1.1-py3-none-any.whl:
Publisher:
release.yml on Snuffy2/aiopnsense
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
aiopnsense-1.1.1-py3-none-any.whl -
Subject digest:
0577f2648abf002bfeae966527418ec7b4b905a1a6ff2c7f29891e0ddced85da - Sigstore transparency entry: 2156853046
- Sigstore integration time:
-
Permalink:
Snuffy2/aiopnsense@eba4d756589a214980f51ef667483970c2e7f9d0 -
Branch / Tag:
refs/tags/v1.1.1 - Owner: https://github.com/Snuffy2
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@eba4d756589a214980f51ef667483970c2e7f9d0 -
Trigger Event:
release
-
Statement type:
