Skip to content

Commit

Permalink
udpate documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tmunzer committed Dec 3, 2024
1 parent 3d4aee9 commit 12f20d1
Show file tree
Hide file tree
Showing 6 changed files with 280 additions and 332 deletions.
30 changes: 2 additions & 28 deletions docs/resources/org_wlan.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ resource "mist_org_wlan" "wlan_one" {
- `portal_denied_hostnames` (List of String) list of hostnames without http(s):// (matched by substring), this takes precedence over portal_allowed_hostnames
- `qos` (Attributes) (see [below for nested schema](#nestedatt--qos))
- `radsec` (Attributes) Radsec settings (see [below for nested schema](#nestedatt--radsec))
- `rateset` (Attributes) (see [below for nested schema](#nestedatt--rateset))
- `rateset` (Attributes Map) Property key is the RF band. enum: `24`, `5`, `6` (see [below for nested schema](#nestedatt--rateset))
- `roam_mode` (String) enum: `11r`, `OKC`, `NONE`
- `schedule` (Attributes) WLAN operating schedule, default is disabled (see [below for nested schema](#nestedatt--schedule))
- `sle_excluded` (Boolean) whether to exclude this WLAN from SLE metrics
Expand Down Expand Up @@ -524,16 +524,8 @@ Optional:

Optional:

- `band_24` (Attributes) data rates wlan settings (see [below for nested schema](#nestedatt--rateset--band_24))
- `band_5` (Attributes) data rates wlan settings (see [below for nested schema](#nestedatt--rateset--band_5))

<a id="nestedatt--rateset--band_24"></a>
### Nested Schema for `rateset.band_24`

Optional:

- `ht` (String) if `template`==`custom`. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 00ff 00f0 001f limits HT rates to MCS 0-7 for 1 stream, MCS 4-7 for 2 stream (i.e. MCS 12-15), MCS 1-5 for 3 stream (i.e. MCS 16-20)
- `legacy` (List of String) if `template`==`custom`. List of supported rates (IE=1) and extended supported rates (IE=50) for custom template, append ‘b’ at the end to indicate a rate being basic/mandatory. If `template`==`custom` is configured and legacy does not define at least one basic rate, it will use `no-legacy` default values
- `legacy` (List of String) if `template`==`custom`. List of supported rates (IE=1) and extended supported rates (IE=50) for custom template, append ‘b’ at the end to indicate a rate being basic/mandatory. If `template`==`custom` is configured and legacy does not define at least one basic rate, it will use `no-legacy` default values. enum: `1`, `11`, `11b`, `12`, `12b`, `18`, `18b`, `1b`, `2`, `24`, `24b`, `2b`, `36`, `36b`, `48`, `48b`, `5.5`, `5.5b`, `54`, `54b`, `6`, `6b`, `9`, `9b`
- `min_rssi` (Number) Minimum RSSI for client to connect, 0 means not enforcing
- `template` (String) Data Rates template to apply. enum:
* `no-legacy`: no 11b
Expand All @@ -544,24 +536,6 @@ Optional:
- `vht` (String) if `template`==`custom`. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 03ff 01ff 00ff limits VHT rates to MCS 0-9 for 1 stream, MCS 0-8 for 2 streams, and MCS 0-7 for 3 streams.


<a id="nestedatt--rateset--band_5"></a>
### Nested Schema for `rateset.band_5`

Optional:

- `ht` (String) if `template`==`custom`. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 00ff 00f0 001f limits HT rates to MCS 0-7 for 1 stream, MCS 4-7 for 2 stream (i.e. MCS 12-15), MCS 1-5 for 3 stream (i.e. MCS 16-20)
- `legacy` (List of String) if `template`==`custom`. List of supported rates (IE=1) and extended supported rates (IE=50) for custom template, append ‘b’ at the end to indicate a rate being basic/mandatory. If `template`==`custom` is configured and legacy does not define at least one basic rate, it will use `no-legacy` default values
- `min_rssi` (Number) Minimum RSSI for client to connect, 0 means not enforcing
- `template` (String) Data Rates template to apply. enum:
* `no-legacy`: no 11b
* `compatible`: all, like before, default setting that Broadcom/Atheros used
* `legacy-only`: disable 802.11n and 802.11ac
* `high-density`: no 11b, no low rates
* `custom`: user defined
- `vht` (String) if `template`==`custom`. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 03ff 01ff 00ff limits VHT rates to MCS 0-9 for 1 stream, MCS 0-8 for 2 streams, and MCS 0-7 for 3 streams.



<a id="nestedatt--schedule"></a>
### Nested Schema for `schedule`

Expand Down
30 changes: 2 additions & 28 deletions docs/resources/site_wlan.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ resource "mist_site_wlan" "wlan_one" {
- `portal_denied_hostnames` (List of String) list of hostnames without http(s):// (matched by substring), this takes precedence over portal_allowed_hostnames
- `qos` (Attributes) (see [below for nested schema](#nestedatt--qos))
- `radsec` (Attributes) Radsec settings (see [below for nested schema](#nestedatt--radsec))
- `rateset` (Attributes) (see [below for nested schema](#nestedatt--rateset))
- `rateset` (Attributes Map) Property key is the RF band. enum: `24`, `5`, `6` (see [below for nested schema](#nestedatt--rateset))
- `roam_mode` (String) enum: `11r`, `OKC`, `NONE`
- `schedule` (Attributes) WLAN operating schedule, default is disabled (see [below for nested schema](#nestedatt--schedule))
- `sle_excluded` (Boolean) whether to exclude this WLAN from SLE metrics
Expand Down Expand Up @@ -523,16 +523,8 @@ Optional:

Optional:

- `band_24` (Attributes) data rates wlan settings (see [below for nested schema](#nestedatt--rateset--band_24))
- `band_5` (Attributes) data rates wlan settings (see [below for nested schema](#nestedatt--rateset--band_5))

<a id="nestedatt--rateset--band_24"></a>
### Nested Schema for `rateset.band_24`

Optional:

- `ht` (String) if `template`==`custom`. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 00ff 00f0 001f limits HT rates to MCS 0-7 for 1 stream, MCS 4-7 for 2 stream (i.e. MCS 12-15), MCS 1-5 for 3 stream (i.e. MCS 16-20)
- `legacy` (List of String) if `template`==`custom`. List of supported rates (IE=1) and extended supported rates (IE=50) for custom template, append ‘b’ at the end to indicate a rate being basic/mandatory. If `template`==`custom` is configured and legacy does not define at least one basic rate, it will use `no-legacy` default values
- `legacy` (List of String) if `template`==`custom`. List of supported rates (IE=1) and extended supported rates (IE=50) for custom template, append ‘b’ at the end to indicate a rate being basic/mandatory. If `template`==`custom` is configured and legacy does not define at least one basic rate, it will use `no-legacy` default values. enum: `1`, `11`, `11b`, `12`, `12b`, `18`, `18b`, `1b`, `2`, `24`, `24b`, `2b`, `36`, `36b`, `48`, `48b`, `5.5`, `5.5b`, `54`, `54b`, `6`, `6b`, `9`, `9b`
- `min_rssi` (Number) Minimum RSSI for client to connect, 0 means not enforcing
- `template` (String) Data Rates template to apply. enum:
* `no-legacy`: no 11b
Expand All @@ -543,24 +535,6 @@ Optional:
- `vht` (String) if `template`==`custom`. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 03ff 01ff 00ff limits VHT rates to MCS 0-9 for 1 stream, MCS 0-8 for 2 streams, and MCS 0-7 for 3 streams.


<a id="nestedatt--rateset--band_5"></a>
### Nested Schema for `rateset.band_5`

Optional:

- `ht` (String) if `template`==`custom`. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 00ff 00f0 001f limits HT rates to MCS 0-7 for 1 stream, MCS 4-7 for 2 stream (i.e. MCS 12-15), MCS 1-5 for 3 stream (i.e. MCS 16-20)
- `legacy` (List of String) if `template`==`custom`. List of supported rates (IE=1) and extended supported rates (IE=50) for custom template, append ‘b’ at the end to indicate a rate being basic/mandatory. If `template`==`custom` is configured and legacy does not define at least one basic rate, it will use `no-legacy` default values
- `min_rssi` (Number) Minimum RSSI for client to connect, 0 means not enforcing
- `template` (String) Data Rates template to apply. enum:
* `no-legacy`: no 11b
* `compatible`: all, like before, default setting that Broadcom/Atheros used
* `legacy-only`: disable 802.11n and 802.11ac
* `high-density`: no 11b, no low rates
* `custom`: user defined
- `vht` (String) if `template`==`custom`. MCS bitmasks for 4 streams (16-bit for each stream, MCS0 is least significant bit), e.g. 03ff 01ff 00ff limits VHT rates to MCS 0-9 for 1 stream, MCS 0-8 for 2 streams, and MCS 0-7 for 3 streams.



<a id="nestedatt--schedule"></a>
### Nested Schema for `schedule`

Expand Down
138 changes: 69 additions & 69 deletions internal/resource_device_gateway/device_gateway_resource_gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 12f20d1

Please sign in to comment.