hass-opnsense
Join OPNsense with home-assistant!
hass-opnsense uses the built-in xmlrpc service of OPNsense for all interactions. This project is currently a proof-of-concept and may fail to work at any time.
Initial development was done againt OPNsense 21.7 and home-assistant 2021.10.
installation
This integration currenlty replaces the built-in opnsense integration which only provides device_tracker functionality, be sure to remove any associated configuration for the built-in integration before installing this replacement.
To use the integration you must first login to the console of your filewall and execute the following:
sh
cat << 'EOF' > /usr/local/etc/inc/xmlrpc/hass.inc
<?php
function xmlrpc_publishable_hass()
{
return array(
"exec_php_xmlrpc",
"exec_shell_xmlrpc"
);
}
function exec_php_xmlrpc($code)
{
eval($code);
if ($toreturn)
{
return $toreturn;
}
return true;
}
function exec_shell_xmlrpc($code)
{
mwexec($code);
return true;
}
EOF
chown root:wheel /usr/local/etc/inc/xmlrpc/hass.inc
chmod 644 /usr/local/etc/inc/xmlrpc/hass.inc
Add the repo to your hacs installation or clone the directory manually. Once the integration is installed be sure to restart hass and refresh the UI in the browser.
configuration
Configuration is managed entirely from the UI using config_flow semantics. Simply go to Configuration -> Integrations -> Add Integration and search for OPNsense in the search box.
OPNsense
System -> Advanced -> Max Processes- set it 5 or more.- If using a non
adminuser account ensure the user has theSystem - HA node syncprivilege. Note that this privilege effectively gives the user complete access to the system via thexmlrpcfeature.
config
URL- put the full URL to yourOPNsenseUI (ie:https://192.168.1.1), supported format is<scheme>://<ip or host>[:<port>]Verify SSL Certificate- if the SSL certificate should be verified or not (if you get an SSL error try unchecking this)username- the username to use for authentication (ie:root)password- the password to use for authenticationFirewall Name- a custom name to be used forentitynaming (default: use theOPNsensehostname)
options
Scan Interval (seconds)- scan interval to use for state polling (default:30)Enable Device Tracker- turn on the device tracker integration usingOPNsensearp table (default:false)Device Tracker Scan Interval (seconds)- scan interval to use for arp updates (default:60)
entities
Many entities are created by hass-opnsense for stats etc. Due to to volume of entities many are disabled by default. If something is missing be sure to review the disabled entities as what you're looking for is probably there.
binary_sensor
- carp status (enabled/disabled)
- system notices present (the bell icon in the upper right of the UI)
device_tracker
ScannerEntity entries are created for the OPNsense arp table. Disabled by default. Not only is the feature disabled by default but created entities are currently disabled by default as well. Search the disabled entity list for the relevant mac addresses and enable as desired.
Note that by default FreeBSD/OPNsense use a max age of 20 minutes for arp entries (sysctl net.link.ether.inet.max_age). You may lower that using System -> Advanced -> System Tunables if desired.
sensor
- system details (name, version,
temp, boottime, etc) - pfstate details (used, max, etc)
- cpu details (average load, frequency, etc)
- mbuf details
- memory details
- filesystem usage
- interface details (status, stats, pps, kbs (time samples are based on the
Scan Interval (seconds)config option)) - gateways details (status, delay, stddev, loss)
- carp interface status
dhcp stats (total, online, and offline clients)
switch
All of the switches below are disabled by default.
- filter rules - enable/disable rules
- nat port forward rules - enable/disable rules
- nat outbound rules - enable/disable rules
- services - start/stop services (note that services must be enabled before they can be started)
services
service: opnsense.close_notice
data:
entity_id: binary_sensor.opnsense_localdomain_pending_notices_present
# default is to clear all notices
# id: <some id>
service: opnsense.file_notice
data:
entity_id: binary_sensor.opnsense_localdomain_pending_notices_present
notice: "hello world"
service: opnsense.system_halt
data:
entity_id: binary_sensor.opnsense_localdomain_pending_notices_present
service: opnsense.system_reboot
data:
entity_id: binary_sensor.opnsense_localdomain_pending_notices_present
service: opnsense.start_service
data:
entity_id: binary_sensor.opnsense_localdomain_pending_notices_present
service_name: "dpinger"
service: opnsense.stop_service
data:
entity_id: binary_sensor.opnsense_localdomain_pending_notices_present
service_name: "dpinger"
service: opnsense.restart_service
data:
entity_id: binary_sensor.opnsense_localdomain_pending_notices_present
service_name: "dpinger"
# only_if_running: false
service: opnsense.send_wol
data:
entity_id: binary_sensor.opnsense_localdomain_pending_notices_present
interface: lan
mac: "B9:7B:A6:46:B3:8B"
![Unable to connect error code is [%key:common::config_flow::error::cannot_connect%]](https://avatars.githubusercontent.com/u/72599189?v=4)
![Feature Request] Add support for the](https://avatars.githubusercontent.com/u/24661585?v=4)
12 Dec 27, 2022
7 Dec 07, 2021
2 Jan 01, 2022
2 Jan 02, 2023
4 Jan 19, 2022
4 Jul 31, 2021
6 Dec 06, 2022
21 Dec 29, 2022
3 Sep 19, 2022
3 Dec 08, 2021
3 Jul 29, 2022
23 Dec 18, 2022
7 Dec 15, 2022
1 Jun 05, 2022
3 Oct 08, 2022
3 Dec 10, 2022
2 Feb 04, 2022
312 Jan 07, 2023
58 Dec 27, 2022
5 Jan 01, 2023