jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-27 03:07:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update pihole docs to describe services (#10485)

Browse Source 
* Update pihole docs to describe services

* ✏️ Tweaks
This commit is contained in:
John Luetke 2019-09-30 05:22:48 -07:00 committed by Franck Nijhof
parent 26d1f36c00
commit 4702acb88d
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
source/_components/pi_hole.markdown
View File

@ -47,6 +47,11 @@ verify_ssl:
required: false
type: boolean
default: true
api_key:
description: API Key for interacting with the Pi-hole. This is not required if you want to just query the Pi-hole for usage statistics.
required: false
type: string
default: None
{% endconfiguration %}
### Full example
@ -59,4 +64,24 @@ pi_hole:
verify_ssl: false
```
## Services
The platform provides the following services to interact with your Pi-hole.
### Service `pi_hole.disable`
Disable your Pi-hole for the specified amount of time.
| Service data attribute | Required | Type | Description |
| ---------------------- | -------- | -------- | ----------- |
| `duration` | `True` | timedelta | Time for which Pi-hole should be disabled |
_Note: This service requires `api_key` to be specified in the configuration._
### Service `pi.hole_enable`
Enable your Pi-hole.
_Note: This service requires `api_key` to be specified in the configuration._
This integration was not made by Pi-hole LLC or the Pi-hole community. They did not provide support, feedback, testing, or any other help during its creation. This is a third party platform which may break if Pi-hole changes their API in a later release. It is not official, not developed, not supported, and not endorsed Pi-hole LLC or the Pi-hole community. The trademark `Pi-hole` and the logo is used here to describe the platform. `Pi-hole` is a registered trademark of Pi-hole LLC.