Files
terraform-provider-unifi/docs/resources/setting_ntp.md
Mateusz Filipowicz b9284f7758 docs: improve documentation for 1.0.0 release (#75)
* docs: add examples and recreate TF documentation

* update readme

* add information about experimental support of firewall zones
2025-03-22 19:13:16 +01:00

54 lines
2.4 KiB
Markdown

---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "unifi_setting_ntp Resource - terraform-provider-unifi"
subcategory: ""
description: |-
The unifi_setting_ntp resource allows you to configure Network Time Protocol (NTP) server settings for your UniFi network.
NTP servers provide time synchronization for your network devices. This resource supports both automatic and manual NTP configuration modes.
---
# unifi_setting_ntp (Resource)
The `unifi_setting_ntp` resource allows you to configure Network Time Protocol (NTP) server settings for your UniFi network.
NTP servers provide time synchronization for your network devices. This resource supports both automatic and manual NTP configuration modes.
## Example Usage
```terraform
resource "unifi_setting_ntp" "example" {
# Set NTP mode to manual to specify custom NTP servers
# Valid options: "auto" or "manual"
mode = "manual"
# Configure up to four NTP servers
ntp_server_1 = "time.cloudflare.com"
ntp_server_2 = "pool.ntp.org"
ntp_server_3 = "time.google.com"
ntp_server_4 = "0.pool.ntp.org"
# Specify the site (optional, defaults to site configured in provider, otherwise "default")
# site = "default"
}
```
<!-- schema generated by tfplugindocs -->
## Schema
### Optional
- `mode` (String) NTP server configuration mode. Valid values are:
* `auto` - Use NTP servers configured on the controller
* `manual` - Use custom NTP servers specified in this resource
When set to `auto`, all NTP server fields will be cleared. When set to `manual`, at least one NTP server must be specified.
- `ntp_server_1` (String) Primary NTP server hostname or IP address. Must be a valid hostname (e.g., `pool.ntp.org`) or IPv4 address. Only applicable when `mode` is set to `manual`.
- `ntp_server_2` (String) Secondary NTP server hostname or IP address. Must be a valid hostname (e.g., `time.google.com`) or IPv4 address. Only applicable when `mode` is set to `manual`.
- `ntp_server_3` (String) Tertiary NTP server hostname or IP address. Must be a valid hostname or IPv4 address. Only applicable when `mode` is set to `manual`.
- `ntp_server_4` (String) Quaternary NTP server hostname or IP address. Must be a valid hostname or IPv4 address. Only applicable when `mode` is set to `manual`.
- `site` (String) The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
### Read-Only
- `id` (String) The unique identifier of this resource.