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-14 21:06:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update dnsip for config flow support (#20882)

Browse Source 
Co-authored-by: J. Nick Koston <nick@koston.org>
This commit is contained in:
G Johansson 2022-01-20 22:09:09 +01:00 committed by GitHub
parent db8fbc43f7
commit 2a57a9d411
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
source/_integrations/dnsip.markdown
View File

@ -4,72 +4,18 @@ description: Instructions on how to integrate a DNS IP sensor into Home Assistan
ha_category:
- Network
ha_iot_class: Cloud Polling
ha_config_flow: true
ha_release: '0.40'
ha_domain: dnsip
ha_platforms:
- sensor
---
The `dnsip` sensor will expose an IP address, fetched via DNS resolution, as its value. There are two operational modes:
The `dnsip` sensor will expose an IP address, fetched via DNS resolution, as its value. It provides both IPv4 and IPv6 lookup as separate sensors depending on accessibility to resolvers.
1. When you enable the sensor with minimal configuration, it will query the [OpenDNS](https://www.opendns.com/) nameservers with the hostname `myip.opendns.com`, which will resolve to your external/public IP address.
1. When you enable the sensor with the default value, it will query the [OpenDNS](https://www.opendns.com/) nameservers with the hostname `myip.opendns.com`, which will resolve to your external/public IP address.
2. If you specify a `hostname`, a regular DNS lookup will be performed, providing you the IP the hostname resolves to.
You may also override the nameserver that is being used by setting the `resolver` parameter to any nameserver you like.
You may also override the default nameservers that are being used by setting the `resolver` option in the integration to any nameserver you like.
## Configuration
To enable this sensor, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: dnsip
```
{% configuration %}
hostname:
description: The hostname for which to perform the DNS query.
required: false
default: "`myip.opendns.com` (special hostname that resolves to your public IP)"
type: string
name:
description: Name of the sensor.
required: false
default: "`myip` or hostname without dots if specified"
type: string
resolver:
description: The DNS server to target the query at.
required: false
default: "`208.67.222.222` (OpenDNS)"
type: string
ipv6:
description: Set this to `true` or `false` if IPv6 should be used. When resolving the public IP, this will be the IP of the machine where Home Assistant is running on.
required: false
default: false
type: boolean
resolver_ipv6:
description: The IPv6 DNS server to target the query at.
required: false
default: "`2620:0:ccc::2` (OpenDNS)"
type: string
scan_interval:
description: Defines number of seconds for polling interval.
required: false
default: "`120`"
type: integer
{% endconfiguration %}
## Extended example
```yaml
# Example configuration.yaml entry
sensor:
# Own public IPv4 address
- platform: dnsip
# Resolve IP address of home-assistant.io via Google DNS
- platform: dnsip
hostname: home-assistant.io
name: hass
resolver: 8.8.8.8
```
{% include integrations/config_flow.md %}