Skip to content
Snippets Groups Projects
Commit 4b4bb720 authored by Anjan Chanda's avatar Anjan Chanda
Browse files

README: add UCI config options table

parent ad6b3331
No related branches found
No related tags found
No related merge requests found
Pipeline #146554 passed
...@@ -24,6 +24,53 @@ and explain some features of map-controller: ...@@ -24,6 +24,53 @@ and explain some features of map-controller:
## UCI Configuration ## UCI Configuration
The table below lists the configuration parameters supported by map-controller.
The config file is in UCI format and defaults to "/etc/config/mapcontroller"
path.
Section | Name | Type | Required | Default | Description
-----------|------|------|----------|---------|-------------
controller | - | - | - | - | - |
" |enabled | boolean | yes | 1 | When set to 0, disables the map-controller |
" |id | MAC address | no | (auto) | Gets auto-set with the 1905 AL-macaddress of the locally running 1905 component. |
" |network\_id | UUID hexstring | no | (auto) | The unique identifier of the Multi-AP network managed by this Controller. When not set, gets autogenerated. |
" |registrar | list | no | (none) | List of WiFi frequency bands for which the Controller will act as a Configuration Registrar. Possible values are: 2, 5 and 6 |
" |bcn\_metrics\_max\_num | integer | no | 10 | Specifies the maximum number of 11k Beacon Metrics Responses per STA |
" |initial\_channel\_scan | boolean | no | false | Whether or not, a Channel Scan Request will be issued to an Agent immediately post its On-boarding |
" |primary\_vid | integer | no | 0 | Primary VLAN ID of the Multi-AP network managed by this Controller. When not set, the Multi-AP network is untagged |
" |enable\_ts | boolean | no | false | When set to true, enables Traffic Separation in the Multi-AP network as defined in the EasyMesh standard |
" |max\_node\_bh\_hops | integer | no | 0 | When set to a positive integer greater than 0, Controller limits the depth of the Multi-AP network by not allowing the WiFi backhauls to grow beyond this number |
" |debug | integer | no | 0 | Set the verbosity level of debugging |
ap | | - | - | - | This section defines the AP (or BSS) configuration of the Agent nodes, which the Controller will provision with during EasyMesh Onboarding. |
" | band | integer | yes | 0 | WiFi frequency band for which the AP (or BSS) configuration of this config section is applicable. Values: 2, 5 or 6 for 2.4, 5 and 6 GHz bands respectively. |
" | ssid | string | yes | | SSID of the AP configuration. |
" | encryption | string | yes | | Security types for the AP configuration. Valid values are - "sae", "dpp+sae", "sae-mixed", "psk-mixed", "psk2", "psk", "wps-mixed", "wpa2", "wpa", "none" and "open". NOTE: Only a certain set of values may be valid for a given frequency 'band', f.e. "psk2" or "sae-mixed" are not valid when "band" = 6. |
" | key | string | yes | | Security key, f.e., passphrase or psk. |
" | type | string | no | "fronthaul" | Type of the AP/BSS. Valid value is "backhaul", "fronthaul" or "combined". |
" | vid | integer | no | 1 | VLAN ID of the AP (or BSS) network. |
" | enabled | boolean | no | true | Whether this 'ap' section is enabled or not. *TODO* explain behavior with/without EASYMESH_VENDOR_EXT |
" | disallow\_bsta\_profile | integer | no | | When set, configure the Agent nodes to disallow WiFi backhaul connections in the downstream with Agents supporting this profile. *TODO* valid values |
" | vendor\_ie | list | no | | Hexstring of Vendor IEs. *TODO* explain usage in one-or-two lines |
node | node\_xxyyzzaabbcc | - | - | - | - |
" | agent\_id | MAC address | no | (auto) | Gets auto-set with the 1905 AL-macaddress of an Onboarded Agent node. |
" | report\_scan | boolean | no | 0 | Whether the Agent node should report scan-results from independent scanning done by it or not. |
" | report\_sta\_assocfails| boolean | no | 0 | Whether the Agent node should report STA association failures or not. |
" | report\_sta\_assocfails\_rate | integer | no | 0 | Periodicity with which the Agent node should report STA association failures. |
" | report\_metric\_periodic | integer | no | 0 | Periodicity with which the Agent node should report send Metric Reports to the Controller. |
" | steer\_disallow | boolean | no | 0 | When set to 1, disallows STA steering by the Agent node. |
" | steer\_exclude | list | no | | List of STA macaddresses that are excluded from Independent STA steering by the Agent node. Default: Empty list, meaning all STAs to be steered by the Agent node should be steered only through the Steering Mandate command from the Controller. |
" | steer\_exclude\_btm | list | no | | List of STA macaddresses that are excluded from 11v BTM steering carried out independently by the Agent node. Default: Empty list, meaning that all STAs to be BTM steered by the Agent node, should occur only through the Steering Mandate command from the Controller. |
" | traffic\_separation | boolean | no | | When set to 0, Controller excludes the Agent node from Traffic Separation policy configuration. |
" | coordinated\_cac | boolean | no | | Whether to enable or disable Coordicated CAC in the Agent node. |
ap | - | - | - | - | - |
" | band | integer | yes | (none) | Specifies the frequency band for which this AP configuration is applicable. The value here must be one of the values from 'registrar' list. Possible values are: 2, 5. |
" | ssid | string | yes | (none) | Specifies the SSID of the AP that can be auto-configured in this frequency band. |
" | encryption | string | yes | psk2 | Specifies the encryption type of the AP that can be auto-configured in this frequency band. |
" | key | string | yes | (none) | When encryption type is 'psk2', specifies the passphrase of the AP that can be auto-configured in this frequency band. |
-----------
A default configuration file which will propagate one fronthaul and one backhaul A default configuration file which will propagate one fronthaul and one backhaul
interface for the 5GHz and 2.4GHz bands respectively may look as such: interface for the 5GHz and 2.4GHz bands respectively may look as such:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment