mapagent

section | required | description | multi | options
agent | yes | Mapagent daemon Configuration | false |
name | type | required | default | description
enabled | boolean | no | true | Enables mapagent daemon
debug | integer | no | 0 | Mapagent debug level
profile | integer | no | 2 | Currently unused
brcm_setup | boolean | no | false | For broadcom platforms, mapagent is responsible for adding the wds interface to the bridge
al_bridge | string | no | br-lan | The bridge which the wds interface will be attached to.
ifprefix | string | no | wl if brcm_setup is set, else wlan | The interface names that will be created by mapagent are using the specified netdev. Netdev supports a variety of formats, using % as an identifier
netdev | string | no | wl if brcm_setup is set, else wlan | Old/alternate (to be deprecated) option to ifprefix.
controller_macaddr | string | no |  | Will be set at runtime by mapagent
island_prevention | boolean | no | false | Enable or disables the island prevention feature. Must additionally be compile-time selected
resend_num | integer | no | 0 | Number of retry attempts for CMDUs which expect a response if none is received
dyn_cntlr_sync | boolean | no | false | Allow map-agent to sync its local controller config (if any) using HLD messages
dynbh | boolean | no | true | Enable or disable dynamic backhaul Ethernet management. Must additionally be compile-time selected
eth_onboards_wifi_bhs | boolean | no | false | Automatically configure backhaul stations based on received bBSS credentials upon AP-Autoconfiguration
ap_follow_sta_dfs | boolean | no | false | If backhaul STA connects to a channel/bandwidth which has not cleared DFS, it will disconnect and reconnect over any lower priority backhaul STA (if available). It will perform a fresh CAC and reconnect once complete. Recommended for mac80211 based platforms.
guest_isolation | boolean | no | false | Isolate guests-to-guest traffic in the case of traffic separation is enabled.
scan_on_boot_only | boolean | no | false | Perform scan at map-agent start-up. Disallow fresh scan on request.
chan_ch_relay_mcast | boolean | no | false | Send Operating Channel Report messages as relayed multicast.
extplugin | list | no |  | Name of extension to be loaded to map-agent, which may i.e. overload CMDU handling.
hide_backhaul_bss | boolean | no | false | If set, will not set 'hidden' option for backhaul BSS' when writing to the wireless config.
backhaul_override | boolean | no | false | Override backhaul configuration for controller initiated backhaul steering
off_channel_monitor | boolean | no | false | Enable off-channel monitoring
partial_wifi_reload | boolean | no | false | Enable partial WiFi reload. When enabled (requires CHECK_PARTIAL_WIFI_RELOAD compile flag), only reload specific WiFi parameters (SSID, PSK) instead of full reload for AP autoconfiguration changes
mld_ap_prefix | string | no | mld | Prefix for MLD AP interface names
mld_sta_prefix | string | no | mld | Prefix for MLD STA interface names
dynamic_backhaul | no | Options to manage dynamic backhaul functionality | false |
name | type | required | default | description
missing_bh_timer | integer | no | 60 | Time after lost backhaul connection at which agent will start scanning on all backhaul stations
missing_bh_reconfig_timer | integer | no | 300 | Time after lost backhaul connection at which agent will allow backhaul stations to find a new bBSS to connect to, clearing previously set BSSID options from configurations
controller_select | no | Configure controller selection parameters | false |
name | type | required | default | description
local | boolean | no | false | Enforce local controller. If set, the device will not be configurable by a non-local controller. If set, it also enables autostart
mode | string | no | auto | Controller selection mode for persistent controller feature. Possible values: 'auto', 'disabled', 'controller'
id | string | no | auto | Lock mapagent to a specific controller AL-ID. NOT YET IMPLEMENTED
probe_int | integer | no | 20 | The interval at which AP-Autoconfig Search (discovery) will be sent
retry_int | integer | no | 15 | After these many failed attempts mapagent infers no controller is active and accordingly takes next action
autostart | boolean | no | true | When this is set to true, the agent will try to start the controller after not finding one in the network.
radio | yes | Represents a radio. Also contains radio specific policies | true |
name | type | required | default | description
device | string | yes |  | Radio name
band | integer | yes |  | Band on which the radio operates
encryption | list | no | sae-mixed, sae, psk2, none, psk-mixed, psk, wpa, wpa2 | Encryptions supported. Sent with WSC M1 meta data.
onboarded | boolean | no | false | Set by mapagent if the radio has been onboarded (credentials received)
dedicated_backhaul | boolean | no | false | This radio will not be configured with fronthaul interfaces
steer_policy | integer | no | 0 | Steer policy to be used. 0 = Agent Initiated Steering Disallowed, 1 = Agent Initiated RCPI-based Steering Mandated, 2 = Agent Initiated RCPI-based Steering Allowed
util_threshold | integer | no | 0 | Indicate utilization threshold used for agent-initiated steering
rcpi_threshold | integer | no | 86 | Indicate RCPI threshold used for agent-initiated steering. Defaults to 86 for 5GHz and 70 for 2.4GHz
report_rcpi_threshold | integer | no | 96 | 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
include_sta_stats | boolean | no | false | Include STA Traffic Stats TLV in AP Metrics Response
include_sta_metric | boolean | no | false | Include Associated STA Link Metrics TLV in AP Metrics Response
include_wifi6_sta_status | boolean | no | false | include Associated Wi-Fi 6 STA Status Report TLV in the AP metrics response.
rcpi_hysteresis_margin | integer | no | 0 | STA Metrics Reporting RCPI Hysteresis Margin Override. This field is coded as an unsigned integer in units of decibels (dB).
report_util_threshold | integer | no | 0 | Utilization threshold at which the agent will start sending unsolicited metric reporting to controller. 0 means do not report
ifprefix | string | no |  | Interface name prefix pattern for this radio. Supports patterns with '%' placeholder (e.g., 'wl%', 'ra%', 'wlan%_') for interface name generation
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
bsta | no | Represents a backhaul station interface | true |
name | type | required | default | description
ifname | boolean | yes |  | Interface name of backhaul station interface
device | string | yes |  | Radio on which the interface is operating
band | integer | yes |  | Frequency of the interface
enabled | string | no | null | An option used by map-agent to maintain which backhaul STAs should be enabled upon dynamic backhaul link upgrade
onboarded | boolean | no | false | Whether WPS credentials have successfully been received over the interface
ssid | string | no | null | SSID provided with the WPS M8 credentials, will be used for the backhaul connection
key | string | no | null | Key provided with the WPS M8 credentials, will be used for the backhaul connection
encryption | string | no | null | Encryption provided with the WPS m8 credentials, will be used for the backhaul connection
bssid | string | no | null | BSSID to which the connection occured
priority | integer | no | 2 | Priority of the backhaul with respect to other backhaul STAs. The lower the better.
is_mld | boolean | no | false | Indicates whether this is the netdev
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.
ap | no | An AP interface (front or backhaul) | true |
name | type | required | default | description
ifname | string | yes |  | Interface name
band | string | yes |  | Frequency on which the interface operates
device | string | yes |  | Radio of which the interface belongs
btm_retry | integer | no | 3 | Number of BTM request retries
btm_retry_secs | integer | no | 5 | Time in seconds between BTM retries
assoc_ctrl_secs | integer | no | 60 | Duration in seconds for association control
ssid | string | no |  | SSID of the interface
key | string | no |  | Password to the SSID
encryption | string | no |  | Encryption for the SSID
enabled | boolean | no | true | Whether the AP should be enabled. If vendor extensions are compiled in enabled=0 maps to disabled=1 in wireless config.
vid | integer | no | 1 | VLAN ID tag handled by this interface
type | string | no |  | Human readable interface type. Backhaul (multi_ap=1), fronthaul (multi_ap=2) or combined (multi_ap=3)
disallow_bsta_profile | list | no |  | Disallow backhaul station connections of a certain profile.
disallow_assoc | boolean | no | false | Disallow association to this AP
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.
policy | no | Policy configuration values as provided by mapcontroller | false |
name | type | required | default | description
report_interval | integer | no | 0 | The interval at which AP Metrics shall be reported. Provided by report_metric_periodic from mapcontroller.
pvid | integer | no | 0 | Primary VLAN ID
pcp_default | integer | no | 0 | PCP for primary VLAN ID
report_scan | string | no |  | Reporting of independent channel scans.
report_sta_assocfails | string | no |  | Whether the agent should report association fails to the mapcontroller. NOT YET IMPLEMENTED
report_sta_assocfails_rate | string | no |  | Maximum reported failed association attempts per minute. NOT YET IMPLEMENTED
steer_exclude | list | no |  | Do not try to steer STA of specified mac address by any means.
steer_exclude_btm | list | no |  | Do not try to steer STA of specified macaddress by BTM request.
opclass | no | Channel preference for a certain operation class | true |
name | type | required | default | description
opclassid | integer | yes | 0 | The operating class to which the preference applies
preference | integer | yes | 15 | The preference of the provided channels, 15 is best, 0 is lowest
radio | string | yes |  | The radio on which the channels are managed
channel | list | yes |  | Channels to which the preference applies
dpp_chirp | no | DPP Chirping configuration | true |
name | type | required | default | description
device | string | no |  | The radio that the interface belongs to.
band | integer | no | 0 | Band of the interface to chirp on (2/5/6)
ifname | string | yes |  | Interface name of the backhaul station interface.
channel | list | yes |  | Channel on which to chirp on. If multiple list entries, it will iterate through these channels at the interval provided as the chirp interval.
chirp_interval | integer | no | 10 | The interval at which to send DPP chirp messages.
mld | no | Section storing MLD credentials. | true |
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.