325d7b7f20
* feat: initialize Terraform Plugin Framework * fix docker-compose path for tests * fix: ensure documentation can be generated with old provider SDK and new plugin framework * lint
84 lines
5.0 KiB
Markdown
84 lines
5.0 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "unifi_port_profile Resource - terraform-provider-unifi"
|
|
subcategory: ""
|
|
description: |-
|
|
unifi_port_profile manages a port profile for use on network switches.
|
|
---
|
|
|
|
# unifi_port_profile (Resource)
|
|
|
|
`unifi_port_profile` manages a port profile for use on network switches.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
variable "vlan_id" {
|
|
default = 10
|
|
}
|
|
|
|
resource "unifi_network" "vlan" {
|
|
name = "wifi-vlan"
|
|
purpose = "corporate"
|
|
|
|
subnet = "10.0.0.1/24"
|
|
vlan_id = var.vlan_id
|
|
dhcp_start = "10.0.0.6"
|
|
dhcp_stop = "10.0.0.254"
|
|
dhcp_enabled = true
|
|
}
|
|
|
|
resource "unifi_port_profile" "poe_disabled" {
|
|
name = "POE Disabled"
|
|
|
|
native_networkconf_id = unifi_network.vlan.id
|
|
poe_mode = "off"
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### 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`.
|
|
- `excluded_network_ids` (Set of String) List of network IDs to exclude on the port profile when forward is set to customize.
|
|
- `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 in Mbps. Can be one of `10`, `100`, `1000`, `2500`, `5000`, `10000`, `20000`, `25000`, `40000`, `50000` or `100000`. When `autoneg` is true, this setting is ignored.
|
|
- `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_vlan_mgmt` (String) The VLAN management type for the port profile. Can be one of 'auto', 'block_all', or 'custom'.
|
|
- `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.
|