Pi-hole
The Pi-hole integration allows you to retrieve statistics and interact with a Pi-hole system. If your Pi-hole web interface is password protected, an API key is needed for the setup (from Settings -> API / Web interface).
Configuration
Adding Pi-hole to your Home Assistant instance can be done via the user interface, by using this My button:
If the above My button doesn’t work, you can also perform the following steps manually:
-
Browse to your Home Assistant instance.
-
In the sidebar click on Settings.
-
From the configuration menu select: Devices & Services.
-
In the bottom right, click on the Add Integration button.
-
From the list, search and select “Pi-hole”.
-
Follow the instruction on screen to complete the set up.
Services
The platform provides the following services to interact with your Pi-hole. Use switch entities when calling the services.
Service pi_hole.disable
Disables configured Pi-hole(s) for the specified amount of time.
| Service data attribute | Required | Type | Description |
|---|---|---|---|
entity_id |
False |
string | Target switch entity. Use all to target all Pi-hole services |
duration |
True |
timedelta | Time for which Pi-hole should be disabled |
Example service call:
# Example service call to disable Pi-Hole for 30 minutes
service: pi_hole.disable
data:
duration: '00:30'
target:
entity_id: all