Update docs

README.md

@@ -19,7 +19,7 @@ Terraform module for provisioning a Unifi Gateway.
 | <a name="input_devices"></a> [devices](#input\_devices) | Devices to add to the network. | <pre>list(object({<br>    name              = string<br>    mac               = optional(string)<br>    forget_on_destroy = optional(bool, true)<br>    allow_adoption    = optional(bool, true)<br>    port_overrides = optional(list(object({<br>      number              = optional(number)<br>      name                = optional(string)<br>      aggregate_num_ports = optional(number)<br>      op_mode             = optional(string, "switch")<br>      port_profile        = optional(string)<br>      port_profile_id     = optional(string)<br>    })), [])<br>  }))</pre> | `[]` | no |
 | <a name="input_dyndns"></a> [dyndns](#input\_dyndns) | Dynamic DNS configuration | <pre>object({<br>    enabled  = optional(bool, false)<br>    hostname = optional(string)<br>    service  = optional(string)<br>    username = optional(string)<br>    password = optional(string)<br>    server   = optional(string)<br>  })</pre> | `{}` | no |
 | <a name="input_networks"></a> [networks](#input\_networks) | Network configurations. | <pre>map(object({<br>    purpose         = optional(string, "corporate")<br>    subnet          = string<br>    domain_name     = optional(string)<br>    multicast_dns   = optional(bool, true)<br>    internet_access = optional(bool, true)<br>    vlan_id         = optional(number)<br>    dhcp = optional(object({<br>      enabled    = optional(bool, true)<br>      start      = optional(string)<br>      stop       = optional(string)<br>      v6_enabled = optional(bool, false)<br>      boot = optional(object({<br>        enabled   = optional(bool, false)<br>        file_name = optional(string, "pxelinux.0")<br>        server    = optional(string)<br>      }), {})<br>    }), {})<br>    clients = optional(list(object({<br>      name = string<br>      mac  = string<br>      ip   = optional(string)<br>    })), [])<br>    wan = optional(object({<br>      dhcp_v6_pd_size = optional(number)           # Specifies the IPv6 prefix size to request from ISP. Must be between 48 and 64.<br>      dns             = optional(list(string), []) # DNS servers IPs of the WAN.<br>      egress_qos      = optional(number)           # Specifies the WAN egress quality of service. Defaults to 0.<br>      gateway         = optional(string)           # The IPv4 gateway of the WAN.<br>      gateway_v6      = optional(string)           # The IPv6 gateway of the WAN.<br>      ip              = optional(string)           # The IPv4 address of the WAN.<br>      ipv6            = optional(string)           # The IPv6 address of the WAN.<br>      netmask         = optional(string)           # The IPv4 netmask of the WAN.<br>      networkgroup    = optional(string)           # Specifies the WAN network group. Must be one of either WAN, WAN2 or WAN_LTE_FAILOVER.<br>      prefixlen       = optional(number)           # The IPv6 prefix length of the WAN. Must be between 1 and 128.<br>      type            = optional(string)           # Specifies the IPV4 WAN connection type. Must be one of either disabled, static, dhcp, or pppoe.<br>      type_v6         = optional(string)           # Specifies the IPV6 WAN connection type. Must be one of either disabled, static, or dhcpv6.<br>      username        = optional(string)           # Specifies the IPV4 WAN username.<br>      password        = optional(string)           # Specifies the IPV4 WAN password.<br>    }), {})<br>    ipv6 = optional(object({<br>      interface_type        = optional(string, "none") # Specifies which type of IPv6 connection to use. Must be one of either static, pd, or none. Defaults to none.<br>      pd_interface          = optional(string)         # Specifies which WAN interface to use for IPv6 PD. Must be one of either wan or wan2.<br>      pd_prefixid           = optional(string)         # Specifies the IPv6 Prefix ID.<br>      pd_start              = optional(string)         # Start address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.<br>      pd_stop               = optional(string)         # End address of the DHCPv6 range. Used if ipv6_interface_type is set to pd.<br>      ra_enable             = optional(bool, false)    # Specifies whether to enable router advertisements or not.<br>      ra_preferred_lifetime = optional(number, 14400)  # Lifetime in which the address can be used. Address becomes deprecated afterwards. Must be lower than or equal to ipv6_ra_valid_lifetime Defaults to 14400.<br>      ra_priority           = optional(string)         # IPv6 router advertisement priority. Must be one of either high, medium, or low<br>      ra_valid_lifetime     = optional(number, 86400)  # Total lifetime in which the address can be used. Must be equal to or greater than ipv6_ra_preferred_lifetime. Defaults to 86400.<br>      static_subnet         = optional(string)         # Specifies the static IPv6 subnet when ipv6_interface_type is 'static'.<br>    }), {})<br>  }))</pre> | `{}` | no |
-| <a name="input_port_forwards"></a> [port\_forwards](#input\_port\_forwards) | Port forwarding rules. | <pre>list(object({<br>    name                   = optional(string)            # The name of the port forwarding rule.<br>    dst_port               = optional(string)            # The destination port for the forwarding.<br>    enabled                = optional(bool, true)        # Deprecated - Specifies whether the port forwarding rule is enabled or not. Defaults to true. This will attribute will be removed in a future release. Instead of disabling a port forwarding rule you can remove it from your configuration.<br>    fwd_ip                 = optional(string)            # The IPv4 address to forward traffic to.<br>    fwd_port               = optional(string)            # The port to forward traffic to.<br>    log                    = optional(bool, false)       # Specifies whether to log forwarded traffic or not. Defaults to false.<br>    port_forward_interface = optional(string, "tcp_udp") # The port forwarding interface. Can be wan, wan2, or both.<br>    protocol               = optional(string)            # The protocol for the port forwarding rule. Can be tcp, udp, or tcp_udp. Defaults to tcp_udp.<br>    src_ip                 = optional(string, "any")     # The source IPv4 address = optional(or CIDR) # # of the port forwarding rule. For all traffic, specify any. Defaults to any.<br>  }))</pre> | `[]` | no |
+| <a name="input_port_forwards"></a> [port\_forwards](#input\_port\_forwards) | Port forwarding rules. | <pre>list(object({<br>    name                   = optional(string)            # The name of the port forwarding rule.<br>    dst_port               = optional(string)            # The destination port for the forwarding.<br>    enabled                = optional(bool, true)        # Deprecated - Specifies whether the port forwarding rule is enabled or not. Defaults to true. This will attribute will be removed in a future release. Instead of disabling a port forwarding rule you can remove it from your configuration.<br>    fwd_ip                 = optional(string)            # The IPv4 address to forward traffic to.<br>    fwd_port               = optional(string)            # The port to forward traffic to.<br>    log                    = optional(bool, false)       # Specifies whether to log forwarded traffic or not. Defaults to false.<br>    port_forward_interface = optional(string) # The port forwarding interface. Can be wan, wan2, or both.<br>    protocol               = optional(string, "tcp_udp")            # The protocol for the port forwarding rule. Can be tcp, udp, or tcp_udp. Defaults to tcp_udp.<br>    src_ip                 = optional(string, "any")     # The source IPv4 address = optional(or CIDR) # # of the port forwarding rule. For all traffic, specify any. Defaults to any.<br>  }))</pre> | `[]` | no |
 | <a name="input_port_profiles"></a> [port\_profiles](#input\_port\_profiles) | Port profiles to add to the network. | <pre>list(object({<br>    name                           = optional(string)       # The name of the port profile.<br>    autoneg                        = optional(bool)         # Enable link auto negotiation for the port profile. When set to true this overrides speed. Defaults to true.<br>    dot1x_ctrl                     = optional(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.<br>    dot1x_idle_timeout             = optional(number)       # The timeout, in seconds, to use when using the MAC Based 802.1X control. Can be between 0 and 65535 Defaults to 300.<br>    egress_rate_limit_kbps         = optional(number)       # The egress rate limit, in kpbs, for the port profile. Can be between 64 and 9999999.<br>    egress_rate_limit_kbps_enabled = optional(bool)         # Enable egress rate limiting for the port profile. Defaults to false.<br>    forward                        = optional(string)       # The type forwarding to use for the port profile. Can be all, native, customize or disabled. Defaults to native.<br>    full_duplex                    = optional(bool)         # Enable full duplex for the port profile. Defaults to false.<br>    isolation                      = optional(bool)         # Enable port isolation for the port profile. Defaults to false.<br>    lldpmed_enabled                = optional(bool)         # Enable LLDP-MED for the port profile. Defaults to true.<br>    lldpmed_notify_enabled         = optional(bool)         # Enable LLDP-MED topology change notifications for the port profile.<br>    native_networkconf_id          = optional(string)       # The ID of network to use as the main network on the port profile.<br>    op_mode                        = optional(string)       # The operation mode for the port profile. Can only be switch Defaults to switch.<br>    poe_mode                       = optional(string)       # The POE mode for the port profile. Can be one of auto, passv24, passthrough or off.<br>    port_security_enabled          = optional(bool)         # Enable port security for the port profile. Defaults to false.<br>    port_security_mac_address      = optional(list(string)) # The MAC addresses associated with the port security for the port profile.<br>    priority_queue1_level          = optional(number)       # The priority queue 1 level for the port profile. Can be between 0 and 100.<br>    priority_queue2_level          = optional(number)       # The priority queue 2 level for the port profile. Can be between 0 and 100.<br>    priority_queue3_level          = optional(number)       # The priority queue 3 level for the port profile. Can be between 0 and 100.<br>    priority_queue4_level          = optional(number)       # The priority queue 4 level for the port profile. Can be between 0 and 100.<br>    speed                          = optional(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<br>    stormctrl_bcast_enabled        = optional(bool)         # Enable broadcast Storm Control for the port profile. Defaults to false.<br>    stormctrl_bcast_level          = optional(number)       # The broadcast Storm Control level for the port profile. Can be between 0 and 100.<br>    stormctrl_bcast_rate           = optional(number)       # The broadcast Storm Control rate for the port profile. Can be between 0 and 14880000.<br>    stormctrl_mcast_enabled        = optional(bool)         # Enable multicast Storm Control for the port profile. Defaults to false.<br>    stormctrl_mcast_level          = optional(number)       # The multicast Storm Control level for the port profile. Can be between 0 and 100.<br>    stormctrl_mcast_rate           = optional(number)       # The multicast Storm Control rate for the port profile. Can be between 0 and 14880000.<br>    stormctrl_type                 = optional(string)       # The type of Storm Control to use for the port profile. Can be one of level or rate.<br>    stormctrl_ucast_enabled        = optional(bool)         # Enable unknown unicast Storm Control for the port profile. Defaults to false.<br>    stormctrl_ucast_level          = optional(number)       # The unknown unicast Storm Control level for the port profile. Can be between 0 and 100.<br>    stormctrl_ucast_rate           = optional(number)       # The unknown unicast Storm Control rate for the port profile. Can be between 0 and 14880000.<br>    stp_port_mode                  = optional(bool)         # Enable spanning tree protocol on the port profile. Defaults to true.<br>    tagged_networkconf_ids         = optional(list(string)) # The IDs of networks to tag traffic with for the port profile.<br>    voice_networkconf_id           = optional(string)       # The ID of network to use as the voice network on the port profile.<br>  }))</pre> | `[]` | no |
 | <a name="input_settings"></a> [settings](#input\_settings) | Unifi console settings | <pre>object({<br>    management = optional(object({<br>      auto_upgrade = optional(bool, true)<br>      ssh = optional(object({<br>        enabled = optional(bool, true)<br>        keys = optional(list(object({<br>          name    = string<br>          type    = optional(string, "ssh-rsa")<br>          key     = optional(string)<br>          comment = optional(string)<br>        })), [])<br>      }), {})<br>    }))<br>    radius = optional(object({<br>      enabled = optional(bool, false)<br>      accounting = optional(object({<br>        enabled = optional(bool, false)<br>        port    = optional(number, 1813)<br>      }), {})<br>      server                  = optional(string)<br>      auth_port               = optional(number, 1812)<br>      interim_update_interval = optional(number, 3600)<br>      secret                  = optional(string, "")<br>      tunneled_reply          = optional(bool, true)<br>    }))<br>    usg = optional(object({<br>      dhcp_relay_servers         = optional(list(string), [])<br>      firewall_guest_default_log = optional(bool, false)<br>      firewall_lan_default_log   = optional(bool, false)<br>      firewall_wan_default_log   = optional(bool, false)<br>      multicast_dns_enabled      = optional(bool, true)<br>    }))<br>  })</pre> | `{}` | no |
 | <a name="input_site"></a> [site](#input\_site) | The site name. | `string` | `"default"` | no |