Home Assistant

OPNSense

OPNsense is an open source FreeBSD based firewall and routing platform. There is currently support for the following device types within Home Assistant:

Configuration

To configure OPNsense integration with Home Assistant add the following section to your configuration.yaml:

opnsense:
  url: https://router/api
  api_secret: API_SECRET
  api_key: API_KEY

Where the api_key and api_secret values are acquired from your OPNsense router using the web interface. For more information on this procedure, refer to the OPNsense documentation.

User with API Key requires privileges for Type:

  • GUI Name: Diagnostics: ARP Table
  • GUI Name: Diagnostics: Network Insight

Configuration Variables

Looking for your configuration file?
url string Required

The URL for the OPNsense API endpoint of your router.

api_key string Required

The API key used to authenticate with your OPNsense API endpoint.

api_secret string Required

The API secret used to authenticate with your OPNsense API endpoint.

verify_ssl boolean (Optional, default: false)

Set to true to enable the validation of the OPNsense API SSL.

tracker_interfaces list (Optional, default: [])

List of the OPNsense router’s interfaces to use for tracking devices.

Presence detection

This platform allows you to detect presence by looking at devices connected to an OPNsense router.