mapcontroller.md

mapcontroller

section	description	multi	required	options
controller	Mapcontroller daemon Configuration	false	yes	name type required default description enabled boolean no true Enables mapcontroller daemon debug integer no 0 Mapcontroller debug level registrar integer no The bands on which mapcontroller acts as registrar, space separated resend_num integer no 0 Number of retry attempts for CMDUs which expect a response if none is received channel_plan integer no 0 Interval in seconds at which channel planning calculations will take place. 0 means disabled and a value less than than 180 will default to 180 allow_bgdfs integer no 0 Interval in seconds at which background CAC will be triggered. 0 means disabled and a value less than than 120 will default to 120 enable_ts boolean no false Enable traffic separation in the EasyMesh network. primary_vid integer no 0 Primary VID used for VLAN segregation. Today only 0 (vlan not supported) and 1 are supported. primary_pcp integer no 0 Default PCP used bcn_metrics_max_num integer no 10 Number of beacon metrics stored (per client). initial_channel_scan boolean no false Trigger a channel scan upon receiving initial radio scan capabilities. 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
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.
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 type string no fronthaul Interface type, may be set to fronthaul, backhaul or combined vid integer no 0 VLAN ID of the configured interface 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. 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 enabled boolean no false Enable rule or not type string yes dscp_pcp Rule type: dscp_pcp, mscs, scs or mgmt 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
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 steer_exclude list no List of clients to be excluded from steering. steer_exclude_btm list no List of clients to be excluded from BTM steering. report_scan integer no 1 Whether independent channel shall be reported. 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 0 The interval at which AP Metrics shall be reported. backhaul_ul_macaddr string no Mac address of the upstream device interface backhaul_dl_macaddr string no Mac address of the downstream device interface backhaul_type string no wifi or eth 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. 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 band string yes 2 or 5 macaddr string yes Mac address of the radio 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. rcpi_hysteresis_margin integer no 0 Threshold at which hysteresis will be reported. 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.
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.