mapcontroller

section | description | multi | required | options
controller | Mapcontroller daemon Configuration | false | yes |
name | type | required | default | description
enabled | boolean | no | true | Enables mapcontroller daemon
network_id | string | no | auto | Multi-AP network UUID
registrar | integer | no |  | The bands on which mapcontroller acts as registrar, space separated
debug | integer | no | 0 | Mapcontroller debug level
log_feature | list | no | all | List of logging features to enable. Possible values: timer, steer, bsteer, apconfig, sta, dpp, dyncntlr, ts, qos, misc, channel, son, default, none, all
resend_num | integer | no | 0 | Number of retry attempts for CMDUs which expect a response if none is received
bcn_metrics_max_num | integer | no | 10 | Number of beacon metrics stored (per client).
stale_sta_timeout | string | no | 30d | Interval at which the disassociated stations are removed. Value can be specified using suffix for seconds/minutes/hours/days. For eg. 60s/10m/2h/1d. If no suffix is provided, the value is treated as seconds. Defaults to 30days for invalid or missing input
primary_vid | integer | no | 0 | Primary VID used for VLAN segregation. Today only 0 (vlan not supported) and 1 are supported.
default_pcp | integer | no | 0 | Default PCP value
enable_ts | boolean | no | false | Enable traffic separation in the EasyMesh network.
profile | integer | no | passed EASYMESH_VERSION CFLAG | EasyMesh profile reported and used by map-controller.
max_node_bh_hops | integer | no | 0 | Limit the max number of Wi-Fi backhaul links that are allowed in daisy-chained topology
plugin | list | no |  | List of controller plugins to load
dpp_uri_file | string | no | /etc/multiap/dpp_uris.json | Path to the JSON file holding provisioned DPP enrollee URIs. When unset the historic default path is used.
assoc_ctrl_file | string | no | /etc/multiap/cntrl_assoc_ctrl.json | Path to the JSON file where the controller persists Client Association Control requests it sends. The default is intentionally distinct from the agent's /etc/multiap/assoc_ctrl.json so a colocated controller+agent does not pollute the agent's local view.
channel_plan | Channel planning and ACS configuration | false | no |
name | type | required | default | description
acs | boolean | no | false | Enable Automatic Channel Selection (ACS) functionality
acs_timeout | string | no | 0 | Interval for ACS recalculation. Value can be specified using suffix for seconds/minutes/hours/days. For eg. 60s/10m/2h/1d. If no suffix is provided, the value is treated as seconds. 0 means disabled
acs_skip_dfs | boolean | no | false | Skip DFS channels when selecting best channel during ACS
acs_prevent_cac | boolean | no | true | Prevent DFS CAC during ACS channel selection (only use available DFS channels)
acs_highest_bandwidth | boolean | no | false | Use highest possible bandwidth during ACS channel selection
acs_scan_before_recalc | boolean | no | true | Perform channel scan before ACS recalculation
preclear_dfs | boolean | no | false | Enable background DFS channel clearing (pre-CAC) functionality
sta_steering | STA Steer plugin configuration | true | no |
name | type | required | default | description
enabled | boolean | no | false | Enable this STA steering section, only one may be active at any given time. If multiple are enabled, the first section will take affect.
steer_module | string | yes |  | Unique name of the steering module. Should be same name as the library to be loaded, excluding .so affix
enable_sta_steer | boolean | no | false | Enable STA steering when this section is loaded.
enable_bsta_steer | boolean | no | false | Enable bSTA steering when this section is loaded.
use_bcn_metrics | boolean | no | false | Use beacon metric reports for steering decision.
use_usta_metrics | boolean | no | false | Use un-associated STA metrics for steering decision.
bandsteer | boolean | no | false | Allow steering between different bands.
diffsnr | integer | no | 8 | RCPI improvement towards new AP required in order to trigger steering decision.
rcpi_threshold_2g | integer | no | 70 | Default RCPI threshold to be set for 2.4GHz band.
rcpi_threshold_5g | integer | no | 86 | Default RCPI threshold to be set for 5GHz band.
rcpi_threshold_6g | integer | no | 86 | Default RCPI threshold to be set for 6GHz band.
report_rcpi_threshold_2g | integer | no | 80 | Default reporting RCPI threshold to be set for 2.4GHz band.
report_rcpi_threshold_5g | integer | no | 96 | Default reporting RCPI threshold to be set for 5GHz band.
report_rcpi_threshold_6g | integer | no | 96 | Default reporting RCPI threshold to be set for 6GHz band.
plugins_enabled | boolean | no | false | Enable steering plugins
plugins_policy | string | no | any | Plugin policy: 'any' (steer when any plugin approves) or 'all' (steer when all plugins approve)
plugins | list | no |  | List of steering plugins
steer_exclude | list | no |  | Global steering exclusion list for both BTM and controller mandated steering
ap | Wireless credentials to be configured | true | no |
name | type | required | default | description
band | integer | yes |  | Band for which the credentials applies
ssid | string | no |  | SSID of the configured AP
encryption | string | no | sae-mixed | Encryption for the credentials. Defaults to sae-mixed for fronthauls and sae for backhauls
key | string | yes |  | Password for the SSID
vid | integer | no | 0 | VLAN ID of the configured interface
type | string | no | fronthaul | Interface type, may be set to fronthaul, backhaul or combined
disallow_bsta_profile | list | no |  | List of profiles to disallow connection over the interface
enabled | boolean | no | true | In the default use case, if option is set to false this section is not passed within an M2 to the agents. If vendor extensions are supported, the section is passed to the agents, but the agents supporting vendor extensions will start with this interface disabled.
vendor_ie | list | no |  | Pass any custom vendor extension as a part of the WSC M2.
bridge | string | no |  | Bridge interface name. Requires vendor extension CFLAG to be passed in the Multi-AP IE
mld_id | integer | no | 0 | Indiciates whether the interface is a part of an MLD. The value maps towards the ID of the mld section, if present.
qos | Represents controller specific QoS options | false | yes |
name | type | required | default | description
enabled | boolean | no | false | Enable QoS or not
qos_rule | Represents QoS rules | true | no |
name | type | required | default | description
id | integer | yes |  | Rule Identifier value
type | string | yes | dscp_pcp | Rule type: dscp_pcp, mscs, scs or mgmt
precedence | integer | no | 254 | Rule Precedence value, higher number means higher priority
output | integer | yes | 0 | Rule output value
always_match | boolean | no | false | Should rule always match?
qmid | integer | no | 0 | QoS management ID of the entry (useful for 'mgmt' type)
bssid | string | no |  | BSS MAC address
sta | string | no |  | STA MAC address
dscp_pcp | list | no |  | List of 'dscp_min-dscp_max,pcp' or 'dscp,pcp' pairs
policy_type | string | no |  | QoS policy type
node | Represents an ieee1905 device in the network. Contains node-specific info and policies | true | no |
name | type | required | default | description
agent_id | string | yes |  | AL mac of the node represented by this section
primary_vid | integer | no | 1 | Currently not used and overriden by global option.
primary_pcp | integer | no | 0 | Currently not used and overriden by global option.
report_sta_assocfails | integer | no | 0 | Whether sta association fails shall be reported.
report_sta_assocfails_rate | integer | no | 0 | Maximum frequency at which sta association fails shall be reported.
report_metric_periodic | integer | no | 5 | The interval at which AP Metrics shall be reported.
report_scan | integer | no | 1 | Whether independent channel scan shall be reported.
steer_exclude | list | no |  | List of client macaddresses to be excluded from local steering.
steer_exclude_btm | list | no |  | List of client macaddresses to be excluded from BTM steering.
steer_disallow | boolean | no | false | Disallow steering to this node. OPTION NOT YET IMPLEMENTED
coordinated_cac | boolean | no | false | Disallow coordinated CAC to this node. OPTION NOT YET IMPLEMENTED
traffic_separation | boolean | no | false | Currently not used and overriden by global option.
radio | Represents a radio of a node. | true | no |
name | type | required | default | description
agent_id | string | yes |  | AL mac of the node which has this radio
macaddr | string | yes |  | Mac address of the radio
band | string | yes |  | 2, 5 or 6
steer_policy | integer | no | 0 | 0 = agent initiated steering disallowed, 1 = agent initiated RCPI steering mandated, 2 = agent initiated RCPI based steering allowed
util_threshold | integer | no | 0 | Channel utilization threshold.
rcpi_threshold | integer | no | 0 | Indicate RCPI threshold used for agent-initiated steering. Defaults to 86 for 5GHz and 70 for 2.4GHz
report_rcpi_threshold | integer | no | 0 | RCPI threshold at which the agent will start sending unsolicited metric reporting to controller. 0 means do not report. Defaults to 96 for 5GHz and 80 for 2.4GHz
report_util_threshold | integer | no | 0 | Threshold at which utilization will be reported.
report_rcpi_hysteresis_margin | integer | no | 0 | Indicates a Margin value (in dB) used to smooth out RCPI threshold fluctuations.
include_sta_stats | boolean | no | false | Whether to include STA traffic stats TLV with the AP metrics response.
include_sta_metric | boolean | no | false | Whether to include associated STA link metrics TLV in the AP metrics response.
include_wifi6_sta_status | boolean | no | false | Inclusion policy of Associated Wi-Fi 6 STA Status Report TLV in the AP metrics response.
punct_bitmap | string | no |  | WiFi 7 preamble puncturing bitmap. 4-character hex string where each bit represents a 20MHz subchannel: bit 0 = punctured (disabled), bit 1 = active. LSB maps to lowest frequency subchannel. Examples for 80MHz: 'FFFF' = no puncturing, 'FFFE' = lowest 20MHz punctured, 'FFF7' = highest 20MHz punctured
disallow_opclass | list | no |  | List of disallowed operating classes for the radio. Each list entry may specify an operating class alone or an operating class with a comma-separated list of disallowed channels. Format: '' or ':,,...'. If only the operating class is specified, all channels within that operating class are disallowed. If channels are specified, only those channels are disallowed for the given operating class. Examples: '83' (disallow entire operating class 83), '128:36,40,44' (disallow channels 36, 40, and 44 in operating class 128).
mld | Section storing MLD credentials. | true | no |
name | type | required | default | description
id | integer | yes | 0 | Unique ID assigned to this MLD.
ssid | string | no |  | SSID used by all the links that are a part of this MLD.
key | string | no |  | Password used by all links that are a part of this MLD.
type | string | no | unknown | Human readable type of the interfaces belonging to the MLD (fronthaul/backhaul/combined).
enabled | boolean | no | true | Whether the MLD is enabled or not.