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

Updates for controller v7.1 and dependency updates

Browse Source
This commit is contained in:
Paul Tyng
2022-07-02 22:02:22 -04:00
committed by GitHub
parent 8728d6b5e8
commit d02c97bd55
29 changed files with 431 additions and 385 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/data-sources/ap_group.md
View File

@@ -22,11 +22,11 @@ data "unifi_ap_group" "default" {
### Optional
- **name** (String) The name of the AP group to look up, leave blank to look up the default AP group.
- **site** (String) The name of the site the AP group is associated with.
- `name` (String) The name of the AP group to look up, leave blank to look up the default AP group.
- `site` (String) The name of the site the AP group is associated with.
### Read-Only
- **id** (String) The ID of this AP group.
- `id` (String) The ID of this AP group.

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

@@ -15,7 +15,7 @@ description: |-
```terraform
#retrieve network data by unifi network name
data "unifi_network" "lan_network" {
name = "LAN"
name = "Default"
}
#retrieve network data from user record
@@ -32,39 +32,39 @@ data "unifi_network" "my_network" {
### Optional
- **id** (String) The ID of the network.
- **name** (String) The name of the network.
- **site** (String) The name of the site to associate the network with.
- `id` (String) The ID of the network.
- `name` (String) The name of the network.
- `site` (String) The name of the site to associate the network with.
### Read-Only
- **dhcp_dns** (List of String) IPv4 addresses for the DNS server to be returned from the DHCP server.
- **dhcp_enabled** (Boolean) whether DHCP is enabled or not on this network.
- **dhcp_lease** (Number) lease time for DHCP addresses.
- **dhcp_start** (String) The IPv4 address where the DHCP range of addresses starts.
- **dhcp_stop** (String) The IPv4 address where the DHCP range of addresses stops.
- **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.
- **dhcpd_boot_server** (String) IPv4 address of a TFTP server to network boot from.
- **domain_name** (String) The domain name of this network.
- **igmp_snooping** (Boolean) Specifies whether IGMP snooping is enabled or not.
- **ipv6_interface_type** (String) Specifies which type of IPv6 connection to use.
- **ipv6_pd_interface** (String) Specifies which WAN interface is used for IPv6 Prefix Delegation.
- **ipv6_pd_prefixid** (String) Specifies the IPv6 Prefix ID.
- **ipv6_ra_enable** (Boolean) Specifies whether to enable router advertisements or not.
- **ipv6_static_subnet** (String) Specifies the static IPv6 subnet (when ipv6_interface_type is 'static').
- **network_group** (String) The group of the network.
- **purpose** (String) The purpose of the network. One of `corporate`, `guest`, `wan`, or `vlan-only`.
- **subnet** (String) The subnet of the network (CIDR address).
- **vlan_id** (Number) The VLAN ID of the network.
- **wan_dns** (List of String) DNS servers IPs of the WAN.
- **wan_egress_qos** (Number) Specifies the WAN egress quality of service.
- **wan_gateway** (String) The IPv4 gateway of the WAN.
- **wan_ip** (String) The IPv4 address of the WAN.
- **wan_netmask** (String) The IPv4 netmask of the WAN.
- **wan_networkgroup** (String) Specifies the WAN network group. One of either `WAN`, `WAN2` or `WAN_LTE_FAILOVER`.
- **wan_type** (String) Specifies the IPV4 WAN connection type. One of either `disabled`, `static`, `dhcp`, or `pppoe`.
- **wan_username** (String) Specifies the IPV4 WAN username.
- **x_wan_password** (String) Specifies the IPV4 WAN password.
- `dhcp_dns` (List of String) IPv4 addresses for the DNS server to be returned from the DHCP server.
- `dhcp_enabled` (Boolean) whether DHCP is enabled or not on this network.
- `dhcp_lease` (Number) lease time for DHCP addresses.
- `dhcp_start` (String) The IPv4 address where the DHCP range of addresses starts.
- `dhcp_stop` (String) The IPv4 address where the DHCP range of addresses stops.
- `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.
- `dhcpd_boot_server` (String) IPv4 address of a TFTP server to network boot from.
- `domain_name` (String) The domain name of this network.
- `igmp_snooping` (Boolean) Specifies whether IGMP snooping is enabled or not.
- `ipv6_interface_type` (String) Specifies which type of IPv6 connection to use.
- `ipv6_pd_interface` (String) Specifies which WAN interface is used for IPv6 Prefix Delegation.
- `ipv6_pd_prefixid` (String) Specifies the IPv6 Prefix ID.
- `ipv6_ra_enable` (Boolean) Specifies whether to enable router advertisements or not.
- `ipv6_static_subnet` (String) Specifies the static IPv6 subnet (when ipv6_interface_type is 'static').
- `network_group` (String) The group of the network.
- `purpose` (String) The purpose of the network. One of `corporate`, `guest`, `wan`, or `vlan-only`.
- `subnet` (String) The subnet of the network (CIDR address).
- `vlan_id` (Number) The VLAN ID of the network.
- `wan_dns` (List of String) DNS servers IPs of the WAN.
- `wan_egress_qos` (Number) Specifies the WAN egress quality of service.
- `wan_gateway` (String) The IPv4 gateway of the WAN.
- `wan_ip` (String) The IPv4 address of the WAN.
- `wan_netmask` (String) The IPv4 netmask of the WAN.
- `wan_networkgroup` (String) Specifies the WAN network group. One of either `WAN`, `WAN2` or `WAN_LTE_FAILOVER`.
- `wan_type` (String) Specifies the IPV4 WAN connection type. One of either `disabled`, `static`, `dhcp`, or `pppoe`.
- `wan_username` (String) Specifies the IPV4 WAN username.
- `x_wan_password` (String) Specifies the IPV4 WAN password.

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

@@ -22,11 +22,11 @@ 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. Defaults to `All`.
- `site` (String) The name of the site the port profile is associated with.
### Read-Only
- **id** (String) The ID of this port profile.
- `id` (String) The ID of this port profile.

6
docs/data-sources/radius_profile.md
View File

@@ -17,11 +17,11 @@ description: |-
### Optional
- **name** (String) The name of the RADIUS profile to look up. Defaults to `Default`.
- **site** (String) The name of the site the radius profile is associated with.
- `name` (String) The name of the RADIUS profile to look up. Defaults to `Default`.
- `site` (String) The name of the site the radius profile is associated with.
### Read-Only
- **id** (String) The ID of this AP group.
- `id` (String) The ID of this AP group.

24
docs/data-sources/user.md
View File

@@ -23,23 +23,23 @@ data "unifi_user" "client" {
### Required
- **mac** (String) The MAC address of the user.
- `mac` (String) The MAC address of the user.
### Optional
- **site** (String) The name of the site the user is associated with.
- `site` (String) The name of the site the user is associated with.
### Read-Only
- **blocked** (Boolean) Specifies whether this user should be blocked from the network.
- **dev_id_override** (Number) Override the device fingerprint.
- **fixed_ip** (String) fixed IPv4 address set for this user.
- **hostname** (String) The hostname of the user.
- **id** (String) The ID of the user.
- **ip** (String) The IP address of the user.
- **name** (String) The name of the user.
- **network_id** (String) The network ID for this user.
- **note** (String) A note with additional information for the user.
- **user_group_id** (String) The user group ID for the user.
- `blocked` (Boolean) Specifies whether this user should be blocked from the network.
- `dev_id_override` (Number) Override the device fingerprint.
- `fixed_ip` (String) fixed IPv4 address set for this user.
- `hostname` (String) The hostname of the user.
- `id` (String) The ID of the user.
- `ip` (String) The IP address of the user.
- `name` (String) The name of the user.
- `network_id` (String) The network ID for this user.
- `note` (String) A note with additional information for the user.
- `user_group_id` (String) The user group ID for the user.

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

@@ -17,13 +17,13 @@ description: |-
### Optional
- **name** (String) The name of the user group to look up. Defaults to `Default`.
- **site** (String) The name of the site the user group is associated with.
- `name` (String) The name of the user group to look up. Defaults to `Default`.
- `site` (String) The name of the site the user group is associated with.
### Read-Only
- **id** (String) The ID of this AP group.
- **qos_rate_max_down** (Number)
- **qos_rate_max_up** (Number)
- `id` (String) The ID of this AP group.
- `qos_rate_max_down` (Number)
- `qos_rate_max_up` (Number)

10
docs/index.md
View File

@@ -35,8 +35,8 @@ provider "unifi" {
### Optional
- **allow_insecure** (Boolean) Skip verification of TLS certificates of API requests. You may need to set this to `true` if you are using your local API without setting up a signed certificate. Can be specified with the `UNIFI_INSECURE` environment variable.
- **api_url** (String) URL of the controller API. Can be specified with the `UNIFI_API` environment variable. You should **NOT** supply the path (`/api`), the SDK will discover the appropriate paths. This is to support UDM Pro style API paths as well as more standard controller paths.
- **password** (String) Password for the user accessing the API. Can be specified with the `UNIFI_PASSWORD` environment variable.
- **site** (String) The site in the Unifi controller this provider will manage. Can be specified with the `UNIFI_SITE` environment variable. Default: `default`
- **username** (String) Local user name for the Unifi controller API. Can be specified with the `UNIFI_USERNAME` environment variable.
- `allow_insecure` (Boolean) Skip verification of TLS certificates of API requests. You may need to set this to `true` if you are using your local API without setting up a signed certificate. Can be specified with the `UNIFI_INSECURE` environment variable.
- `api_url` (String) URL of the controller API. Can be specified with the `UNIFI_API` environment variable. You should **NOT** supply the path (`/api`), the SDK will discover the appropriate paths. This is to support UDM Pro style API paths as well as more standard controller paths.
- `password` (String) Password for the user accessing the API. Can be specified with the `UNIFI_PASSWORD` environment variable.
- `site` (String) The site in the Unifi controller this provider will manage. Can be specified with the `UNIFI_SITE` environment variable. Default: `default`
- `username` (String) Local user name for the Unifi controller API. Can be specified with the `UNIFI_USERNAME` environment variable.

18
docs/resources/device.md
View File

@@ -59,26 +59,26 @@ resource "unifi_device" "us_24_poe" {
### Optional
- **mac** (String) The MAC address of the device. This can be specified so that the provider can take control of a device (since devices are created through adoption).
- **name** (String) The name of the device.
- **port_override** (Block Set) Settings overrides for specific switch ports. (see [below for nested schema](#nestedblock--port_override))
- **site** (String) The name of the site to associate the device with.
- `mac` (String) The MAC address of the device. This can be specified so that the provider can take control of a device (since devices are created through adoption).
- `name` (String) The name of the device.
- `port_override` (Block Set) Settings overrides for specific switch ports. (see [below for nested schema](#nestedblock--port_override))
- `site` (String) The name of the site to associate the device with.
### Read-Only
- **disabled** (Boolean) Specifies whether this device should be disabled.
- **id** (String) The ID of the device.
- `disabled` (Boolean) Specifies whether this device should be disabled.
- `id` (String) The ID of the device.
<a id="nestedblock--port_override"></a>
### Nested Schema for `port_override`
Required:
- **number** (Number) Switch port number.
- `number` (Number) Switch port number.
Optional:
- **name** (String) Human-readable name of the port.
- **port_profile_id** (String) ID of the Port Profile used on this port.
- `name` (String) Human-readable name of the port.
- `port_profile_id` (String) ID of the Port Profile used on this port.

16
docs/resources/dynamic_dns.md
View File

@@ -29,19 +29,19 @@ resource "unifi_dynamic_dns" "test" {
### Required
- **host_name** (String) The host name to update in the dynamic DNS service.
- **service** (String) The Dynamic DNS service provider, various values are supported (for example `dyndns`, etc.).
- `host_name` (String) The host name to update in the dynamic DNS service.
- `service` (String) The Dynamic DNS service provider, various values are supported (for example `dyndns`, etc.).
### Optional
- **interface** (String) The interface for the dynamic DNS. Can be `wan` or `wan2`. Defaults to `wan`.
- **login** (String) The server for the dynamic DNS service.
- **password** (String, Sensitive) The server for the dynamic DNS service.
- **server** (String) The server for the dynamic DNS service.
- **site** (String) The name of the site to associate the dynamic DNS with.
- `interface` (String) The interface for the dynamic DNS. Can be `wan` or `wan2`. Defaults to `wan`.
- `login` (String) The server for the dynamic DNS service.
- `password` (String, Sensitive) The server for the dynamic DNS service.
- `server` (String) The server for the dynamic DNS service.
- `site` (String) The name of the site to associate the dynamic DNS with.
### Read-Only
- **id** (String) The ID of the dynamic DNS.
- `id` (String) The ID of the dynamic DNS.

10
docs/resources/firewall_group.md
View File

@@ -30,16 +30,16 @@ resource "unifi_firewall_group" "can_print" {
### Required
- **members** (Set of String) The members of the firewall group.
- **name** (String) The name of the firewall group.
- **type** (String) The type of the firewall group. Must be one of: `address-group`, `port-group`, or `ipv6-address-group`.
- `members` (Set of String) The members of the firewall group.
- `name` (String) The name of the firewall group.
- `type` (String) The type of the firewall group. Must be one of: `address-group`, `port-group`, or `ipv6-address-group`.
### Optional
- **site** (String) The name of the site to associate the firewall group with.
- `site` (String) The name of the site to associate the firewall group with.
### Read-Only
- **id** (String) The ID of the firewall group.
- `id` (String) The ID of the firewall group.

48
docs/resources/firewall_rule.md
View File

@@ -35,36 +35,36 @@ resource "unifi_firewall_rule" "drop_all" {
### Required
- **action** (String) The action of the firewall rule. Must be one of `drop`, `accept`, or `reject`.
- **name** (String) The name of the firewall rule.
- **protocol** (String) The protocol of the rule.
- **rule_index** (Number) The index of the rule. Must be >= 2000 < 3000 or >= 4000 < 5000.
- **ruleset** (String) The ruleset for the rule. This is from the perspective of the security gateway. Must be one of `WAN_IN`, `WAN_OUT`, `WAN_LOCAL`, `LAN_IN`, `LAN_OUT`, `LAN_LOCAL`, `GUEST_IN`, `GUEST_OUT`, `GUEST_LOCAL`, `WANv6_IN`, `WANv6_OUT`, `WANv6_LOCAL`, `LANv6_IN`, `LANv6_OUT`, `LANv6_LOCAL`, `GUESTv6_IN`, `GUESTv6_OUT`, or `GUESTv6_LOCAL`.
- `action` (String) The action of the firewall rule. Must be one of `drop`, `accept`, or `reject`.
- `name` (String) The name of the firewall rule.
- `protocol` (String) The protocol of the rule.
- `rule_index` (Number) The index of the rule. Must be >= 2000 < 3000 or >= 4000 < 5000.
- `ruleset` (String) The ruleset for the rule. This is from the perspective of the security gateway. Must be one of `WAN_IN`, `WAN_OUT`, `WAN_LOCAL`, `LAN_IN`, `LAN_OUT`, `LAN_LOCAL`, `GUEST_IN`, `GUEST_OUT`, `GUEST_LOCAL`, `WANv6_IN`, `WANv6_OUT`, `WANv6_LOCAL`, `LANv6_IN`, `LANv6_OUT`, `LANv6_LOCAL`, `GUESTv6_IN`, `GUESTv6_OUT`, or `GUESTv6_LOCAL`.
### Optional
- **dst_address** (String) The destination address of the firewall rule.
- **dst_firewall_group_ids** (Set of String) The destination firewall group IDs of the firewall rule.
- **dst_network_id** (String) The destination network ID of the firewall rule.
- **dst_network_type** (String) The destination network type of the firewall rule. Can be one of `ADDRv4` or `NETv4`. Defaults to `NETv4`.
- **dst_port** (String) The destination port of the firewall rule.
- **icmp_typename** (String) ICMP type name.
- **ip_sec** (String) Specify whether the rule matches on IPsec packets. Can be one of `match-ipset` or `match-none`.
- **logging** (Boolean) Enable logging for the firewall rule.
- **site** (String) The name of the site to associate the firewall rule with.
- **src_address** (String) The source address for the firewall rule.
- **src_firewall_group_ids** (Set of String) The source firewall group IDs for the firewall rule.
- **src_mac** (String) The source MAC address of the firewall rule.
- **src_network_id** (String) The source network ID for the firewall rule.
- **src_network_type** (String) The source network type of the firewall rule. Can be one of `ADDRv4` or `NETv4`. Defaults to `NETv4`.
- **state_established** (Boolean) Match where the state is established.
- **state_invalid** (Boolean) Match where the state is invalid.
- **state_new** (Boolean) Match where the state is new.
- **state_related** (Boolean) Match where the state is related.
- `dst_address` (String) The destination address of the firewall rule.
- `dst_firewall_group_ids` (Set of String) The destination firewall group IDs of the firewall rule.
- `dst_network_id` (String) The destination network ID of the firewall rule.
- `dst_network_type` (String) The destination network type of the firewall rule. Can be one of `ADDRv4` or `NETv4`. Defaults to `NETv4`.
- `dst_port` (String) The destination port of the firewall rule.
- `icmp_typename` (String) ICMP type name.
- `ip_sec` (String) Specify whether the rule matches on IPsec packets. Can be one of `match-ipset` or `match-none`.
- `logging` (Boolean) Enable logging for the firewall rule.
- `site` (String) The name of the site to associate the firewall rule with.
- `src_address` (String) The source address for the firewall rule.
- `src_firewall_group_ids` (Set of String) The source firewall group IDs for the firewall rule.
- `src_mac` (String) The source MAC address of the firewall rule.
- `src_network_id` (String) The source network ID for the firewall rule.
- `src_network_type` (String) The source network type of the firewall rule. Can be one of `ADDRv4` or `NETv4`. Defaults to `NETv4`.
- `state_established` (Boolean) Match where the state is established.
- `state_invalid` (Boolean) Match where the state is invalid.
- `state_new` (Boolean) Match where the state is new.
- `state_related` (Boolean) Match where the state is related.
### Read-Only
- **id** (String) The ID of the firewall rule.
- `id` (String) The ID of the firewall rule.
## Import

64
docs/resources/network.md
View File

@@ -46,44 +46,44 @@ resource "unifi_network" "wan" {
### Required
- **name** (String) The name of the network.
- **purpose** (String) The purpose of the network. Must be one of `corporate`, `guest`, `wan`, or `vlan-only`.
- `name` (String) The name of the network.
- `purpose` (String) The purpose of the network. Must be one of `corporate`, `guest`, `wan`, or `vlan-only`.
### Optional
- **dhcp_dns** (List of String) Specifies the IPv4 addresses for the DNS server to be returned from the DHCP server. Leave blank to disable this feature.
- **dhcp_enabled** (Boolean) Specifies whether DHCP is enabled or not on this network.
- **dhcp_lease** (Number) Specifies the lease time for DHCP addresses. Defaults to `86400`.
- **dhcp_relay_enabled** (Boolean) Specifies whether DHCP relay is enabled or not on this network.
- **dhcp_start** (String) The IPv4 address where the DHCP range of addresses starts.
- **dhcp_stop** (String) The IPv4 address where the DHCP range of addresses stops.
- **dhcpd_boot_enabled** (Boolean) Toggles on the DHCP boot options. Should be set to true when you want to have dhcpd_boot_filename, and dhcpd_boot_server to take effect.
- **dhcpd_boot_filename** (String) Specifies the file to PXE boot from on the dhcpd_boot_server.
- **dhcpd_boot_server** (String) Specifies the IPv4 address of a TFTP server to network boot from.
- **domain_name** (String) The domain name of this network.
- **igmp_snooping** (Boolean) Specifies whether IGMP snooping is enabled or not.
- **ipv6_interface_type** (String) Specifies which type of IPv6 connection to use. Defaults to `none`.
- **ipv6_pd_interface** (String) Specifies which WAN interface to use for IPv6 PD.
- **ipv6_pd_prefixid** (String) Specifies the IPv6 Prefix ID.
- **ipv6_ra_enable** (Boolean) Specifies whether to enable router advertisements or not.
- **ipv6_static_subnet** (String) Specifies the static IPv6 subnet when ipv6_interface_type is 'static'.
- **network_group** (String) The group of the network. Defaults to `LAN`.
- **site** (String) The name of the site to associate the network with.
- **subnet** (String) The subnet of the network. Must be a valid CIDR address.
- **vlan_id** (Number) The VLAN ID of the network.
- **wan_dns** (List of String) DNS servers IPs of the WAN.
- **wan_egress_qos** (Number) Specifies the WAN egress quality of service. Defaults to `0`.
- **wan_gateway** (String) The IPv4 gateway of the WAN.
- **wan_ip** (String) The IPv4 address of the WAN.
- **wan_netmask** (String) The IPv4 netmask of the WAN.
- **wan_networkgroup** (String) Specifies the WAN network group. Must be one of either `WAN`, `WAN2` or `WAN_LTE_FAILOVER`.
- **wan_type** (String) Specifies the IPV4 WAN connection type. Must be one of either `disabled`, `static`, `dhcp`, or `pppoe`.
- **wan_username** (String) Specifies the IPV4 WAN username.
- **x_wan_password** (String) Specifies the IPV4 WAN password.
- `dhcp_dns` (List of String) Specifies the IPv4 addresses for the DNS server to be returned from the DHCP server. Leave blank to disable this feature.
- `dhcp_enabled` (Boolean) Specifies whether DHCP is enabled or not on this network.
- `dhcp_lease` (Number) Specifies the lease time for DHCP addresses. Defaults to `86400`.
- `dhcp_relay_enabled` (Boolean) Specifies whether DHCP relay is enabled or not on this network.
- `dhcp_start` (String) The IPv4 address where the DHCP range of addresses starts.
- `dhcp_stop` (String) The IPv4 address where the DHCP range of addresses stops.
- `dhcpd_boot_enabled` (Boolean) Toggles on the DHCP boot options. Should be set to true when you want to have dhcpd_boot_filename, and dhcpd_boot_server to take effect.
- `dhcpd_boot_filename` (String) Specifies the file to PXE boot from on the dhcpd_boot_server.
- `dhcpd_boot_server` (String) Specifies the IPv4 address of a TFTP server to network boot from.
- `domain_name` (String) The domain name of this network.
- `igmp_snooping` (Boolean) Specifies whether IGMP snooping is enabled or not.
- `ipv6_interface_type` (String) Specifies which type of IPv6 connection to use. Defaults to `none`.
- `ipv6_pd_interface` (String) Specifies which WAN interface to use for IPv6 PD.
- `ipv6_pd_prefixid` (String) Specifies the IPv6 Prefix ID.
- `ipv6_ra_enable` (Boolean) Specifies whether to enable router advertisements or not.
- `ipv6_static_subnet` (String) Specifies the static IPv6 subnet when ipv6_interface_type is 'static'.
- `network_group` (String) The group of the network. Defaults to `LAN`.
- `site` (String) The name of the site to associate the network with.
- `subnet` (String) The subnet of the network. Must be a valid CIDR address.
- `vlan_id` (Number) The VLAN ID of the network.
- `wan_dns` (List of String) DNS servers IPs of the WAN.
- `wan_egress_qos` (Number) Specifies the WAN egress quality of service. Defaults to `0`.
- `wan_gateway` (String) The IPv4 gateway of the WAN.
- `wan_ip` (String) The IPv4 address of the WAN.
- `wan_netmask` (String) The IPv4 netmask of the WAN.
- `wan_networkgroup` (String) Specifies the WAN network group. Must be one of either `WAN`, `WAN2` or `WAN_LTE_FAILOVER`.
- `wan_type` (String) Specifies the IPV4 WAN connection type. Must be one of either `disabled`, `static`, `dhcp`, or `pppoe`.
- `wan_username` (String) Specifies the IPV4 WAN username.
- `x_wan_password` (String) Specifies the IPV4 WAN password.
### Read-Only
- **id** (String) The ID of the network.
- `id` (String) The ID of the network.
## Import

22
docs/resources/port_forward.md
View File

@@ -17,19 +17,19 @@ description: |-
### Optional
- **dst_port** (String) The destination port for the forwarding.
- **enabled** (Boolean, Deprecated) Specifies whether the port forwarding rule is enabled or not. This will attribute will be removed in a future release. Instead of disabling a port forwarding rule you can remove it from your configuration.
- **fwd_ip** (String) The IPv4 address to forward traffic to.
- **fwd_port** (String) The port to forward traffic to.
- **log** (Boolean) Specifies whether to log forwarded traffic or not. Defaults to `false`.
- **name** (String) The name of the port forwarding rule.
- **port_forward_interface** (String) The port forwarding interface. Can be `wan`, `wan2`, or `both`.
- **protocol** (String) The protocol for the port forwarding rule. Can be `tcp`, `udp`, or `tcp_udp`. Defaults to `tcp_udp`.
- **site** (String) The name of the site to associate the port forwarding rule with.
- **src_ip** (String) The source IPv4 address (or CIDR) of the port forwarding rule. For all traffic, specify `any`. Defaults to `any`.
- `dst_port` (String) The destination port for the forwarding.
- `enabled` (Boolean, Deprecated) Specifies whether the port forwarding rule is enabled or not. This will attribute will be removed in a future release. Instead of disabling a port forwarding rule you can remove it from your configuration.
- `fwd_ip` (String) The IPv4 address to forward traffic to.
- `fwd_port` (String) The port to forward traffic to.
- `log` (Boolean) Specifies whether to log forwarded traffic or not. Defaults to `false`.
- `name` (String) The name of the port forwarding rule.
- `port_forward_interface` (String) The port forwarding interface. Can be `wan`, `wan2`, or `both`.
- `protocol` (String) The protocol for the port forwarding rule. Can be `tcp`, `udp`, or `tcp_udp`. Defaults to `tcp_udp`.
- `site` (String) The name of the site to associate the port forwarding rule with.
- `src_ip` (String) The source IPv4 address (or CIDR) of the port forwarding rule. For all traffic, specify `any`. Defaults to `any`.
### Read-Only
- **id** (String) The ID of the port forwarding rule.
- `id` (String) The ID of the port forwarding rule.

72
docs/resources/port_profile.md
View File

@@ -41,44 +41,44 @@ resource "unifi_port_profile" "poe_disabled" {
### Optional
- **autoneg** (Boolean) Enable link auto negotiation for the port profile. When set to `true` this overrides `speed`. Defaults to `true`.
- **dot1x_ctrl** (String) The type of 802.1X control to use. Can be `auto`, `force_authorized`, `force_unauthorized`, `mac_based` or `multi_host`. Defaults to `force_authorized`.
- **dot1x_idle_timeout** (Number) The timeout, in seconds, to use when using the MAC Based 802.1X control. Can be between 0 and 65535 Defaults to `300`.
- **egress_rate_limit_kbps** (Number) The egress rate limit, in kpbs, for the port profile. Can be between `64` and `9999999`.
- **egress_rate_limit_kbps_enabled** (Boolean) Enable egress rate limiting for the port profile. Defaults to `false`.
- **forward** (String) The type forwarding to use for the port profile. Can be `all`, `native`, `customize` or `disabled`. Defaults to `native`.
- **full_duplex** (Boolean) Enable full duplex for the port profile. Defaults to `false`.
- **isolation** (Boolean) Enable port isolation for the port profile. Defaults to `false`.
- **lldpmed_enabled** (Boolean) Enable LLDP-MED for the port profile. Defaults to `true`.
- **lldpmed_notify_enabled** (Boolean) Enable LLDP-MED topology change notifications for the port profile.
- **name** (String) The name of the port profile.
- **native_networkconf_id** (String) The ID of network to use as the main network on the port profile.
- **op_mode** (String) The operation mode for the port profile. Can only be `switch` Defaults to `switch`.
- **poe_mode** (String) The POE mode for the port profile. Can be one of `auto`, `passv24`, `passthrough` or `off`.
- **port_security_enabled** (Boolean) Enable port security for the port profile. Defaults to `false`.
- **port_security_mac_address** (Set of String) The MAC addresses associated with the port security for the port profile.
- **priority_queue1_level** (Number) The priority queue 1 level for the port profile. Can be between 0 and 100.
- **priority_queue2_level** (Number) The priority queue 2 level for the port profile. Can be between 0 and 100.
- **priority_queue3_level** (Number) The priority queue 3 level for the port profile. Can be between 0 and 100.
- **priority_queue4_level** (Number) The priority queue 4 level for the port profile. Can be between 0 and 100.
- **site** (String) The name of the site to associate the port profile with.
- **speed** (Number) The link speed to set for the port profile. Can be one of `10`, `100`, `1000`, `2500`, `5000`, `10000`, `20000`, `25000`, `40000`, `50000` or `100000`
- **stormctrl_bcast_enabled** (Boolean) Enable broadcast Storm Control for the port profile. Defaults to `false`.
- **stormctrl_bcast_level** (Number) The broadcast Storm Control level for the port profile. Can be between 0 and 100.
- **stormctrl_bcast_rate** (Number) The broadcast Storm Control rate for the port profile. Can be between 0 and 14880000.
- **stormctrl_mcast_enabled** (Boolean) Enable multicast Storm Control for the port profile. Defaults to `false`.
- **stormctrl_mcast_level** (Number) The multicast Storm Control level for the port profile. Can be between 0 and 100.
- **stormctrl_mcast_rate** (Number) The multicast Storm Control rate for the port profile. Can be between 0 and 14880000.
- **stormctrl_type** (String) The type of Storm Control to use for the port profile. Can be one of `level` or `rate`.
- **stormctrl_ucast_enabled** (Boolean) Enable unknown unicast Storm Control for the port profile. Defaults to `false`.
- **stormctrl_ucast_level** (Number) The unknown unicast Storm Control level for the port profile. Can be between 0 and 100.
- **stormctrl_ucast_rate** (Number) The unknown unicast Storm Control rate for the port profile. Can be between 0 and 14880000.
- **stp_port_mode** (Boolean) Enable spanning tree protocol on the port profile. Defaults to `true`.
- **tagged_networkconf_ids** (Set of String) The IDs of networks to tag traffic with for the port profile.
- **voice_networkconf_id** (String) The ID of network to use as the voice network on the port profile.
- `autoneg` (Boolean) Enable link auto negotiation for the port profile. When set to `true` this overrides `speed`. Defaults to `true`.
- `dot1x_ctrl` (String) The type of 802.1X control to use. Can be `auto`, `force_authorized`, `force_unauthorized`, `mac_based` or `multi_host`. Defaults to `force_authorized`.
- `dot1x_idle_timeout` (Number) The timeout, in seconds, to use when using the MAC Based 802.1X control. Can be between 0 and 65535 Defaults to `300`.
- `egress_rate_limit_kbps` (Number) The egress rate limit, in kpbs, for the port profile. Can be between `64` and `9999999`.
- `egress_rate_limit_kbps_enabled` (Boolean) Enable egress rate limiting for the port profile. Defaults to `false`.
- `forward` (String) The type forwarding to use for the port profile. Can be `all`, `native`, `customize` or `disabled`. Defaults to `native`.
- `full_duplex` (Boolean) Enable full duplex for the port profile. Defaults to `false`.
- `isolation` (Boolean) Enable port isolation for the port profile. Defaults to `false`.
- `lldpmed_enabled` (Boolean) Enable LLDP-MED for the port profile. Defaults to `true`.
- `lldpmed_notify_enabled` (Boolean) Enable LLDP-MED topology change notifications for the port profile.
- `name` (String) The name of the port profile.
- `native_networkconf_id` (String) The ID of network to use as the main network on the port profile.
- `op_mode` (String) The operation mode for the port profile. Can only be `switch` Defaults to `switch`.
- `poe_mode` (String) The POE mode for the port profile. Can be one of `auto`, `passv24`, `passthrough` or `off`.
- `port_security_enabled` (Boolean) Enable port security for the port profile. Defaults to `false`.
- `port_security_mac_address` (Set of String) The MAC addresses associated with the port security for the port profile.
- `priority_queue1_level` (Number) The priority queue 1 level for the port profile. Can be between 0 and 100.
- `priority_queue2_level` (Number) The priority queue 2 level for the port profile. Can be between 0 and 100.
- `priority_queue3_level` (Number) The priority queue 3 level for the port profile. Can be between 0 and 100.
- `priority_queue4_level` (Number) The priority queue 4 level for the port profile. Can be between 0 and 100.
- `site` (String) The name of the site to associate the port profile with.
- `speed` (Number) The link speed to set for the port profile. Can be one of `10`, `100`, `1000`, `2500`, `5000`, `10000`, `20000`, `25000`, `40000`, `50000` or `100000`
- `stormctrl_bcast_enabled` (Boolean) Enable broadcast Storm Control for the port profile. Defaults to `false`.
- `stormctrl_bcast_level` (Number) The broadcast Storm Control level for the port profile. Can be between 0 and 100.
- `stormctrl_bcast_rate` (Number) The broadcast Storm Control rate for the port profile. Can be between 0 and 14880000.
- `stormctrl_mcast_enabled` (Boolean) Enable multicast Storm Control for the port profile. Defaults to `false`.
- `stormctrl_mcast_level` (Number) The multicast Storm Control level for the port profile. Can be between 0 and 100.
- `stormctrl_mcast_rate` (Number) The multicast Storm Control rate for the port profile. Can be between 0 and 14880000.
- `stormctrl_type` (String) The type of Storm Control to use for the port profile. Can be one of `level` or `rate`.
- `stormctrl_ucast_enabled` (Boolean) Enable unknown unicast Storm Control for the port profile. Defaults to `false`.
- `stormctrl_ucast_level` (Number) The unknown unicast Storm Control level for the port profile. Can be between 0 and 100.
- `stormctrl_ucast_rate` (Number) The unknown unicast Storm Control rate for the port profile. Can be between 0 and 14880000.
- `stp_port_mode` (Boolean) Enable spanning tree protocol on the port profile. Defaults to `true`.
- `tagged_networkconf_ids` (Set of String) The IDs of networks to tag traffic with for the port profile.
- `voice_networkconf_id` (String) The ID of network to use as the voice network on the port profile.
### Read-Only
- **id** (String) The ID of the port profile.
- `id` (String) The ID of the port profile.

18
docs/resources/setting_mgmt.md
View File

@@ -28,26 +28,26 @@ resource "unifi_setting_mgmt" "example" {
### Optional
- **auto_upgrade** (Boolean) Automatically upgrade device firmware.
- **site** (String) The name of the site to associate the settings with.
- **ssh_enabled** (Boolean) Enable SSH authentication.
- **ssh_key** (Block Set) SSH key. (see [below for nested schema](#nestedblock--ssh_key))
- `auto_upgrade` (Boolean) Automatically upgrade device firmware.
- `site` (String) The name of the site to associate the settings with.
- `ssh_enabled` (Boolean) Enable SSH authentication.
- `ssh_key` (Block Set) SSH key. (see [below for nested schema](#nestedblock--ssh_key))
### Read-Only
- **id** (String) The ID of the settings.
- `id` (String) The ID of the settings.
<a id="nestedblock--ssh_key"></a>
### Nested Schema for `ssh_key`
Required:
- **name** (String) Name of SSH key.
- **type** (String) Type of SSH key, e.g. ssh-rsa.
- `name` (String) Name of SSH key.
- `type` (String) Type of SSH key, e.g. ssh-rsa.
Optional:
- **comment** (String) Comment.
- **key** (String) Public SSH key.
- `comment` (String) Comment.
- `key` (String) Public SSH key.

14
docs/resources/setting_usg.md
View File

@@ -17,15 +17,15 @@ description: |-
### Optional
- **dhcp_relay_servers** (List of String) The DHCP relay servers.
- **firewall_guest_default_log** (Boolean) Whether the guest firewall log is enabled.
- **firewall_lan_default_log** (Boolean) Whether the LAN firewall log is enabled.
- **firewall_wan_default_log** (Boolean) Whether the WAN firewall log is enabled.
- **multicast_dns_enabled** (Boolean) Whether multicast DNS is enabled.
- **site** (String) The name of the site to associate the settings with.
- `dhcp_relay_servers` (List of String) The DHCP relay servers.
- `firewall_guest_default_log` (Boolean) Whether the guest firewall log is enabled.
- `firewall_lan_default_log` (Boolean) Whether the LAN firewall log is enabled.
- `firewall_wan_default_log` (Boolean) Whether the WAN firewall log is enabled.
- `multicast_dns_enabled` (Boolean) Whether multicast DNS is enabled.
- `site` (String) The name of the site to associate the settings with.
### Read-Only
- **id** (String) The ID of the settings.
- `id` (String) The ID of the settings.

6
docs/resources/site.md
View File

@@ -23,12 +23,12 @@ resource "unifi_site" "mysite" {
### Required
- **description** (String) The description of the site.
- `description` (String) The description of the site.
### Read-Only
- **id** (String) The ID of the site.
- **name** (String) The name of the site.
- `id` (String) The ID of the site.
- `name` (String) The name of the site.
## Import

16
docs/resources/static_route.md
View File

@@ -42,19 +42,19 @@ resource "unifi_static_route" "interface" {
### Required
- **distance** (Number) The distance of the static route.
- **name** (String) The name of the static route.
- **network** (String) The network subnet address.
- **type** (String) The type of static route. Can be `interface-route`, `nexthop-route`, or `blackhole`.
- `distance` (Number) The distance of the static route.
- `name` (String) The name of the static route.
- `network` (String) The network subnet address.
- `type` (String) The type of static route. Can be `interface-route`, `nexthop-route`, or `blackhole`.
### Optional
- **interface** (String) The interface of the static route (only valid for `interface-route` type). This can be `WAN1`, `WAN2`, or a network ID.
- **next_hop** (String) The next hop of the static route (only valid for `nexthop-route` type).
- **site** (String) The name of the site to associate the static route with.
- `interface` (String) The interface of the static route (only valid for `interface-route` type). This can be `WAN1`, `WAN2`, or a network ID.
- `next_hop` (String) The next hop of the static route (only valid for `nexthop-route` type).
- `site` (String) The name of the site to associate the static route with.
### Read-Only
- **id** (String) The ID of the static route.
- `id` (String) The ID of the static route.

28
docs/resources/user.md
View File

@@ -31,25 +31,25 @@ resource "unifi_user" "test" {
### Required
- **mac** (String) The MAC address of the user.
- **name** (String) The name of the user.
- `mac` (String) The MAC address of the user.
- `name` (String) The name of the user.
### Optional
- **allow_existing** (Boolean) Specifies whether this resource should just take over control of an existing user. Defaults to `true`.
- **blocked** (Boolean) Specifies whether this user should be blocked from the network.
- **dev_id_override** (Number) Override the device fingerprint.
- **fixed_ip** (String) A fixed IPv4 address for this user.
- **network_id** (String) The network ID for this user.
- **note** (String) A note with additional information for the user.
- **site** (String) The name of the site to associate the user with.
- **skip_forget_on_destroy** (Boolean) Specifies whether this resource should tell the controller to "forget" the user on destroy. Defaults to `false`.
- **user_group_id** (String) The user group ID for the user.
- `allow_existing` (Boolean) Specifies whether this resource should just take over control of an existing user. Defaults to `true`.
- `blocked` (Boolean) Specifies whether this user should be blocked from the network.
- `dev_id_override` (Number) Override the device fingerprint.
- `fixed_ip` (String) A fixed IPv4 address for this user.
- `network_id` (String) The network ID for this user.
- `note` (String) A note with additional information for the user.
- `site` (String) The name of the site to associate the user with.
- `skip_forget_on_destroy` (Boolean) Specifies whether this resource should tell the controller to "forget" the user on destroy. Defaults to `false`.
- `user_group_id` (String) The user group ID for the user.
### Read-Only
- **hostname** (String) The hostname of the user.
- **id** (String) The ID of the user.
- **ip** (String) The IP address of the user.
- `hostname` (String) The hostname of the user.
- `id` (String) The ID of the user.
- `ip` (String) The IP address of the user.

10
docs/resources/user_group.md
View File

@@ -26,17 +26,17 @@ resource "unifi_user_group" "wifi" {
### Required
- **name** (String) The name of the user group.
- `name` (String) The name of the user group.
### Optional
- **qos_rate_max_down** (Number) The QOS maximum download rate. Defaults to `-1`.
- **qos_rate_max_up** (Number) The QOS maximum upload rate. Defaults to `-1`.
- **site** (String) The name of the site to associate the user group with.
- `qos_rate_max_down` (Number) The QOS maximum download rate. Defaults to `-1`.
- `qos_rate_max_up` (Number) The QOS maximum upload rate. Defaults to `-1`.
- `site` (String) The name of the site to associate the user group with.
### Read-Only
- **id** (String) The ID of the user group.
- `id` (String) The ID of the user group.
## Import

56
docs/resources/wlan.md
View File

@@ -55,46 +55,46 @@ resource "unifi_wlan" "wifi" {
### Required
- **name** (String) The SSID of the network.
- **security** (String) The type of WiFi security for this network. Valid values are: `wpapsk`, `wpaeap`, and `open`.
- **user_group_id** (String) ID of the user group to use for this network.
- `name` (String) The SSID of the network.
- `security` (String) The type of WiFi security for this network. Valid values are: `wpapsk`, `wpaeap`, and `open`.
- `user_group_id` (String) ID of the user group to use for this network.
### Optional
- **ap_group_ids** (Set of String) IDs of the AP groups to use for this network.
- **hide_ssid** (Boolean) Indicates whether or not to hide the SSID from broadcast.
- **is_guest** (Boolean) Indicates that this is a guest WLAN and should use guest behaviors.
- **l2_isolation** (Boolean) Isolates stations on layer 2 (ethernet) level Defaults to `false`.
- **mac_filter_enabled** (Boolean) Indicates whether or not the MAC filter is turned of for the network.
- **mac_filter_list** (Set of String) List of MAC addresses to filter (only valid if `mac_filter_enabled` is `true`).
- **mac_filter_policy** (String) MAC address filter policy (only valid if `mac_filter_enabled` is `true`). Defaults to `deny`.
- **minimum_data_rate_2g_kbps** (Number) Set minimum data rate control for 2G devices, in Kbps. Use `0` to disable minimum data rates. Valid values are: `1000`, `2000`, `5500`, `6000`, `9000`, `11000`, `12000`, `18000`, `24000`, `36000`, `48000`, and `54000`.
- **minimum_data_rate_5g_kbps** (Number) Set minimum data rate control for 5G devices, in Kbps. Use `0` to disable minimum data rates. Valid values are: `6000`, `9000`, `12000`, `18000`, `24000`, `36000`, `48000`, and `54000`.
- **multicast_enhance** (Boolean) Indicates whether or not Multicast Enhance is turned of for the network.
- **network_id** (String) ID of the network for this SSID
- **no2ghz_oui** (Boolean) Connect high performance clients to 5 GHz only Defaults to `true`.
- **passphrase** (String, Sensitive) The passphrase for the network, this is only required if `security` is not set to `open`.
- **pmf_mode** (String) Enable Protected Management Frames. This cannot be disabled if using WPA 3. Valid values are `required`, `optional` and `disabled`. Defaults to `disabled`.
- **radius_profile_id** (String) ID of the RADIUS profile to use when security `wpaeap`. You can query this via the `unifi_radius_profile` data source.
- **schedule** (Block List) Start and stop schedules for the WLAN (see [below for nested schema](#nestedblock--schedule))
- **site** (String) The name of the site to associate the wlan with.
- **uapsd** (Boolean) Enable Unscheduled Automatic Power Save Delivery Defaults to `false`.
- **wlan_band** (String) Radio band your WiFi network will use.
- **wpa3_support** (Boolean) Enable WPA 3 support (security must be `wpapsk` and PMF must be turned on).
- **wpa3_transition** (Boolean) Enable WPA 3 and WPA 2 support (security must be `wpapsk` and `wpa3_support` must be true).
- `ap_group_ids` (Set of String) IDs of the AP groups to use for this network.
- `hide_ssid` (Boolean) Indicates whether or not to hide the SSID from broadcast.
- `is_guest` (Boolean) Indicates that this is a guest WLAN and should use guest behaviors.
- `l2_isolation` (Boolean) Isolates stations on layer 2 (ethernet) level Defaults to `false`.
- `mac_filter_enabled` (Boolean) Indicates whether or not the MAC filter is turned of for the network.
- `mac_filter_list` (Set of String) List of MAC addresses to filter (only valid if `mac_filter_enabled` is `true`).
- `mac_filter_policy` (String) MAC address filter policy (only valid if `mac_filter_enabled` is `true`). Defaults to `deny`.
- `minimum_data_rate_2g_kbps` (Number) Set minimum data rate control for 2G devices, in Kbps. Use `0` to disable minimum data rates. Valid values are: `1000`, `2000`, `5500`, `6000`, `9000`, `11000`, `12000`, `18000`, `24000`, `36000`, `48000`, and `54000`.
- `minimum_data_rate_5g_kbps` (Number) Set minimum data rate control for 5G devices, in Kbps. Use `0` to disable minimum data rates. Valid values are: `6000`, `9000`, `12000`, `18000`, `24000`, `36000`, `48000`, and `54000`.
- `multicast_enhance` (Boolean) Indicates whether or not Multicast Enhance is turned of for the network.
- `network_id` (String) ID of the network for this SSID
- `no2ghz_oui` (Boolean) Connect high performance clients to 5 GHz only Defaults to `true`.
- `passphrase` (String, Sensitive) The passphrase for the network, this is only required if `security` is not set to `open`.
- `pmf_mode` (String) Enable Protected Management Frames. This cannot be disabled if using WPA 3. Valid values are `required`, `optional` and `disabled`. Defaults to `disabled`.
- `radius_profile_id` (String) ID of the RADIUS profile to use when security `wpaeap`. You can query this via the `unifi_radius_profile` data source.
- `schedule` (Block List) Start and stop schedules for the WLAN (see [below for nested schema](#nestedblock--schedule))
- `site` (String) The name of the site to associate the wlan with.
- `uapsd` (Boolean) Enable Unscheduled Automatic Power Save Delivery Defaults to `false`.
- `wlan_band` (String) Radio band your WiFi network will use.
- `wpa3_support` (Boolean) Enable WPA 3 support (security must be `wpapsk` and PMF must be turned on).
- `wpa3_transition` (Boolean) Enable WPA 3 and WPA 2 support (security must be `wpapsk` and `wpa3_support` must be true).
### Read-Only
- **id** (String) The ID of the network.
- `id` (String) The ID of the network.
<a id="nestedblock--schedule"></a>
### Nested Schema for `schedule`
Required:
- **block_end** (String) Time of day to end the block.
- **block_start** (String) Time of day to start the block.
- **day_of_week** (String) Day of week for the block. Valid values are `sun`, `mon`, `tue`, `wed`, `thu`, `fri`, `sat`.
- `block_end` (String) Time of day to end the block.
- `block_start` (String) Time of day to start the block.
- `day_of_week` (String) Day of week for the block. Valid values are `sun`, `mon`, `tue`, `wed`, `thu`, `fri`, `sat`.
## Import