Using WakeOnLan with Opnsense and HomeAssistant

[giscus[bot]]

Using WakeOnLan with Opnsense and HomeAssistant

Note: Significant hat tip here to /u/abstractbarista for this guide. Most of the steps below come from their guide. The main differences being 1) little bit improved layout/format (subjective) and 2) I figured out how to do a call to just wake a single device.
Introduction WakeOnLAN is one of those things that you love to hate. When it works, it’s magical. When it doesn’t it’s beyond frustrating. My biggest annoyance is with my network setup, I have multiple VLANs/subnets, and WOL doesn’t really like to be routed across subnets for reasons I only barely understand so I’m not going to try to explain.

https://blog.fuzzymistborn.com/opnsense-wol/

[BuddahsFever]

Hi Excellent bit of information.

It might be handy to include information about how to authorise properly.

The usename should be the key=string from the file downloaded when creating the API key.
The password should be the secret=string from the file downloaded when creating the API key.

That's all!. Thanks for the article!

[nickrout]

Why not just the Home Assistant built in WOL integration?

[BuddahsFever]

That will only work for devices in the same network as where Home Assistant is. WOL really does not like to be routed to another network. However OPNSense should have all networks connected and can send WOL packets to all networks.

[nickrout]

OK so they are on different subnets, good that makes sense, thanks.

[Sim0cYz]

Thank you so much!
Was using a custom integration that relies on an OPNsense plugin (os-homeassistant-maxit) hosted on mimugmail repository, that for some reasons breaks my OPNsense updates.
Now I can remove all that code and do it the clean way with the API call. Thank you again!

[J4MMlE]

Thanks for the write-up! I also had to set verify_ssl to false since my OPNsense setup uses a self-signed certificate.
Once the request is successful, you should see a log entry in OPNsense under System > Log Files > Backend similar to:
Waking up host DEVICE_IP DEVICE_MAC.
If you’d like to test the request without involving Home Assistant, you can use the following curl command:

curl -k https://OPNSENSE_URL/api/wol/wol/set \
-u "OPNSENSE_KEY":"OPNSENSE_SECRET" \
-H "Content-Type: application/json" \
-d '{"wake":{"interface": "INTERFACE","mac": "DEVICE_MAC"}}'

OPNsense will respond with: {"status":"OK"}

For completeness, here’s the rest_command I included in the configuration.yaml:

rest_command:
  wake_device:
      url: 'https://OPNSENSE_URL/api/wol/wol/set'
      method: POST
      payload: '{"wake":{"interface": "INTERFACE","mac": "DEVICE_MAC"}}'
      content_type:  'application/json'
      username: !secret opnsense_user
      password: !secret opnsense_key
      verify_ssl: false

I just realized after writing this, that you already mention the verify_ssl:false, anyways...