Files
terraform-provider-unifi/docs/resources/dynamic_dns.md
Mateusz Filipowicz b1688313c0 docs: improve provider documentation (#29)
* docs: improve provider documentation

* fix accidentally changed type of stormctrl_ucast_rate

* docs: add badges and plans to readme
2025-02-26 18:56:45 +01:00

2.7 KiB

page_title, subcategory, description
page_title subcategory description
unifi_dynamic_dns Resource - terraform-provider-unifi The unifi_dynamic_dns resource manages Dynamic DNS (DDNS). Dynamic DNS allows you to access your network using a domain name even when your public IP address changes. This is useful for: Remote access to your networkHosting services from your home/office networkVPN connections to your network The resource supports various DDNS providers including: DynDNSNo-IPDuck DNSAnd many others Each DDNS configuration can be associated with either the primary (WAN) or secondary (WAN2) interface.

unifi_dynamic_dns (Resource)

The unifi_dynamic_dns resource manages Dynamic DNS (DDNS).

Dynamic DNS allows you to access your network using a domain name even when your public IP address changes. This is useful for:

  • Remote access to your network
  • Hosting services from your home/office network
  • VPN connections to your network

The resource supports various DDNS providers including:

  • DynDNS
  • No-IP
  • Duck DNS
  • And many others

Each DDNS configuration can be associated with either the primary (WAN) or secondary (WAN2) interface.

Example Usage

resource "unifi_dynamic_dns" "test" {
  service = "dyndns"

  host_name = "my-network.example.com"

  server   = "domains.google.com"
  login    = var.dns_login
  password = var.dns_password
}

Schema

Required

  • host_name (String) The fully qualified domain name to update with your current public IP address (e.g., 'myhouse.dyndns.org' or 'myoffice.no-ip.com').
  • service (String) The Dynamic DNS service provider. Common values include:
    • dyndns - DynDNS service
    • noip - No-IP service
    • duckdns - Duck DNS service Check your UniFi controller for the complete list of supported providers.

Optional

  • interface (String) The WAN interface to use for the dynamic DNS updates. Valid values are:
    • wan - Primary WAN interface (default)
    • wan2 - Secondary WAN interface Defaults to wan.
  • login (String) The username or login for your DDNS provider account.
  • password (String, Sensitive) The password or token for your DDNS provider account. This value will be stored securely and not displayed in logs.
  • server (String) The update server hostname for your DDNS provider. Usually not required as the UniFi controller knows the correct servers for common providers.
  • site (String) The name of the UniFi site where the dynamic DNS configuration should be created. If not specified, the default site will be used.

Read-Only

  • id (String) The unique identifier of the dynamic DNS configuration in the UniFi controller.