CleanAir
Catalyst CenterLocation in GUI:
Design » Feature Templates » Wireless » CleanAir Configuration
Diagram
Section titled “Diagram”Classes
Section titled “Classes”catalyst_center
Section titled “catalyst_center”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| feature_ | Class | feature_ | No |
feature_templates (catalyst_center)
Section titled “feature_templates (catalyst_center)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| wireless | Class | wireless | No |
wireless (catalyst_center.feature_templates)
Section titled “wireless (catalyst_center.feature_templates)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| cleanair | List | cleanair | No |
cleanair (catalyst_center.feature_templates.wireless)
Section titled “cleanair (catalyst_center.feature_templates.wireless)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | max: 64, exclude: %&<>[]'/ | Yes | |
| description | String | No | ||
| radio_band | Choice | 2.4GHz, 5GHz, 6GHz | Yes | |
| enable | Boolean | true, false | No | false |
| device_ | Boolean | true, false | No | false |
| persistent_ | Boolean | true, false | No | false |
| interferers | Class | interferers | No |
cleanair (catalyst_center.feature_templates.wireless)
Section titled “cleanair (catalyst_center.feature_templates.wireless)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | Yes | ||
| description | String | No | ||
| radio_band | Choice | 2.4GHz, 5GHz, 6GHz | Yes | |
| enable | Boolean | true, false | No | false |
| device_ | Boolean | true, false | No | false |
| persistent_ | Boolean | true, false | No | false |
| interferers | Class | interferers | No |
interferers (catalyst_center.feature_templates.wireless.cleanair)
Section titled “interferers (catalyst_center.feature_templates.wireless.cleanair)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| ble_beacon | Boolean | true, false | No | |
| bluetooth_ | Boolean | true, false | No | |
| bluetooth_ | Boolean | true, false | No | |
| continuous_ | Boolean | true, false | No | |
| generic_dect | Boolean | true, false | No | |
| generic_tdd | Boolean | true, false | No | |
| jammer | Boolean | true, false | No | |
| microwave_oven | Boolean | true, false | No | |
| motorola_canopy | Boolean | true, false | No | |
| si_fhss | Boolean | true, false | No | |
| spectrum_ | Boolean | true, false | No | |
| spectrum_ | Boolean | true, false | No | |
| spectrum_802154 | Boolean | true, false | No | |
| spectrum_ | Boolean | true, false | No | |
| super_ag | Boolean | true, false | No | |
| video_camera | Boolean | true, false | No | |
| wimax_fixed | Boolean | true, false | No | |
| wimax_mobile | Boolean | true, false | No | |
| xbox | Boolean | true, false | No |
CleanAir feature templates define spectrum-intelligence settings on a per radio band basis (2.4 GHz, 5 GHz, or 6 GHz). They detect and classify RF interferers such as microwave ovens, jammers, and Bluetooth devices, and can be attached to Wireless Network Profiles via their feature_templates list.
Note: The wireless feature template API is not available on Catalyst Center 2.3.7.x: on 2.3.7.11 every
/dna/intent/api/v1/featureTemplates/wireless/*call returns404 BAPI not found, so CleanAir templates cannot be created there. Verified on Catalyst Center 3.2.2.
Note: Template names can be at most 64 characters long and must not contain
%,&,<,>,[,],'or/.
Examples
Section titled “Examples”Example-1: 2.4 GHz CleanAir Template for Common Office Interferers
Section titled “Example-1: 2.4 GHz CleanAir Template for Common Office Interferers”Basic 2.4 GHz CleanAir template with reporting and persistent device propagation enabled, detecting the most common interferers found in office environments.
catalyst_center: feature_templates: wireless: cleanair: - name: CLEANAIR_2_4GHZ_OFFICE description: CleanAir detection for 2.4 GHz office deployments radio_band: "2.4GHz" enable: true device_reporting: true persistent_device_propagation: true interferers: bluetooth_paging_inquiry: true bluetooth_sco_acl: true microwave_oven: true jammer: true continuous_transmitter: trueExample-2: 5 GHz CleanAir Template for Wide-Band Interferers
Section titled “Example-2: 5 GHz CleanAir Template for Wide-Band Interferers”5 GHz CleanAir template tuned for enterprise environments, detecting wide-band and continuous interferers relevant to the 5 GHz spectrum.
catalyst_center: feature_templates: wireless: cleanair: - name: CLEANAIR_5GHZ_ENTERPRISE description: CleanAir detection for 5 GHz enterprise deployments radio_band: "5GHz" enable: true device_reporting: true persistent_device_propagation: false interferers: continuous_transmitter: true generic_dect: true generic_tdd: true jammer: true si_fhss: true super_ag: true video_camera: true wimax_fixed: true wimax_mobile: trueExample-3: 2.4 GHz CleanAir Template Detecting All Interferer Classes
Section titled “Example-3: 2.4 GHz CleanAir Template Detecting All Interferer Classes”Comprehensive 2.4 GHz CleanAir template enabling detection of all supported interferer classes for maximum spectrum visibility.
catalyst_center: feature_templates: wireless: cleanair: - name: CLEANAIR_2_4GHZ_FULL description: Full interferer detection for 2.4 GHz radio_band: "2.4GHz" enable: true device_reporting: true persistent_device_propagation: true interferers: ble_beacon: true bluetooth_paging_inquiry: true bluetooth_sco_acl: true continuous_transmitter: true generic_dect: true generic_tdd: true jammer: true microwave_oven: true motorola_canopy: true si_fhss: true spectrum_80211_fh: true spectrum_80211_non_standard_channel: true spectrum_802154: true spectrum_inverted: true super_ag: true video_camera: true wimax_fixed: true wimax_mobile: true xbox: trueExample-4: 6 GHz CleanAir Template
Section titled “Example-4: 6 GHz CleanAir Template”6 GHz CleanAir template. continuous_transmitter is the only interferer class that applies to the 6 GHz band.
catalyst_center: feature_templates: wireless: cleanair: - name: CLEANAIR_6GHZ description: CleanAir detection for 6 GHz radio_band: "6GHz" enable: true device_reporting: true persistent_device_propagation: true interferers: continuous_transmitter: trueAttaching to a Wireless Network Profile
Section titled “Attaching to a Wireless Network Profile”A CleanAir template only takes effect once it is attached to a Wireless Network Profile. Reference the template by its name in the profile’s feature_templates list:
catalyst_center: feature_templates: wireless: cleanair: - name: CLEANAIR_2_4GHZ_OFFICE description: CleanAir detection for 2.4 GHz office deployments radio_band: 2.4GHz enable: true device_reporting: true persistent_device_propagation: true interferers: microwave_oven: true jammer: true design: network_profiles: wireless: - name: CAMPUS_WIRELESS_PROFILE feature_templates: - CLEANAIR_2_4GHZ_OFFICENote: The
enablefield is the master switch for the CleanAir configuration — it must be set totruefor the feature (including any configuredinterferers) to take effect. Whenenableisfalse, the template is provisioned but CleanAir remains disabled and the interferer detection settings have no effect.
Note: Interferer keys under
interferersare radio-band-specific. Only configure interferers that apply to the template’sradio_band:
Interferer 2.4GHz 5GHz 6GHz ble_beacon,bluetooth_,paging_ inquiry bluetooth_,sco_ acl microwave_oven,spectrum_,80211_ fh spectrum_802154,xbox✓ generic_dect,generic_tdd,jammer,motorola_canopy,si_fhss,spectrum_,80211_ non_ standard_ channel spectrum_,inverted super_ag,video_camera,wimax_fixed,wimax_mobile✓ ✓ continuous_transmitter ✓ ✓ ✓ CleanAir templates are referenced from wireless network profiles by adding the template
nameto the profile’sfeature_templateslist.
Note: Interferers that are not set under
interferersare stored asfalse(detection off), not as the Catalyst Center per-band defaults. List every interferer class that should be detected.
Note: A wireless network profile can hold only one CleanAir template per radio band. A second template for the same band in one profile is rejected (
NCND00049).
Note: Template and profile changes reach a wireless controller only when the controller is provisioned again. After changing a CleanAir template that is already in use, set the controller’s
state: REPROVISION(and back toPROVISIONafterwards). Detaching a template from a profile, deleting it, or un-provisioning the controller does not revert the CleanAir settings already pushed to the controller.
CleanAir feature templates define spectrum-intelligence settings on a per radio band basis (2.4 GHz, 5 GHz, or 6 GHz). They detect and classify RF interferers such as microwave ovens, jammers, and Bluetooth devices, and can be attached to Wireless Network Profiles via their feature_templates list.
Examples
Section titled “Examples”Example-1: 2.4 GHz CleanAir Template for Common Office Interferers
Section titled “Example-1: 2.4 GHz CleanAir Template for Common Office Interferers”Basic 2.4 GHz CleanAir template with reporting and persistent device propagation enabled, detecting the most common interferers found in office environments.
catalyst_center: feature_templates: wireless: cleanair: - name: CLEANAIR_2_4GHZ_OFFICE description: CleanAir detection for 2.4 GHz office deployments radio_band: "2.4GHz" enable: true device_reporting: true persistent_device_propagation: true interferers: bluetooth_paging_inquiry: true bluetooth_sco_acl: true microwave_oven: true jammer: true continuous_transmitter: trueExample-2: 5 GHz CleanAir Template for Wide-Band Interferers
Section titled “Example-2: 5 GHz CleanAir Template for Wide-Band Interferers”5 GHz CleanAir template tuned for enterprise environments, detecting wide-band and continuous interferers relevant to the 5 GHz spectrum.
catalyst_center: feature_templates: wireless: cleanair: - name: CLEANAIR_5GHZ_ENTERPRISE description: CleanAir detection for 5 GHz enterprise deployments radio_band: "5GHz" enable: true device_reporting: true persistent_device_propagation: false interferers: continuous_transmitter: true generic_dect: true generic_tdd: true jammer: true si_fhss: true super_ag: true video_camera: true wimax_fixed: true wimax_mobile: trueExample-3: 2.4 GHz CleanAir Template Detecting All Interferer Classes
Section titled “Example-3: 2.4 GHz CleanAir Template Detecting All Interferer Classes”Comprehensive 2.4 GHz CleanAir template enabling detection of all supported interferer classes for maximum spectrum visibility.
catalyst_center: feature_templates: wireless: cleanair: - name: CLEANAIR_2_4GHZ_FULL description: Full interferer detection for 2.4 GHz radio_band: "2.4GHz" enable: true device_reporting: true persistent_device_propagation: true interferers: ble_beacon: true bluetooth_paging_inquiry: true bluetooth_sco_acl: true continuous_transmitter: true generic_dect: true generic_tdd: true jammer: true microwave_oven: true motorola_canopy: true si_fhss: true spectrum_80211_fh: true spectrum_80211_non_standard_channel: true spectrum_802154: true spectrum_inverted: true super_ag: true video_camera: true wimax_fixed: true wimax_mobile: true xbox: trueAttaching to a Wireless Network Profile
Section titled “Attaching to a Wireless Network Profile”A CleanAir template only takes effect once it is attached to a Wireless Network Profile. Reference the template by its name in the profile’s feature_templates list:
catalyst_center: feature_templates: wireless: cleanair: - name: CLEANAIR_2_4GHZ_OFFICE description: CleanAir detection for 2.4 GHz office deployments radio_band: "2.4GHz" enable: true device_reporting: true persistent_device_propagation: true interferers: microwave_oven: true jammer: true
network_profiles: wireless: - name: CAMPUS_WIRELESS_PROFILE feature_templates: - CLEANAIR_2_4GHZ_OFFICENote: The
enablefield is the master switch for the CleanAir configuration — it must be set totruefor the feature (including any configuredinterferers) to take effect. Whenenableisfalse, the template is provisioned but CleanAir remains disabled and the interferer detection settings have no effect.
Note: Interferer keys under
interferersare radio-band-specific. Only configure interferers that apply to the template’sradio_band:
Interferer 2.4GHz 5GHz 6GHz ble_beacon,bluetooth_,paging_ inquiry bluetooth_,sco_ acl microwave_oven,spectrum_,80211_ fh spectrum_802154,xbox✓ generic_dect,generic_tdd,jammer,motorola_canopy,si_fhss,spectrum_,80211_ non_ standard_ channel spectrum_,inverted super_ag,video_camera,wimax_fixed,wimax_mobile✓ ✓ continuous_transmitter ✓ ✓ ✓ CleanAir templates are referenced from wireless network profiles by adding the template
nameto the profile’sfeature_templateslist.