"description":"The bands on which mapcontroller acts as registrar, space separated"
"default":"",
},
"description":"The bands on which mapcontroller acts as registrar, space separated"
{
},
"name":"resend_num",
{
"type":"integer",
"name":"enable_sta_steer",
"required":"no",
"type":"boolean",
"default":"0",
"required":"no",
"description":"Number of retry attempts for CMDUs which expect a response if none is received"
"default":"0",
},
"description":"Whether controller mandated RCPI based STA steering shall be enabled"
{
},
"name":"channel_plan",
{
"type":"integer",
"name":"enable_bsta_steer",
"required":"no",
"type":"boolean",
"default":"0",
"required":"no",
"description":"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"
"default":"0",
},
"description":"Whether controller mandated RCPI based backhaul STA steering shall be enabled"
{
},
"name":"allow_bgdfs",
{
"type":"integer",
"name":"resend_num",
"required":"no",
"type":"integer",
"default":"0",
"required":"no",
"description":"Interval in seconds at which background CAC will be triggered. 0 means disabled and a value less than than 120 will default to 120"
"default":"0",
},
"description":"Number of retry attempts for CMDUs which expect a response if none is received"
{
},
"name":"enable_ts",
{
"type":"boolean",
"name":"use_bcn_metrics",
"required":"no",
"type":"boolean",
"default":false,
"required":"no",
"description":"Enable traffic separation in the EasyMesh network."
"default":false,
},{
"description":"If beacon metrics are to be used to get RCPI values to APs for steering"
"name":"primary_vid",
},
"type":"integer",
{
"required":"no",
"name":"steer_module",
"default":"0",
"type":"list",
"description":"Primary VID used for VLAN segregation. Today only 0 (vlan not supported) and 1 are supported."
"required":"no",
},
"default":"",
{
"description":"Pluggable steering algorithm. Plugin .so files are loaded from /usr/lib/mapcontroller"
"name":"primary_pcp",
},
"type":"integer",
{
"required":"no",
"name":"channel_plan",
"default":"0",
"type":"integer",
"description":"Default PCP used"
"required":"no",
},
"default":"0",
{
"description":"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"
"name":"bcn_metrics_max_num",
},
"type":"integer",
{
"required":"no",
"name":"allow_bgdfs",
"default":"10",
"type":"integer",
"description":"Number of beacon metrics stored (per client)."
"required":"no",
},
"default":"0",
{
"description":"Interval in seconds at which background CAC will be triggered. 0 means disabled and a value less than than 120 will default to 120"
"name":"initial_channel_scan",
},
"type":"boolean",
{
"required":"no",
"name":"enable_ts",
"default":false,
"type":"boolean",
"description":"Trigger a channel scan upon receiving initial radio scan capabilities."
"required":"no",
}
"default":false,
]
"description":"Enable traffic separation in the EasyMesh network."
},
}
{
]
"section":"sta_steering",
},
"description":"STA Steer plugin configuration",
{
"multi":true,
"section":"ap",
"required":"no",
"description":"Wireless credentials to be configured",
"options":[{
"multi":true,
"name":"enabled",
"required":"no",
"type":"boolean",
"options":[
"required":"no",
{
"default":false,
"name":"band",
"description":"Enable this STA steering section, only one may be active at any given time. If multiple are enabled, the first section will take affect."
"type":"integer",
},{
"required":"yes",
"name":"enable_sta_steer",
"default":"",
"type":"boolean",
"description":"Band for which the credentials applies"
"required":"no",
},
"default":false,
{
"description":"Enable STA steering when this section is loaded."
"name":"ssid",
},{
"type":"string",
"name":"enable_bsta_steer",
"required":"no",
"type":"boolean",
"default":"",
"required":"no",
"description":"SSID of the configured AP"
"default":false,
},
"description":"Enable bSTA steering when this section is loaded."
{
},{
"name":"encryption",
"name":"use_bcn_metrics",
"type":"string",
"type":"boolean",
"required":"no",
"required":"no",
"default":"sae-mixed",
"default":false,
"description":"Encryption for the credentials. Defaults to sae-mixed for fronthauls and sae for backhauls"
"description":"Use beacon metric reports for steering decision."
},
},{
{
"name":"use_usta_metrics",
"name":"key",
"type":"boolean",
"type":"string",
"required":"no",
"required":"yes",
"default":false,
"default":"",
"description":"Use un-associated STA metrics for steering decision."
"description":"Password for the SSID"
},{
},
"name":"bandsteer",
{
"type":"boolean",
"name":"type",
"required":"no",
"type":"string",
"default":false,
"required":"no",
"description":"Allow steering between different bands."
"default":"fronthaul",
},{
"description":"Interface type, may be set to fronthaul, backhaul or combined"
"name":"diffsnr",
},
"type":"integer",
{
"required":"no",
"name":"vid",
"default":"8",
"type":"integer",
"description":"RCPI improvement towards new AP required in order to trigger steering decision."
"required":"no",
}]
"default":"0",
},
"description":"VLAN ID of the configured interface"
{
},
"section":"ap",
{
"description":"Wireless credentials to be configured",
"name":"disallow_bsta",
"multi":true,
"type":"list",
"required":"no",
"required":"no",
"options":[{
"default":"0",
"name":"band",
"description":"List of profiles to disallow connection over the interface"
"type":"integer",
},
"required":"yes",
{
"default":"",
"name":"enabled",
"description":"Band for which the credentials applies"
"type":"boolean",
},
"required":"no",
{
"default":true,
"name":"ssid",
"description":"If false, do not start beaconing on this AP (effectively disabled)"
"type":"string",
}
"required":"no",
]
"default":"",
},
"description":"SSID of the configured AP"
{
},
"section":"node",
{
"description":"Represents an ieee1905 device in the network. Contains node-specific info and policies",
"name":"encryption",
"required":"no",
"type":"string",
"multi":true,
"required":"no",
"options":[
"default":"sae-mixed",
{
"description":"Encryption for the credentials. Defaults to sae-mixed for fronthauls and sae for backhauls"
"name":"agent_id",
},
"type":"string",
{
"required":"yes",
"name":"key",
"default":"",
"type":"string",
"description":"AL mac of the node represented by this section"
"required":"yes",
},
"default":"",
{
"description":"Password for the SSID"
"name":"steer_exclude",
},
"type":"list",
{
"required":"no",
"name":"type",
"default":"",
"type":"string",
"description":"List of clients to be excluded from steering."
"required":"no",
},
"default":"fronthaul",
{
"description":"Interface type, may be set to fronthaul, backhaul or combined"
"name":"steer_exclude_btm",
},
"type":"list",
{
"required":"no",
"name":"vid",
"default":"",
"type":"integer",
"description":"List of clients to be excluded from BTM steering."
"required":"no",
},
"default":"0",
{
"description":"VLAN ID of the configured interface"
"name":"report_scan",
},
"type":"integer",
{
"required":"no",
"name":"disallow_bsta",
"default":"0",
"type":"list",
"description":"Whether independent channel shall be reported."
"required":"no",
},
"default":"0",
{
"description":"List of profiles to disallow connection over the interface"
"name":"report_sta_assocfails",
},
"type":"integer",
{
"required":"no",
"name":"enabled",
"default":"0",
"type":"boolean",
"description":"Whether sta association fails shall be reported."
"required":"no",
},
"default":true,
{
"description":"If false, do not start beaconing on this AP (effectively disabled)"
"name":"report_sta_assocfails_rate",
},
"type":"integer",
{
"required":"no",
"name":"vendor_ie",
"default":"0",
"type":"list",
"description":"Maximum frequency at which sta association fails shall be reported."
"required":"no",
},
"default":"",
{
"description":"Pass any custom vendor extension as a part of the WSC M2."
"name":"report_metric_periodic",
}
"type":"integer",
]
"required":"no",
},
"default":"0",
{
"description":"The interval at which AP Metrics shall be reported."
"section":"node",
},
"description":"Represents an ieee1905 device in the network. Contains node-specific info and policies",
{
"required":"no",
"name":"disallow_bsta_p1",
"multi":true,
"type":"integer",
"options":[{
"required":"no",
"name":"agent_id",
"default":"0",
"type":"string",
"description":"Whether to disallow profile 1 bsta connections."
"required":"yes",
},
"default":"",
{
"description":"AL mac of the node represented by this section"
"name":"disallow_bsta_p2",
},
"type":"integer",
{
"required":"no",
"name":"steer_exclude",
"default":"0",
"type":"list",
"description":"Whether to disallow profile 2 bsta connections."
"required":"no",
},
"default":"",
{
"description":"List of clients to be excluded from steering."
"name":"backhaul_ul_macaddr",
},
"type":"string",
{
"required":"no",
"name":"steer_exclude_btm",
"default":"",
"type":"list",
"description":"Mac address of the upstream device interface"
"required":"no",
},
"default":"",
{
"description":"List of clients to be excluded from BTM steering."
"name":"backhaul_dl_macaddr",
},
"type":"string",
{
"required":"no",
"name":"report_scan",
"default":"",
"type":"integer",
"description":"Mac address of the downstream device interface"
"required":"no",
},
"default":"0",
{
"description":"Whether independent channel shall be reported."
"name":"backhaul_type",
},
"type":"string",
{
"required":"no",
"name":"report_sta_assocfails",
"default":"",
"type":"integer",
"description":"wifi or eth"
"required":"no",
},
"default":"0",
{
"description":"Whether sta association fails shall be reported."
"name":"primary_vid",
},
"type":"integer",
{
"required":"no",
"name":"report_sta_assocfails_rate",
"default":"1",
"type":"integer",
"description":"Primary VID used for VLAN segregation"
"required":"no",
},
"default":"0",
{
"description":"Maximum frequency at which sta association fails shall be reported."
"name":"primary_pcp",
},
"type":"integer",
{
"required":"no",
"name":"report_metric_periodic",
"default":"0",
"type":"integer",
"description":"Default PCP used"
"required":"no",
},
"default":"0",
{
"description":"The interval at which AP Metrics shall be reported."
"name":"steer_disallow",
},
"type":"boolean",
{
"required":"no",
"name":"backhaul_ul_macaddr",
"default":false,
"type":"string",
"description":"Disallow steering to this node. NOT YET IMPLEMENTED"
"required":"no",
},
"default":"",
{
"description":"Mac address of the upstream device interface"
"name":"coordinated_cac",
},
"type":"boolean",
{
"required":"no",
"name":"backhaul_dl_macaddr",
"default":false,
"type":"string",
"description":"Disallow coordinated CAC to this node. NOT YET IMPLEMENTED"
"required":"no",
}
"default":"",
]
"description":"Mac address of the downstream device interface"
},
},
{
{
"section":"radio",
"name":"backhaul_type",
"description":"Represents a radio of a node.",
"type":"string",
"multi":true,
"required":"no",
"required":"no",
"default":"",
"options":[
"description":"wifi or eth"
{
},
"name":"agent_id",
{
"type":"string",
"name":"primary_vid",
"required":"yes",
"type":"integer",
"default":"",
"required":"no",
"description":"AL mac of the node which has this radio"
"default":"1",
},
"description":"Primary VID used for VLAN segregation"
{
},
"name":"band",
{
"type":"string",
"name":"primary_pcp",
"required":"yes",
"type":"integer",
"default":"",
"required":"no",
"description":"2 or 5"
"default":"0",
},
"description":"Default PCP used"
{
},
"name":"macaddr",
{
"type":"string",
"name":"steer_disallow",
"required":"yes",
"type":"boolean",
"default":"",
"required":"no",
"description":"Mac address of the radio"
"default":false,
},
"description":"Disallow steering to this node. OPTION NOT YET IMPLEMENTED"
"description":"Disallow coordinated CAC to this node. OPTION NOT YET IMPLEMENTED"
{
},
"name":"util_threshold",
{
"type":"integer",
"name":"traffic_separation",
"required":"no",
"type":"boolean",
"default":"0",
"required":"no",
"description":"Channel utilization threshold."
"default":false,
},
"description":"Enable traffic separation on this node. OPTION NOT YET IMPLEMENTED"
{
}
"name":"rcpi_threshold",
]
"type":"integer",
},
"required":"no",
{
"default":"0",
"section":"radio",
"description":"Indicate RCPI threshold used for agent-initiated steering. Defaults to 86 for 5GHz and 70 for 2.4GHz"
"description":"Represents a radio of a node.",
},
"multi":true,
{
"required":"no",
"name":"report_rcpi_threshold",
"options":[{
"type":"integer",
"name":"agent_id",
"required":"no",
"type":"string",
"default":"0",
"required":"yes",
"description":"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"
"default":"",
},
"description":"AL mac of the node which has this radio"
{
},
"name":"report_util_threshold",
{
"type":"integer",
"name":"band",
"required":"no",
"type":"string",
"default":"0",
"required":"yes",
"description":"Threshold at which utilization will be reported."
"default":"",
},
"description":"2 or 5"
{
},
"name":"rcpi_hysteresis_margin",
{
"type":"integer",
"name":"macaddr",
"required":"no",
"type":"string",
"default":"0",
"required":"yes",
"description":"Threshold at which hysteresis will be reported."
"default":"",
},
"description":"Mac address of the radio"
{
},
"name":"include_sta_stats",
{
"type":"integer",
"name":"steer_policy",
"required":"no",
"type":"integer",
"default":"0",
"required":"no",
"description":"Whether to include STA traffic stats TLV with the AP metrics response."
"description":"Whether to include associated STA link metrics TLV in the AP metrics response."
"default":"0",
}
"description":"Channel utilization threshold."
]
},
}
{
]
"name":"rcpi_threshold",
}
"type":"integer",
"required":"no",
"default":"0",
"description":"Indicate RCPI threshold used for agent-initiated steering. Defaults to 86 for 5GHz and 70 for 2.4GHz"
},
{
"name":"report_rcpi_threshold",
"type":"integer",
"required":"no",
"default":"0",
"description":"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"
},
{
"name":"report_util_threshold",
"type":"integer",
"required":"no",
"default":"0",
"description":"Threshold at which utilization will be reported."
},
{
"name":"rcpi_hysteresis_margin",
"type":"integer",
"required":"no",
"default":"0",
"description":"Threshold at which hysteresis will be reported."
},
{
"name":"include_sta_stats",
"type":"integer",
"required":"no",
"default":"0",
"description":"Whether to include STA traffic stats TLV with the AP metrics response."
},
{
"name":"include_sta_metric",
"type":"integer",
"required":"no",
"default":"0",
"description":"Whether to include associated STA link metrics TLV in the AP metrics response."
},
{
"name":"include_wifi6_sta_status",
"type":"boolean",
"required":"no",
"default":false,
"description":"Inclusion policy of Associated Wi-Fi 6 STA Status Report TLV."