Regenerate docs

2021-03-07 09:30:39 -05:00
parent e4b9ac6f33
commit ef56fa5dec
14 changed files with 29 additions and 29 deletions
--- a/docs/data-sources/ap_group.md
+++ b/docs/data-sources/ap_group.md
@@ -6,7 +6,7 @@ description: |-
  unifi_ap_group data source can be used to retrieve the ID for an AP group by name.
 ---

-# Data Source `unifi_ap_group`
+# unifi_ap_group (Data Source)

 `unifi_ap_group` data source can be used to retrieve the ID for an AP group by name.

@@ -25,7 +25,7 @@ data "unifi_ap_group" "default" {
 - **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
+### Read-Only

 - **id** (String) The ID of this AP group.

--- a/docs/data-sources/port_profile.md
+++ b/docs/data-sources/port_profile.md
@@ -6,7 +6,7 @@ description: |-
  unifi_port_profile data source can be used to retrieve the ID for a port profile by name.
 ---

-# Data Source `unifi_port_profile`
+# unifi_port_profile (Data Source)

 `unifi_port_profile` data source can be used to retrieve the ID for a port profile by name.

@@ -25,7 +25,7 @@ data "unifi_port_profile" "all" {
 - **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
+### Read-Only

 - **id** (String) The ID of this port profile.

--- a/docs/data-sources/radius_profile.md
+++ b/docs/data-sources/radius_profile.md
@@ -6,7 +6,7 @@ description: |-
  unifi_radius_profile data source can be used to retrieve the ID for a RADIUS profile by name.
 ---

-# Data Source `unifi_radius_profile`
+# unifi_radius_profile (Data Source)

 `unifi_radius_profile` data source can be used to retrieve the ID for a RADIUS profile by name.

@@ -20,7 +20,7 @@ description: |-
 - **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
+### Read-Only

 - **id** (String) The ID of this AP group.

--- a/docs/data-sources/user_group.md
+++ b/docs/data-sources/user_group.md
@@ -6,7 +6,7 @@ description: |-
  unifi_user_group data source can be used to retrieve the ID for a user group by name.
 ---

-# Data Source `unifi_user_group`
+# unifi_user_group (Data Source)

 `unifi_user_group` data source can be used to retrieve the ID for a user group by name.

@@ -20,7 +20,7 @@ description: |-
 - **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
+### Read-Only

 - **id** (String) The ID of this AP group.
 - **qos_rate_max_down** (Number)
--- a/docs/data-sources/wlan_group.md
+++ b/docs/data-sources/wlan_group.md
@@ -7,7 +7,7 @@ description: |-
  Please note that WLAN Groups are deprecated in v6 of the controller.
 ---

-# Data Source `unifi_wlan_group`
+# unifi_wlan_group (Data Source)

 `unifi_wlan_group` data source can be used to retrieve the ID for a WLAN group by name.

@@ -23,7 +23,7 @@ Please note that WLAN Groups are deprecated in v6 of the controller.
 - **name** (String) The name of the WLAN group to look up. Defaults to `Default`.
 - **site** (String) The name of the site the wlan group is associated with.

-### Read-only
+### Read-Only

 - **id** (String) The ID of this AP group.

--- a/docs/resources/firewall_group.md
+++ b/docs/resources/firewall_group.md
@@ -6,7 +6,7 @@ description: |-
  unifi_firewall_group manages groups of addresses or ports for use in firewall rules (unifi_firewall_rule).
 ---

-# Resource `unifi_firewall_group`
+# unifi_firewall_group (Resource)

 `unifi_firewall_group` manages groups of addresses or ports for use in firewall rules (`unifi_firewall_rule`).

@@ -38,7 +38,7 @@ resource "unifi_firewall_group" "can_print" {

 - **site** (String) The name of the site to associate the firewall group with.

-### Read-only
+### Read-Only

 - **id** (String) The ID of the firewall group.

--- a/docs/resources/firewall_rule.md
+++ b/docs/resources/firewall_rule.md
@@ -6,7 +6,7 @@ description: |-
  unifi_firewall_rule manages an individual firewall rule on the gateway.
 ---

-# Resource `unifi_firewall_rule`
+# unifi_firewall_rule (Resource)

 `unifi_firewall_rule` manages an individual firewall rule on the gateway.

@@ -48,7 +48,7 @@ resource "unifi_firewall_rule" "drop_all" {
 - **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) The ICMP type name.
+- **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.
@@ -62,7 +62,7 @@ resource "unifi_firewall_rule" "drop_all" {
 - **state_new** (Boolean) Match where the state is new.
 - **state_related** (Boolean) Match where the state is related.

-### Read-only
+### Read-Only

 - **id** (String) The ID of the firewall rule.

--- a/docs/resources/network.md
+++ b/docs/resources/network.md
@@ -6,7 +6,7 @@ description: |-
  unifi_network manages WAN/LAN/VLAN networks.
 ---

-# Resource `unifi_network`
+# unifi_network (Resource)

 `unifi_network` manages WAN/LAN/VLAN networks.

@@ -74,7 +74,7 @@ resource "unifi_network" "wan" {
 - **wan_username** (String) Specifies the IPV4 WAN username.
 - **x_wan_password** (String) Specifies the IPV4 WAN password.

-### Read-only
+### Read-Only

 - **id** (String) The ID of the network.

--- a/docs/resources/port_forward.md
+++ b/docs/resources/port_forward.md
@@ -6,7 +6,7 @@ description: |-
  unifi_port_forward manages a port forwarding rule on the gateway.
 ---

-# Resource `unifi_port_forward`
+# unifi_port_forward (Resource)

 `unifi_port_forward` manages a port forwarding rule on the gateway.

@@ -28,7 +28,7 @@ description: |-
 - **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
+### Read-Only

 - **id** (String) The ID of the port forwarding rule.

--- a/docs/resources/port_profile.md
+++ b/docs/resources/port_profile.md
@@ -6,7 +6,7 @@ description: |-
  unifi_port_profile manages a port profile for use on network switches.
 ---

-# Resource `unifi_port_profile`
+# unifi_port_profile (Resource)

 `unifi_port_profile` manages a port profile for use on network switches.

@@ -77,7 +77,7 @@ resource "unifi_port_profile" "poe_disabled" {
 - **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
+### Read-Only

 - **id** (String) The ID of the port profile.

--- a/docs/resources/site.md
+++ b/docs/resources/site.md
@@ -6,7 +6,7 @@ description: |-
  unifi_site manages Unifi sites
 ---

-# Resource `unifi_site`
+# unifi_site (Resource)

 `unifi_site` manages Unifi sites

@@ -25,7 +25,7 @@ resource "unifi_site" "mysite" {

 - **description** (String) The description of the site.

-### Read-only
+### Read-Only

 - **id** (String) The ID of the site.
 - **name** (String) The name of the site.
--- a/docs/resources/user.md
+++ b/docs/resources/user.md
@@ -7,7 +7,7 @@ description: |-
  Users are created in the controller when observed on the network, so the resource defaults to allowing itself to just take over management of a MAC address, but this can be turned off.
 ---

-# Resource `unifi_user`
+# unifi_user (Resource)

 `unifi_user` manages a user (or "client" in the UI) of the network, these are identified by unique MAC addresses.

@@ -45,7 +45,7 @@ resource "unifi_user" "test" {
 - **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
+### Read-Only

 - **hostname** (String) The hostname of the user.
 - **id** (String) The ID of the user.
--- a/docs/resources/user_group.md
+++ b/docs/resources/user_group.md
@@ -6,7 +6,7 @@ description: |-
  unifi_user_group manages a user group (called "client group" in the UI), which can be used to limit bandwidth for groups of users.
 ---

-# Resource `unifi_user_group`
+# unifi_user_group (Resource)

 `unifi_user_group` manages a user group (called "client group" in the UI), which can be used to limit bandwidth for groups of users.

@@ -34,7 +34,7 @@ resource "unifi_user_group" "wifi" {
 - **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
+### Read-Only

 - **id** (String) The ID of the user group.

--- a/docs/resources/wlan.md
+++ b/docs/resources/wlan.md
@@ -6,7 +6,7 @@ description: |-
  unifi_wlan manages a WiFi network / SSID.
 ---

-# Resource `unifi_wlan`
+# unifi_wlan (Resource)

 `unifi_wlan` manages a WiFi network / SSID.

@@ -72,7 +72,7 @@ resource "unifi_wlan" "wifi" {
 - **wlan_band** (String) Radio band your WiFi network will use.
 - **wlan_group_id** (String, Deprecated) ID of the WLAN group to use for this network. Set ap_group_ids instead of wlan_group_id for controller version >= 6.

-### Read-only
+### Read-Only

 - **id** (String) The ID of the network.