github/terraform-provider-unifi
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: improve provider documentation (#29)

Browse Source 
* docs: improve provider documentation

* fix accidentally changed type of stormctrl_ucast_rate

* docs: add badges and plans to readme
This commit is contained in:
Mateusz Filipowicz
2025-02-26 18:56:45 +01:00
committed by GitHub
parent e5e50f98c0
commit b1688313c0
49 changed files with 2454 additions and 900 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/data-sources/network.md
View File

@@ -47,7 +47,7 @@ data "unifi_network" "my_network" {
- `dhcp_v6_dns_auto` (Boolean) Specifies DNS source to propagate. If set `false` the entries in `dhcp_v6_dns` are used, the upstream entries otherwise
- `dhcp_v6_enabled` (Boolean) Enable stateful DHCPv6 for static configuration.
- `dhcp_v6_lease` (Number) Specifies the lease time for DHCPv6 addresses.
- `dhcp_v6_start` (String) Start address of the DHCPv6 range. Used in static DHCPv6 configuration.
- `dhcp_v6_start` (String) start address of the DHCPv6 range. Used in static DHCPv6 configuration.
- `dhcp_v6_stop` (String) End address of the DHCPv6 range. Used in static DHCPv6 configuration.
- `dhcpd_boot_enabled` (Boolean) Toggles on the DHCP boot options. will be set to true if you have dhcpd_boot_filename, and dhcpd_boot_server set.
- `dhcpd_boot_filename` (String) the file to PXE boot from on the dhcpd_boot_server.
@@ -57,7 +57,7 @@ data "unifi_network" "my_network" {
- `ipv6_interface_type` (String) Specifies which type of IPv6 connection to use. Must be one of either `static`, `pd`, or `none`.
- `ipv6_pd_interface` (String) Specifies which WAN interface to use for IPv6 PD. Must be one of either `wan` or `wan2`.
- `ipv6_pd_prefixid` (String) Specifies the IPv6 Prefix ID.
- `ipv6_pd_start` (String) Start address of the DHCPv6 range. Used if `ipv6_interface_type` is set to `pd`.
- `ipv6_pd_start` (String) start address of the DHCPv6 range. Used if `ipv6_interface_type` is set to `pd`.
- `ipv6_pd_stop` (String) End address of the DHCPv6 range. Used if `ipv6_interface_type` is set to `pd`.
- `ipv6_ra_enable` (Boolean) Specifies whether to enable router advertisements or not.
- `ipv6_ra_preferred_lifetime` (Number) Lifetime in which the address can be used. Address becomes deprecated afterwards. Must be lower than or equal to `ipv6_ra_valid_lifetime`

10
docs/data-sources/port_profile.md
View File

@@ -3,12 +3,12 @@
page_title: "unifi_port_profile Data Source - terraform-provider-unifi"
subcategory: ""
description: |-
unifi_port_profile data source can be used to retrieve the ID for a port profile by name.
unifi_port_profile data source can be used to retrieve port profile configurations from your UniFi network. Port profiles define settings and behaviors for switch ports, including VLANs, PoE settings, and other port-specific configurations. This data source is particularly useful when you need to reference existing port profiles in switch port configurations.
---
# unifi_port_profile (Data Source)
`unifi_port_profile` data source can be used to retrieve the ID for a port profile by name.
`unifi_port_profile` data source can be used to retrieve port profile configurations from your UniFi network. Port profiles define settings and behaviors for switch ports, including VLANs, PoE settings, and other port-specific configurations. This data source is particularly useful when you need to reference existing port profiles in switch port configurations.
## Example Usage
@@ -22,9 +22,9 @@ data "unifi_port_profile" "all" {
### Optional
- `name` (String) The name of the port profile to look up. Defaults to `All`.
- `site` (String) The name of the site the port profile is associated with.
- `name` (String) The name of the port profile to look up. This is the friendly name assigned to the profile in the UniFi controller. Defaults to "All" if not specified, which is the default port profile in UniFi. Defaults to `All`.
- `site` (String) The name of the UniFi site where the port profile is configured. If not specified, the default site will be used.
### Read-Only
- `id` (String) The ID of this port profile.
- `id` (String) The unique identifier of the port profile. This is automatically assigned by UniFi and can be used to reference this port profile in other resources.