--- title: "OPNsense" description: "OPNsense is a Marketplace integration for Home Assistant. It has 1.3k installs sharing analytics, works locally and was last updated October 24, 2026." canonical: "https://vulpo.app/integrations/marketplace/travisghansen-hass-opnsense" url: "https://vulpo.app/integrations/marketplace/travisghansen-hass-opnsense.md" last-updated: "2026-10-22" version: "1.4" --- # OPNsense > OPNsense is a Marketplace integration for Home Assistant. It has 1.3k installs sharing analytics, works locally and was last updated October 24, 2026. OPNsense is a Home Assistant integration that connects to an OPNsense firewall or router over the local network. It replaces the built-in OPNsense integration, which only offers device tracking, and adds binary sensors, sensors, switches, update entities and presence tracking. Categories such as telemetry, interfaces, DHCP leases, gateways, firmware, VPN, services, CARP, vnStat bandwidth and speedtest results can be synced selectively, so the API user can have narrower permissions. Actions cover starting, stopping and restarting services, rebooting or halting the router, sending wake-on-lan packets, killing states, generating captive portal vouchers, running a speedtest and toggling aliases or interfaces. A separate CARP virtual IP entry gives read-only visibility of the active responder, while each physical node is configured on its own. It is added as a custom repository in the Marketplace and set up in the Home Assistant UI with an API key and secret, and it requires OPNsense firmware 25.1 or newer. Automatic summary of the README and code of travisghansen/hass-opnsense. Something wrong, or are you the maintainer and want your own text here? [Get in touch](https://vulpo.app/contact) Not in the Marketplace catalog. Add as a custom repository in the Marketplace. ## Supports - **Works locally**: Talks to your devices on your own network. No vendor cloud in between. - **From the Marketplace**: Installed through the Marketplace, formerly HACS. - **Actively maintained**: Its author released or pushed a change in the last six months. ## Setting it up Add its repository to the Marketplace as a custom repository and install it, then restart Home Assistant and add it under Settings, Devices and services. ### Connect to the OPNsense firewall / router - **URL**: Use the actual OPNsense device URL. Do not use a CARP virtual URL. - **API Key** - **API Secret** - **Firewall Name** - **Verify SSL certificate** - **Enable Granular Sync Options** ### Connect to the OPNsense CARP VIP entry - **URL**: Use the CARP virtual URL; individual physical nodes must also be configured separately via their management addresses. - **API Key** - **API Secret** - **CARP VIP display name** - **Verify SSL certificate** ### Choose what items to sync - **Basic telemetry data** - **Interface information** - **Live interface traffic** - **DHCP leases** - **Gateway information** - **Firmware updates** - **VPN information and switches** - **CARP information** - **Service switches** - **Notice information** - **Firewall and NAT rules switches** - **Unbound blocklist switches** - **Security certificate information** - **vnStat bandwidth usage** - **Speedtest results** ### Update connection to the OPNsense firewall / router - **Display name** - **URL** - **API Key** - **API Secret** - **Verify SSL certificate** ### After setup - **Scan Interval**: Scan interval controls how often this entry polls its source. - **Device Tracker Mode**: For Track only selected devices, a next step lets you pick devices from recent ARP detections and add MAC addresses manually - **Device Tracker Scan Interval** - **Device Tracker Consider Home** - **Resolve Device Tracker Hostnames**: Ask OPNsense to reverse-resolve ARP entries so device trackers are named by hostname instead of MAC address. Disable if the OPNsense host has no working reverse DNS for LAN clients. - **Enable Granular Sync Options** - **Basic telemetry data** - **vnStat bandwidth usage** - **Speedtest results** - **Live interface traffic** - **SMART disk information** - **NUT UPS status** - **VPN information and switches** - **Firmware updates** - **CARP information** - **DHCP leases** - **Gateway information** - **Service switches** - **Notice information** - **Firewall and NAT rules switches** - **Unbound blocklist switches** - **Devices to Track**: Only recently detected devices appear here. Previously selected devices that are not currently detected stay available in the list. - **Additional MAC addresses not currently detected**: Enter MAC addresses separated by commas or new lines. Invalid MAC addresses are ignored. Example: 00:00:00:00:00:00 Texts from the code of [travisghansen/hass-opnsense](https://github.com/travisghansen/hass-opnsense). ## Entities - **Sensors**: Active responder, CARP VIP status ## Actions - **Close notice**: Closes one or all notices on OPNsense Fields: Notice ID, OPNsense Device, OPNsense Entity - **Start service**: Starts an OPNsense service Fields: Service ID, Service Name, OPNsense Device, OPNsense Entity - **Stop service**: Stops an OPNsense service Fields: Service ID, Service Name, OPNsense Device, OPNsense Entity - **Restart service**: Restarts an OPNsense service Fields: Service ID, Service Name, Only if Running, OPNsense Device, OPNsense Entity - **Halt system**: Halts the OPNsense Router Fields: OPNsense Device, OPNsense Entity - **Reboot system**: Reboots the OPNsense Router Fields: OPNsense Device, OPNsense Entity - **Send WOL**: Sends a wake-on-lan magic packet Fields: Interface Name, MAC Address, OPNsense Device, OPNsense Entity - **Reload an Interface**: Reload or restart an OPNsense interface Fields: Interface Name, OPNsense Device, OPNsense Entity - **Generate Captive Portal Vouchers**: Vouchers for use with Captive Portal (like guest WiFi) Fields: Validity, Expires in, Number of vouchers, Groupname, Captive Portal Voucher Server, OPNsense Device, OPNsense Entity - **Kill States**: Kill all states for an IP address Fields: IP Address, OPNsense Device, OPNsense Entity - **Run Speedtest**: Run an OPNsense speedtest and return results as action response data Fields: OPNsense Device, OPNsense Entity - **Get vnStat Metrics**: Get parsed vnStat metrics for a selected period as action response data Fields: Period, OPNsense Device, OPNsense Entity - **Toggle Alias**: Toggle, Turn On or Turn Off an Alias Fields: Alias Name, Alias Action, OPNsense Device, OPNsense Entity - **Toggle Interface**: Toggle, enable, or disable an interface. Requires OPNsense 26.7.6 or newer. Applies interface configuration and may disconnect Home Assistant. Fields: Interface Action, OPNsense Device, OPNsense Entity, Interface ## Troubleshooting - **Diagnostics**: Downloads a diagnostics file to attach to a bug report. - **Repair notices**: Notices it can show in Settings, Repairs: OPNsense Firmware below Minimum Version, OPNsense Firmware below Recommended Version, Replacement hardware detected ## From the README > hass-opnsense uses aiopnsense as the backend client library to integrate OPNsense with Home Assistant. > > A Discord server to discuss the integration is available. Click the Discord badge at the beginning of the page for the invite link. From the README of [travisghansen/hass-opnsense](https://github.com/travisghansen/hass-opnsense#readme), [Apache License 2.0](https://spdx.org/licenses/Apache-2.0.html). Shortened. ## At a glance - Kind: Marketplace integration - Category: [Computers and network](https://vulpo.app/integrations/category/computers-and-network.md), Routers and network - Brand: [OPNsense](https://vulpo.app/integrations/opnsense.md) - Number: 1.3k installs sharing analytics; 470 GitHub stars - Connection: Works locally - Upkeep: Updated in the last 6 months - Needs: Added as a custom repository in the Marketplace - Latest version: v1.3.0, last updated October 24, 2026 - Domain: `opnsense` - Source: - Issues: - Screenshot: https://vulpo.app/integrations-img/f108528190408e0c.webp (from travisghansen/hass-opnsense's README) - Screenshot: https://vulpo.app/integrations-img/91e1fc6afc5e8a46.webp (from travisghansen/hass-opnsense's README) In Vulpo: Quick Toggle card, Chart card, Apple Watch, Control Center ## Other ways in for OPNsense | Name | Kind | Installs or stars | Connection | Upkeep | | --- | --- | --- | --- | --- | | [OPNsense](https://vulpo.app/integrations/core/opnsense.md) | Built-in integration | 617 installs sharing analytics | Works locally | Part of Home Assistant | Independent directory, made by the developer of Vulpo. Not affiliated with Home Assistant or the Open Home Foundation. [About these numbers](https://vulpo.app/integrations/about) Last updated 2026-10-22. Source: https://vulpo.app/integrations/marketplace/travisghansen-hass-opnsense --- - HTML version of this page: https://vulpo.app/integrations/marketplace/travisghansen-hass-opnsense - Site index for agents: https://vulpo.app/llms.txt - Everything in one document: https://vulpo.app/llms-full.txt - All pages: https://vulpo.app/sitemap.xml