b9284f7758
* docs: add examples and recreate TF documentation * update readme * add information about experimental support of firewall zones
47 lines
1.7 KiB
Markdown
47 lines
1.7 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "unifi_setting_auto_speedtest Resource - terraform-provider-unifi"
|
|
subcategory: ""
|
|
description: |-
|
|
The unifi_setting_auto_speedtest resource manages the automatic speedtest settings in the UniFi controller.Automatic speedtests can be scheduled to run at regular intervals to monitor the network performance.
|
|
NOTE: Automatic speedtests where not verified and tested on all UniFi controller versions due to limitations of controller used in acceptance testing.
|
|
---
|
|
|
|
# unifi_setting_auto_speedtest (Resource)
|
|
|
|
The `unifi_setting_auto_speedtest` resource manages the automatic speedtest settings in the UniFi controller.Automatic speedtests can be scheduled to run at regular intervals to monitor the network performance.
|
|
|
|
**NOTE:** Automatic speedtests where not verified and tested on all UniFi controller versions due to limitations of controller used in acceptance testing.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
resource "unifi_setting_auto_speedtest" "example" {
|
|
# Enable automatic speedtest functionality
|
|
enabled = true
|
|
|
|
# Schedule for running speedtests using cron syntax
|
|
# This example runs at midnight every day
|
|
cron = "0 0 * * *"
|
|
|
|
# Specify the site (optional, defaults to site configured in provider, otherwise "default")
|
|
# site = "default"
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- `enabled` (Boolean) Whether the automatic speedtest is enabled.
|
|
|
|
### Optional
|
|
|
|
- `cron` (String) Cron expression defining the schedule for automatic speedtests.
|
|
- `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.
|