Wi-Fi Data Elements

Specification
Version 2.1

This document may be used with the permission of Wi-Fi Alliance under the terms set forth herein.

By your use of the document, you are agreeing to these terms. Unless this document is clearly designated
as an approved specification, this document is a work in process and is not an approved Wi-Fi Alliance
specification. This document is subject to revision or removal at any time without notice. Information
contained in this document may be used at your sole risk. Wi-Fi Alliance assumes no responsibility for
errors or omissions in this document. This copyright permission does not constitute an endorsement of the
products or services. Wi-Fi Alliance trademarks and certification marks may not be used unless specifically
allowed by Wi-Fi Alliance.

Wi-Fi Alliance has not conducted an independent intellectual property rights ("IPR") review of this document
and the information contained herein, and makes no representations or warranties regarding IPR, including
without limitation patents, copyrights or trade secret rights. This document may contain inventions for which
you must obtain licenses from third parties before making, using or selling the inventions.

Wi-Fi Alliance owns the copyright in this document and reserves all rights therein. A user of this document
may duplicate and distribute copies of the document in connection with the authorized uses described
herein, provided any duplication in whole or in part includes the copyright notice and the disclaimer text set
forth herein. Unless prior written permission has been received from Wi-Fi Alliance, any other use of this
document and all other duplication and distribution of this document are prohibited. Unauthorized use,
duplication, or distribution is an infringement of Wi-Fi Alliance’s copyright.

NO REPRESENTATIONS OR WARRANTIES (WHETHER EXPRESS OR IMPLIED) ARE MADE BY WI-

FI ALLIANCE AND WI-FI ALLIANCE IS NOT LIABLE FOR AND HEREBY DISCLAIMS ANY DIRECT,
INDIRECT, PUNITIVE, SPECIAL, INCIDENTAL, CONSEQUENTIAL, OR EXEMPLARY DAMAGES
ARISING OUT OF OR IN CONNECTION WITH THE USE OF THIS DOCUMENT AND ANY
INFORMATION CONTAINED IN THIS DOCUMENT.

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Data Elements Specification v2.1

Document revision history

Version Date YYYY-MM-DD Remarks

0.0.15 2018-09-27 Draft release.

1.0 2019-02-28 Initial release.

2.0 2021-09-02 Added support for Wi-Fi 6, Wi-Fi EasyMesh Release 2 and Release 3.

2.1 2022-10-19 Added remote configuration

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 2 of 46
Data Elements Specification v2.1

Table of contents
1 INTRODUCTION .......................................................................................................................................................... 5
1.1 Scope ............................................................................................................................................................ 5
1.2 References .................................................................................................................................................... 5
1.3 Definitions and acronyms .............................................................................................................................. 6
1.3.1 Shall/should/may/might word usage ................................................................................................ 6
1.3.2 Conventions ..................................................................................................................................... 6
1.3.3 Abbreviations and acronyms ............................................................................................................ 6
1.3.4 Definitions ........................................................................................................................................ 7
2 ARCHITECTURE AND REQUIREMENTS ................................................................................................................... 9
2.1 Components .................................................................................................................................................. 9
2.1.1 Data Elements data model ............................................................................................................... 9
2.1.2 Data Elements Agent ....................................................................................................................... 9
2.1.3 Data Elements Collector-Controller ................................................................................................. 9
2.1.4 Mesh Intelligence ............................................................................................................................. 9
2.2 Topology ....................................................................................................................................................... 9
2.3 Capability requirements .............................................................................................................................. 10
3 ELEMENTS OF THE DATA ELEMENTS DATA MODEL .......................................................................................... 11
3.1 Element reporting requirements .................................................................................................................. 11
3.1.1 Requirements for reporting conditionally mandatory elements ..................................................... 11
3.1.2 Requirements for reporting channel scans .................................................................................... 12
3.1.3 Requirements for reporting association, disassociation, and failed connection events ................ 12
3.2 Element description ..................................................................................................................................... 13
3.2.1 Network data model ....................................................................................................................... 13
3.2.2 AssociationEvent data model ......................................................................................................... 30
3.2.3 DissassociationEvent data model .................................................................................................. 31
3.2.4 FailedConnectionEvent data model ............................................................................................... 32
3.2.5 Encoding of the data model elements............................................................................................ 32
3.2.6 Data Elements JSON Schema ....................................................................................................... 42
3.2.7 Data Elements commands ............................................................................................................. 42
4 DATA ELEMENTS PROTOCOL................................................................................................................................. 44
4.1 Retrieval of data model elements (excluding event data) ........................................................................... 44
4.2 Retrieval of event data ................................................................................................................................ 44
4.3 Collection frequency.................................................................................................................................... 45
4.4 Remote Configuration ................................................................................................................................. 45

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 3 of 46
Data Elements Specification v2.1

List of tables
Table 1. Abbreviations and acronyms ......................................................................................................................... 6
Table 2. Definitions ..................................................................................................................................................... 8
Table 3. Elements of the Network data model .......................................................................................................... 13
Table 4. Elements of the AssociationEvent data model ........................................................................................... 30
Table 5. Elements of the DisassociationEvent data model ....................................................................................... 31
Table 6. Elements of the FailedConnectionEvent data model .................................................................................. 32
Table 7. Encoding of the data model elements ......................................................................................................... 32
Table 8. Correspondence between versioning ......................................................................................................... 42
Table 9. Remote Configuration Commands .............................................................................................................. 42

List of figures
Figure 1. System topology for Single-AP Data Elements device ................................................................................. 9
Figure 2. System topology for Multi-AP Data Elements device ................................................................................. 10
Figure 3. Example Remote Configuration Operation Handling .................................................................................. 45

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 4 of 46
Data Elements Specification v2.1

1 Introduction
This specification defines architecture, protocols, and functionality for interoperability of Data Elements devices.

1.1 Scope
The scope of the feature requirements is limited to that defined in this specification. Specifically, this specification provides
a standardized set of data model elements that describe Wi-Fi devices, radios, BSSs, and Stations (STAs) to enable
remote monitoring and troubleshooting of Wi-Fi issues. Residential Wi-Fi is the primary target market, but SMB or
operator-managed enterprise deployments will also benefit because these Data Elements are derived from IEEE
802.11[1].

1.2 References
Knowledge of the documents listed in this section is required for understanding this specification. If a reference includes a
date or a version identifier, only that specific version of the document is required. If the listing includes neither a date nor a
version identifier, then the latest version of the document is required. In the event of a conflict between this specification
and the following referenced documents, the contents of this specification take precedence.
[1] IEEE 802.11-2020, “IEEE Standard for Information Technology--Telecommunications and Information Exchange
between Systems - Local and Metropolitan Area Networks--Specific Requirements - Part 11: Wireless LAN Medium
Access Control (MAC) and Physical Layer (PHY) Specifications,” December 2020,
https://ieeexplore.ieee.org/document/9363693

[2] IEEE 802.11ax-2021, “IEEE Standard for Information Technology--Telecommunications and Information Exchange
between Systems Local and Metropolitan Area Networks--Specific Requirements Part 11: Wireless LAN Medium
Access Control (MAC) and Physical Layer (PHY) Specifications Amendment 1: Enhancements for High-Efficiency
WLAN,” May 2021, https://standards.ieee.org/standard/802_11ax-2021.html

[3] Wi-Fi PNM Common Collection Framework Technical Report, CableLabs, October 2017
https://apps.cablelabs.com/specification/WR-TR-PNM-WCCF

[4] Wi-Fi EasyMesh Specification, https://www.wi-fi.org/discover-wi-fi/specifications

[5] IETF RFC 4648, "The Base16, Base32, and Base64 Data Encodings", https://tools.ietf.org/html/rfc4648

[6] Data Elements YANG definition, located in the Data Elements Specification package,
https://www.wi-fi.org/discover-wi-fi/specifications

[7] IETF RFC 7951, JSON Encoding of Data Modeled with YANG, https://tools.ietf.org/html/rfc7951

[8] JSON Schema, http://json-schema.org/

[9] Data Elements JSON Schema located in the Data Elements Specification package,
https://www.wi-fi.org/discover-wi-fi/specifications

[10] IETF RFC 6020 YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)
https://tools.ietf.org/html/rfc6020

[11] IETF RFC 6021 Common YANG Data Types, https://tools.ietf.org/html/rfc6021

[12] IETF RFC 3339, Date and Time on the Internet: Timestamps, https://tools.ietf.org/html/rfc3339

[13] IETF RFC 8325, “Mapping Diffserv to IEEE 802.11,” February 2018, https://datatracker.ietf.org/doc/html/rfc8325

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 5 of 46
Data Elements Specification v2.1

[14] Wi-Fi Agile MultiBand Specification, December 2018, https://www.wi-fi.org/discover-wi-fi/specifications

[15] Broadband Forum TR-369, User Services Platform (USP), https://www.broadband-forum.org/technical-reports and
https://usp.technology/specification/ .

[16] Broadband Forum TR-181, Device Data Model, https://www.broadband-forum.org/technical-reports, and https://usp-
data-models.broadband-forum.org.

[17] Broadband Forum TR-106, Data Model Template for CWMP Endpoints and USP Agents, https://www.broadband-
forum.org/technical-reports.

1.3 Definitions and acronyms

1.3.1 Shall/should/may/might word usage
The words shall, should, and may are used intentionally throughout this document to identify the requirements for the
Data Elements program. The words can and might shall not be used to define requirements.
The word shall indicates a mandatory requirement. All mandatory requirements must be implemented to assure
interoperability with other Data Elements products.
The word should denotes a recommended approach or action.
The word may indicates a permitted approach or action with no implied preference.
The words might and can indicate a possibility or suggestion.

1.3.2 Conventions
The ordering of bits and bytes in the fields within elements, attributes and action frames shall follow the conventions in [1]
unless otherwise stated.
The word ignored shall be used to describe bits, bytes, fields, or parameters whose values are not verified by the
recipient.
The word reserved shall be used to describe objects (bits, bytes, or fields or their assigned values) whose usage and
interpretation will be defined in the future by this specification or by other specifications/bulletins. A reserved object shall
be set to zero unless otherwise stated. The recipient of a reserved object shall ignore its value unless that object becomes
defined at a later date. The sender of an object defined by this specification shall not use a reserved code value.

1.3.3 Abbreviations and acronyms

Table 1 defines the abbreviations and acronyms used throughout this document. Some are commonly used in
publications and standards defining the operation of wireless local area networks, while others have been generated by
Wi-Fi Alliance.
Table 1. Abbreviations and acronyms

Acronyms Definition

AKM Authentication and Key Management

ALID Abstraction layer ID

ANPI Average noise power indicator

AP Access point

BSS Basic service set

BSSID Basic service set identifier

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 6 of 46
Data Elements Specification v2.1

Acronyms Definition

BTM BSS Transition Management

CAC Channel Availability Check

CM Conditionally mandatory

DE Data Elements

DFS Dynamic Frequency Selection

DSCP Differentiated Services Code Point

EIRP Effective isotropic radiated power

EUI Extended unique identifier

HE High efficiency

HT High throughput

JSON JavaScript object notation

M Mandatory

N/A Not applicable

O Optional

OBSS Overlapping Basic Service Set

PCP Priority code point

PD Preamble Detection

RCPI Receive channel power indicator

RSSI Receive signal strength indicator

RUID Radio unique identifier

SMB Small and medium businesses

SRG Spatial Reuse Group

SSID Service set identifier

STA Non-AP station

TLV Type-length-value

Uint Unsigned integer

UP User Priority

VHT Very high throughput

VID VLAN ID

VLAN Virtual Local Area Network

WMM® Wi-Fi Multimedia™

1.3.4 Definitions
Table 2 list the definitions that are applicable to this document.

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 7 of 46
Data Elements Specification v2.1

Table 2. Definitions

Term Definition

Base64 Encoding scheme defined in IETF RFC 4648 [5]

Data Elements device A Single-AP or Multi-AP Controller that implements the Data Elements protocol

Data Elements Agent The Data Elements Agent role is to populate the Data Elements data model and make
the data available to a Data Elements Collector
Data Elements Collector The Data Elements Collector role is to retrieve the elements of the Data Elements data
model from a Data Elements Agent using the Data Elements protocol
Multi-AP Agent An EasyMersh compliant logical entity that executes AP control functions and provides
Multi-AP specific control information
Multi-AP Controller An EasyMesh compliant logical entity that implements logic for controlling the operation
of the Multi-AP network
Object A collection of the elements of the Data Element data model and their associated values

Remote Config Remote Configuration, performed by a Data Elements Collector issuing command(s) or
writing to a data element(s)
Single-AP An AP that does not implement any Multi-AP or EasyMesh functionality

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 8 of 46
Data Elements Specification v2.1

2 Architecture and requirements

Data Elements defines a data model to describe a standardized set of Wi-Fi diagnostic parameters and configuration
commands. A Data Elements Agent is defined to populate the data model and receive commands. A Data Elements
Collector retrieves the data from the Data Elements Agent via the Data Elements protocol described in section 4. The
primary purpose of the Data Elements protocol is to improve certification testing. It is anticipated that real world
consumption of Data Elements may make use of alternative protocols.

2.1 Components
2.1.1 Data Elements data model
The Data Elements data model, specified in section 3, defines the names, definitions and hierarchy for the Wi-Fi
diagnostics parameters in this specification.

2.1.2 Data Elements Agent

The role of the Data Elements Agent is to populate the Data Elements data model and make the data available to a Data
Elements Collector. A Data Elements Agent that is co-located with a Single-AP device interacts with the Wi-Fi drivers of a
standalone AP to populate the data model, whereas a Data Elements Agent co-located with an EasyMesh Controller
interacts with the EasyMesh Controller [4] to populate the data model. Section 3.1 defines the requirements for reporting
Conditionally Mandatory elements. Section 4.1 defines the requirements for the Data Elements Agent when transmitting
Mandatory, Conditionally Mandatory, Optional or Not Applicable elements.

2.1.3 Data Elements Collector-Controller

The role of the Data Elements Collector-Controller is to retrieve the elements of the Data Elements data model from a
Data Elements Agent, and to configure the Data Elements Agent using the Data Elements protocol. Remote configuration
can instruct an EasyMesh Controller to configure an EasyMesh network, via instructions to the Data Elements Agent.

2.1.4 Mesh Intelligence

Mesh Intelligence is an implementation specific function that drives EasyMesh management and control.

2.2 Topology
Figure 1 depicts the system topology for connecting a Data Elements Agent to a Single-AP.

Figure 1. System topology for Single-AP Data Elements device

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 9 of 46
Data Elements Specification v2.1

Figure 2 depicts the system topology for connecting a Data Elements Agent to an EasyMesh Controller.

Figure 2. System topology for Multi-AP Data Elements device

2.3 Capability requirements

This specification assumes that all the following AP functions and services are implemented by the Data Elements
devices.
Data Elements Agent co-located with a Single-AP:

• IEEE 802.11n (Wi-Fi 4) or IEEE 802.11ac (Wi-Fi 5) or IEEE 802.11ax (Wi-Fi 6)

Data Elements Agent co-located with an EasyMesh Controller:

• Wi-Fi CERTIFIED EasyMesh™ Controller

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 10 of 46
Data Elements Specification v2.1

3 Elements of the Data Elements data model

This section defines the elements of the Data Elements data model and their format.
The model has been derived in part from [1]. The Data Elements data model schema is normatively defined in YANG [10],
in the Data Elements YANG definition file [6].
To improve readability, this specification refers to the Data Elements object names generically. The Data Elements JSON
Schema file [9] defines the precise element object syntax.

3.1 Element reporting requirements

Any TimeStamp element (Network.TimeStamp, CurrentOperatingClassProfile.TimeStamp, BSS.TimeStamp,
STA.TimeStamp, ScanResult.TimeStamp, ChannelScan.TimeStamp, CACStatus.TimeStamp) shall use the typedef date-
and-time string format as defined in section 3 of [12] and shall include time-secfrac and time-offset as defined in section
5.6 of [12].
If the Data Elements Agent co-located with a Single-AP device, then the value of the
DataElements:Network.NumberOfDevices element shall be set to one. If the Data Elements Agent is co-located with an
EasyMesh Controller, then the value of DataElements:Network.NumberOfDevices shall be set to the number of
onboarded EasyMesh Agents in the Multi-AP network.
If the Data Elements Agent is co-located with an EasyMesh Controller, then the value of the DataElements:Device.ID
element shall be set to the ALID of the EasyMesh Agent.
If the Data Elements Agent is co-located with an EasyMesh Controller, then the value of the DataElements:Radio.ID
element shall be set to the RUID of the radio of the EasyMesh Agent.
If the Data Elements Agent is co-located with a Single-AP, then the scan result for the
DataElements:ScanResult.OpClassScanList array shall not include any BSSIDs belonging to that radio.
If the Data Elements Agent is co-located with a Single-AP, then the scan result for the
DataElements:ChannelScan.NeighborList array shall not include any BSSIDs belonging to that radio.

3.1.1 Requirements for reporting conditionally mandatory elements

The ability of a Data Elements Agent to report the value of certain elements of the Data Elements model is dependent on
either the capabilities of the Data Element Agent radio or external factors such as the capabilities of an associated STA or
a neighbor BSS. Such elements are Conditionally Mandatory (CM). The conditions for when these elements shall be
included are described below.
If a Data Elements Agent radio is HT capable, a Data Elements Agent shall include the Conditionally Mandatory
Capabilities.HTCapabilities element in the DataElements:Capabilities group for that radio with in-range values per Table
7.
If a Data Elements Agent radio is VHT capable, a Data Elements Agent shall include the Conditionally Mandatory
Capabilities.VHTCapabilities element in the DataElements:Capabilities group for that radio with in-range values per Table
7.
If Data Elements Agent radio is HE AP capable, a Data Elements Agent shall include the Conditionally Mandatory
Capabilities.WiFi6APRole element in the DataElements:Capabilities group for that radio with in-range values per Table 7.
If Data Elements Agent radio is HE STA capable, a Data Elements Agent shall include the Conditionally Mandatory
Capabilities.WiFi6bSTARole element in the DataElements:Capabilities group for that radio with in-range values per Table
7.
If an HT STA is associated to a HT capable Data Elements Agent radio and a DataElements:STA group is requested to
the Data Elements Agent, the Data Elements Agent shall include the Conditionally Mandatory STA.HTCapabilities
element with in-range values per Table 7.

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 11 of 46
Data Elements Specification v2.1

If an VHT STA is associated to a VHT capable Data Elements Agent radio and a DataElements:STA group is requested to
the Data Elements Agent, the Data Elements Agent shall include the Conditionally Mandatory STA.VHTCapabilities
element with in-range values per Table 7.
If an HE STA is associated to an HE capable Data Elements Agent radio and a DataElements:STA group is requested to
the Data Elements Agent, the Data Elements Agent shall include the Conditionally Mandatory STA.WiFi6Capabilities
element with in-range values per Table 7.
If a DataElements Agent collects an association event by a HT STA to an HT Capable Data Elements radio, then the Data
Elements Agent shall include the Conditionally Mandatory AssocEventData.HTCapabilities element with an in-range value
per Table 7.
If a DataElements Agent collects an association event by a VHT STA to a VHT Capable Data Elements radio, then the
Data Elements Agent shall include the Conditionally Mandatory AssocEventData.VHTCapabilities element with an in-
range value per Table 7.
If a DataElements Agent collects an association event by a HE STA to an HE Capable Data Elements radio, then the Data
Elements Agent shall include the Conditionally Mandatory AssocEventData.WiFi6Capabilities element with an in-range
value per Table 7.
If a Data Elements Agent radio receives a BSS Load information element (see Section 9.4.2.27 of [1]from neighboring
APs then the Data Elements Agent shall include the corresponding Conditionally Mandatory elements of the
DataElements:NeighborBSS grouping with in-range values per Table 7.

3.1.2 Requirements for reporting channel scans

To support reporting of DataElements:ChannelScan, an AP shall perform a channel scan for at least one operating class
and for at least two currently operable channels. If the Data Elements Agent is co-located with a Single-AP, then the
channel scan feature shall be supported. If a Data Elements Agent supports the channel scan feature, then it shall include
the Radio.ScanResultList element.
A ScanResult.OpClassScanList element shall contain a list of DataElements:OpClassScan entries. If the Data Elements
Agent radio scanned an operating class, then there shall be one entry for each operating class on which a scan has been
performed. If the Data Elements Agent radio did not scan an operating class, then there shall not be an OpClassScan
entry for that operating class in the OpClassScanList.
An OpClassScan.ChannelScanList element shall contain a list of DataElements:ChannelScan entries. If the Data
Elements Agent radio scanned a channel, then there shall be one entry for each channel on which a scan was performed.
If the Data Elements Agent radio did not scan a channel then there shall not be a DataElements:ChannelScan entry for
that channel in the ChannelScanList.
A ChannelScan.NeighborList shall contain the list of neighbor BSSs discovered by the scan of a channel. If the Data
Elements Agent radio did not discover a neighbor BSS on the channel, then the ChannelScan.NeighborList shall be set to
an empty list and the ChannelScan.NumberOfNeighbors shall be set to zero.

3.1.3 Requirements for reporting association, disassociation, and failed connection events
If an AP sends an (Re)Association Response frame to a STA and if the association succeeds, a Data Elements Agent
shall collect an association event (see Section 3.2.2).
If an AP sends an (Re)Association Response frame to a STA with status code other than success, a Data Elements Agent
shall collect a failed connection event (see Section 3.2.4).
If an AP sends an Authentication frame to a STA with status code indicating failure, a Data Elements Agent shall collect a
failed connection event (see Section 3.2.4).
If an AP determines that a STA has failed an association attempt, a Data Elements Agent shall collect a failed connection
event (see Section 3.2.4).
If an AP sends a Disassociation frame to a (previously) associated STA, the Data Elements Agent shall collect a
disassociation event.

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 12 of 46
Data Elements Specification v2.1

If an AP sends a Deauthentication frame to a (previously) associated STA, the Data Elements Agent shall collect a
disassociation event.
If an AP receives a Disassociation frame from a (previously) associated STA, the Data Elements Agent shall collect a
disassociation event.
If an AP receives a Deauthentication frame from a (previously) associated STA, the Data Elements Agent shall collect a
disassociation event.
If an AP determines that an associated STA is no longer associated to a BSS, the Data Elements Agent shall collect a
disassociation event.
In the case of a STA that roams, STA typically does Reassociation with the target AP, then the source AP becomes aware
(over the DS) that the roam occurred. Thus, the target AP will first raise an association event (see Section 3.2.2), then
subsequently the source AP will raise a disassociation event (see Section 3.2.3) even though the STA was not formally
disassociated from the source AP.

3.2 Element description

This section provides a description of the elements and their type definitions. Table 3, Table 4, Table 5, Table 6, and
Table 7 describe the data model objects and the corresponding elements.

3.2.1 Network data model

Elements denoted as readWrite are part of remote configuration. The "Write" column indicates if the parameter can be
writable on the DE Agent (readWrite) or not (readOnly) [16][17].
Table 3. Elements of the Network data model

Element Description Write Data Elements

Version
This object describes a Wi-Fi network readOnly R1
DataElements:Network
containing one or more devices.
A unique identifier for this particular Wi-Fi readOnly R1
Network.ID
network.

Network.TimeStamp The time this group was collected. readOnly R1

Network.ControllerID A unique identifier for a EasyMesh Controller. readOnly R1

Network.NumberOfDevices As defined in section 3.1. readOnly R1

Network.DeviceList The list of network devices. readOnly R1

List of STA for which MSCS operation is readOnly R2.1

Network.MSCSDisallowedStaList disallowed (per ALID)
List of STA for which SCS operation is readOnly R2.1
Network.SCSDisallowedStaList disallowed
Array of DataElements:NetworkSSID, with readOnly R2.1
Network.NetworkSSIDList entries consisting of SSID and Band

DataElements:Device This object describes a device. R1

A unique identifier for this particular device readOnly R1

Device.ID within the Wi-Fi network as defined in section
3.1.
The EasyMesh capabilities supported by this readOnly R1
Device.MultiAPCapabilities device as defined by the AP Capability TLV in
[4].

Device.NumberOfRadios The number of radios in this AP. readOnly R1

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 13 of 46
Data Elements Specification v2.1

Element Description Write Data Elements

Version

Device.RadioList The list of Radio objects. readOnly R1

The interval between the collection of readOnly R1

consecutive measurements of the most
Device.CollectionInterval
frequently updated Data Element from this
device (milliseconds).
Indicates whether a EasyMesh Agent or the readWrite R2.1 (was
single AP reports unsuccessful association readOnly in R2
Device.ReportUnsuccessfulAssociations attempts of client STAs.
Maximum rate for reporting unsuccessful readOnly R2
Device.MaxReportingRate association attempts (in attempts per minute).
[Deprecated] Multi-AP profile field (MAP R 1, R readOnly R2
2 or R 3). 1: Multi-AP Profile-1; 2: Multi-AP
Device.MultiAPProfile Profile-2, 3: Multi-AP Profile-3 [4].
AP Metrics Reporting Interval in seconds. 0: Do readWrite R2.1 (was
not report AP Metrics periodically; 1 – 255: AP readOnly in R2
Device.APMetricsReportingInterval Metrics reporting interval in seconds
A string identifying the manufacturer of the readOnly R2
Device.Manufacturer device.
A string Identifying the particular device that is readOnly R2
unique for the indicated model and
Device.SerialNumber manufacturer.
A string identifying the manufacturer model to readOnly R2
help the user more easily identify a particular
Device.ManufacturerModel piece of equipment.
A string identifying the software version readOnly R2
currently installed in the Access Point device
Device.SoftwareVersion (i.e., version of the overall firmware).
A string identifying the execution environment readOnly R2
Device.ExecutionEnv (operating system) in the device.
List of STAs for which local steering is readWrite R2.1 (was
Device.LocalSteeringDisallowedSTAList disallowed. readOnly in R2)
List of STAs for which BSS Transition readWrite R2.1 (was
Device.BTMSteeringDisallowedSTAList Management (BTM) steering is disallowed. readOnly in R2)
readWrite R2.1 (was
Device.Default8021Q Default 802.1Q Settings.
readOnly in R2)
Traffic Separation Policy, consisting of a list of readOnly R2
Device.TrafficSeparationPolicy
SSIDs with corresponding VLAN IDs.

Device.CACStatus Latest CAC Status Report from the device. readOnly R2

Device.Prioritization List of Service Prioritization rules. readOnly R2

Device.DSCPMap List of 64 PCP values (one octet per value) readOnly R2

corresponding to the DSCP markings 0x00 to
0x3F, ordered by increasing DSCP value. Each
octet is in the range 0x00 – 0x07. This table is
used to select a PCP value if a Service
Prioritization Rule specifies Rule Output: 0x08.
Device.MaxPrioritizationRules The maximum total number of service readOnly R2
prioritization rules supported by the Agent.
Device.PrioritizationSupport Indicates support for Service Prioritization readOnly R2.1

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 14 of 46
Data Elements Specification v2.1

Element Description Write Data Elements

Version
Device.MaxVIDs Max Total Number of unique VIDs the readOnly R2
EasyMesh Agent supports.
Device.IEEE1905Security IEEE 1905 security capabilities. readOnly R2

Two-character country code in which the readOnly R2.1

EasyMesh Agent is operating according to ISO
3166. The characters shall be encoded as UTF-
Device.CountryCode 8.
Device.ReportIndependentScans This parameter indicates the Channel Scan readWrite R2.1 (was
Reporting Policy, Report Independent Channel readOnly, and
Scans in ChannelScan
true: Report Independent Channel Scans, in R2)
false: Do not report Independent Channel
Scans unless explicitly requested in a Channel
Scan Request.
Device.AnticipatedChannels Array of Wi-Fi 6 [2] operating classes, and readOnly R2.1
channels within those operating classes, which
have anticipated channel preferences.
Device.AnticipatedChannelUsage Reports Wi-Fi 6 [2] anticipated medium usage readOnly R2.1
on channels (and subsets of those channels) on
which the device is operating.
Device.TrafficSeparationAllowed This parameter indicates if EasyMesh traffic readOnly R2.1
separation is allowed or disallowed.
Device.ServicePrioritizationAllowed This parameter indicates if EasyMesh service readOnly R2.1
prioritization is allowed or disallowed.
Device.STASteeringDisallowed Indicates if EasyMesh controller-initiated station readOnly R2.1
steering is allowed or disallowed on this agent.
Device.DFSEnable Indicates if Dynamic Frequency Selection (DFS) readOnly R2.1
is enabled or disabled.
Device.MaxUnsuccessfulAssociationReportingRate The maximum rate for reporting unsuccessful readWrite R2.1
association attempts (in attempts per minute).
Device.STASteeringState Indicates if EasyMesh [4] controller-initiated readOnly R2.1
station steering is disallowed or allowed on this
device.
true: EasyMesh controller-initiated station
steering disallowed;
false: EasyMesh controller-initiated station
steering allowed.
Device.CoordinatedCACAllowed Allow or disallow the use of EasyMesh [4] readWrite R2.1
Coordinated Channel Availability Check (CAC)
on this device.
This object describes a single physical radio R1
DataElements:Radio
within a specific AP
Unique ID for this radio as defined in section readOnly R1
Radio.ID
3.1.

Radio.Enabled Indicates whether this radio is enabled. readOnly R1

Describes the list of operating classes (selected readOnly R1

Radio.CurrentOperatingClasses from Table E-4 of [1]) of the current radio
operation.

Radio.NumberOfCurrOpClass The number of current operating classes. readOnly R1

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 15 of 46
Data Elements Specification v2.1

Element Description Write Data Elements

Version
An indicator of the average radio noise plus readOnly R1
interference power measured for the primary
Radio.Noise operating channel. Encoding as defined for
ANPI in section 11.10.9.4 of [1] Reserved: 221-
224.
The current total channel utilization on the readOnly R1
Radio.Utilization current primary channel of the radio as defined
by section 9.4.2.27 in [1]
The percentage of time (linearly scaled with 255 readOnly R1
representing 100%) the radio has spent on
individually or group addressed transmissions
Radio.Transmit by the AP. When more than one channel is in
use by BSS operating on the radio, then the
Transmit value is calculated only for the primary
channel.
The percentage of time (linearly scaled with 255 readOnly R1
representing 100%) the radio has spent on
receiving individually or group addressed
transmissions from any STA associated with
Radio.ReceiveSelf
any BSS operating on this radio. When more
than one channel is in use by BSS operating on
the radio, then the ReceiveSelf value is
calculated only for the primary channel.
The percentage of time (linearly scaled with 255 readOnly R1
representing 100%) the radio has spent on
receiving valid IEEE 802.11 PPDUs that are not
associated with any BSS operating on this
Radio.ReceiveOther
radio. When more than one channel is in use by
BSS operating on the radio, then the
ReceiveOther value is calculated only for the
primary channel.
Traffic Separation on combined fronthaul and readOnly R2
Radio.TrafficSeparationCombinedFronthaul Profile-1 [4] backhaul support.
Traffic Separation on combined Profile-1 readOnly R2
Radio.TrafficSeparationCombinedBackhaul backhaul and Profile-2 [4] backhaul support.
Steering Policy: 0: Agent Initiated Steering readWrite R2.1 (was
Disallowed; 1: Agent Initiated RCPI-based readOnly in R2)
Steering Mandated; 2: Agent Initiated RCPI-
Radio.SteeringPolicy based Steering Allowed.
Channel Utilization Threshold (defined per BSS readWrite R2.1 (was
Radio.ChannelUtilizationThreshold Load element section 9.4.2.27 of [1]). readOnly in R2)
RCPI Steering Threshold. 0 – 220: (encoded readWrite R2.1 (was
Radio.RCPISteeringThreshold per Table 9-176 of [1]). readOnly in R2)
Two-character country code in which the Multi- R2
AP Agent is operating according to ISO 3166.
The characters shall be encoded as UTF-8. Radio.Country
Radio.CountryCode This parameter is DEPRECATED in R2.1 Code
STA Metrics Reporting RCPI Threshold. 0:0: Do readWrite R2.1 (was
not report STA Metrics based on RCPI readOnly in R2)
threshold. 1 – 220: RCPI threshold (encoded
Radio.STAReportingRCPIThreshold per Table 9-176 of [1]).

STA Metrics Reporting RCPI Hysteresis Margin readWrite R2.1 (was

Radio.STAReportingRCPIHysteresisMarginOverride Override. 0: Use Agent's implementation- readOnly in R2)

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 16 of 46
Data Elements Specification v2.1

Element Description Write Data Elements

Version
specific default RCPI Hysteresis margin; >0:
RCPI hysteresis margin value. This field is
coded as an unsigned integer in units of
decibels (dB).
AP Metrics Channel Utilization Reporting readWrite R2.1 (was
Threshold. 0: Do not report AP Metrics based readOnly in R2)
on Channel utilization threshold; >0: AP Metrics
Channel Utilization Reporting Threshold (similar
to channel utilization measurement in 9.4.2.27
Radio.ChannelUtilizationReportingThreshold of [1]).
Associated STA Traffic Stats Inclusion Policy. 0: readWrite R2.1 (was
Do not include Associated STA Traffic Stats readOnly in R2)
TLV in AP Metrics Response; 1: Include
Associated STA Traffic Stats TLV in AP Metrics
Radio.AssociatedSTATrafficStatsInclusionPolicy Response.
Associated STA Link Metrics Inclusion Policy. 0: readWrite R2.1 (was
Do not include Associated STA Link Metrics readOnly in R2)
TLV in AP Metrics Response; 1: Include
Associated STA Link Metrics TLV in AP Metrics
Radio.AssociatedSTALinkMetricsInclusionPolicy Response.
A string identifying the Wi-Fi chip vendor of this readOnly R2
Radio.ChipsetVendor radio in the device.
The number of logical BSSs configured on this readOnly R1
Radio.NumberOfBSS
radio.

Radio.BSSList Array of BSS objects configured on this radio. readOnly R1

Radio.Capabilities Describes the Wi-Fi capabilities of the radio. readOnly R1

Contains the MAC address of the STA on this readOnly R1

Radio.BackhaulSta
radio providing Wi-Fi backhaul to this device.
The results of the latest scan for neighboring readOnly R1
Radio.ScanResultList
BSS by the radio.
The list of Non-AP STAs that have been readOnly R1
Radio.UnassociatedStaList discovered by the radio but are not associated
to any of the BSS operating on the radio.

Radio.NumberOfUnassocSta The number of unassociated STAs. readOnly R1

Radio.ScanCapability Channel scan capabilities of the radio. readOnly R2

Radio.CACCapability CAC capabilities of the radio. readOnly R2

Radio.APMetricsWiFi6 For EasyMesh [3], This is the Associated Wi-Fi6 readWrite R2.1
STA Status Inclusion Policy. 0 or false: Do not
include Associated Wi-Fi6 STA Status TLV [3]
in AP Metrics Response, 1 or true: Include
Associated Wi-Fi6 STA Status TLV in AP
Metrics Response.
Radio.DisAllowedOpClassChannels The operating classes, and list of channels for readWrite R2.1
each operating class, which are not allowed to
be used on this radio.
Radio.SpatialReuse Wi-Fi6 spatial reuse configuration [2] readOnly R2.1

Radio.TransmitPowerLimit This is the upper limit on nominal transmit readOnly R2.1

Equivalent Isotropically adiated Power (EIRP)
that this radio is allowed to use for the current

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 17 of 46
Data Elements Specification v2.1

Element Description Write Data Elements

Version
operating class. In units of decibels relative to 1
mW (dBm).
This object describes the capabilities of the readOnly R1
DataElements:Capabilities radio which may be different from the current
operational configuration.
Describes the HT capabilities of the radio as readOnly R1
Capabilities.HTCapabilities defined by the HT Capabilities TLV in section
17.2.8 of [4].
Describes the VHT capabilities of the radio as readOnly R1
Capabilities.VHTCapabilities defined by the VHT Capabilities TLV in section
17.2.9 of [4].
[Deprecated] Describes the HE capabilities of readOnly R1
Capabilities.HECapabilities the radio as defined by the HE Capabilities TLV
in section 17.2.10 of [4].
Capabilities.WiFi6APRole Describes the Wi-Fi 6 capabilities for the AP readOnly R2
role.
Capabilities.WiFi6bSTARole Describes the Wi-Fi 6 capabilities for the bSTA readOnly R2
role.
Capabilities.AKMFrontHaul AKM Suite Capabilities for the fronthaul BSS. readOnly R2

Capabilities.AKMBackhaul AKM Suite Capabilities for the backhaul BSS. readOnly R2.1

Describes the list of all operating classes readOnly R1

Capabilities.OperatingClasses (selected from Table E-4 of [1]) supported by
the radio.

Capabilities.NumberOfOpClass The number of all operating classes. readOnly R1

This object describes one of the possible readOnly R1

DataElements:CapableOperatingClassProfile
operating classes supported by the radio.
Operating class per Table E-4 in [1] that this readOnly R1
CapableOperatingClassProfile.Class
radio is capable of operating on
Maximum transmit power EIRP that this radio is readOnly R1
capable of transmitting in the current regulatory
CapableOperatingClassProfile.MaxTxPower domain for the operating class; represented as
2's complement signed integer in units of
decibels relative to 1 mW (dBm).
List of channel numbers which are statically readOnly R1
non-operable in the operating class (i.e., the
CapableOperatingClassProfile.NonOperable radio is never able to operate on these channels
- Other channels from this operating class which
are not listed here are supported by the radio.).

CapableOperatingClassProfile.NumberOfNonOperChan The number of non-operable channels. readOnly R1

This object describes one of the current readOnly R1

operating classes in use by the radio. One
operating class is indicated for each current
operating bandwidth (e.g., 80, 40 and 20 MHz
DataElements:CurrentOperatingClassProfile
operating classes for a radio operating a BSS
with supported bandwidth of 80 MHz). The
channel indicated for the 20 MHz operating
class is equal to the current primary channel.

CurrentOperatingClassProfile.TimeStamp The time this group was collected. readOnly R1

Operating class per Table E-4 in [1] that this readOnly R1

CurrentOperatingClassProfile.Class
radio is currently operating on.

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 18 of 46
Data Elements Specification v2.1

Element Description Write Data Elements

Version
The channel number in the operating class in readOnly R1
CurrentOperatingClassProfile.Channel the previous field that this radio is currently
operating on.
Nominal transmit power EIRP that this radio is readOnly R1
currently using for the current channel in the
CurrentOperatingClassProfile.TxPower operating class; represented as 2's complement
signed integer in units of decibels relative to 1
mW (dBm).
This object describes a single logical BSS readOnly R1
DataElements:BSS
operating on this radio.

BSS.BSSID The MAC address of the logical BSS (BSSID). readOnly R1

BSS.SSID The SSID in use for this BSS. readOnly R1

Whether the BSSID is currently enabled and readOnly R1

BSS.Enabled
Beacon frames being sent.
Time in seconds since the last change to the readOnly R1
BSS.LastChange
.Enabled value.

BSS.TimeStamp The time this group was collected. readOnly R1

BSS wide statistics for total unicast bytes readOnly R1

BSS.UnicastBytesSent
transmitted.
BSS wide statistics for total unicast bytes readOnly R1
BSS.UnicastBytesReceived
received.
BSS wide statistics for total multicast bytes readOnly R1
BSS.MulticastBytesSent
transmitted.
BSS wide statistics for total multicast bytes readOnly R1
BSS.MulticastBytesReceived
received.
BSS wide statistics for total broadcast bytes readOnly R1
BSS.BroadcastBytesSent
transmitted.
BSS wide statistics for total broadcast bytes readOnly R1
BSS.BroadcastBytesReceived
received.
Byte Counter Units, 0: bytes, 1: kibibytes (KiB), readOnly R2
BSS.ByteCounterUnits 2: mebibytes (MiB), 3: reserved.
Profile-1 [4] Backhaul STA association readOnly R2
BSS.Profile1bSTAsDisallowed disallowed, if true then disallowed.
Profile-2 [4] Backhaul STA association readOnly R2
BSS.Profile2bSTAsDisallowed disallowed, if true then disallowed.
The status of allowance of new client device readOnly R2
associations on this BSS.
0: No more associations allowed,
BSS.AssociationAllowanceStatus 1: Associations allowed.

BSS.STAList The list of STAs associated to this BSS. readOnly R1

The number of STAs currently associated to this readOnly R1

BSS.NumberOfSTA
BSS.
Estimated Service Parameters Information field readOnly R1
BSS.EstServiceParametersBE for AC=BE - defined per Figure 9-637 in [1] and
referenced in section 17.2.22 of [4].
Estimated Service Parameters Information field readOnly R1
BSS.EstServiceParametersBK for AC=BK - defined per Figure 9-637 in [1] and
referenced in section 17.2.22 of [4].

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 19 of 46
Data Elements Specification v2.1

Element Description Write Data Elements

Version
Estimated Service Parameters Information field readOnly R1
BSS.EstServiceParametersVI for AC=VI - defined per Figure 9-637 in [1] and
referenced in section 17.2.22 of [4].
Estimated Service Parameters Information field readOnly R1
BSS.EstServiceParametersVO for AC=VO - defined per Figure 9-637 in [1] and
referenced in section 17.2.22 of [4].
BSS.BackhaulUse Backhaul BSS; true: in use, false: not in use. In readOnly R2
[4] 0 is in use and 1 is not in use.
BSS.FronthaulUse Fronthaul BSS; true: in use, false: not in use. In readOnly R2
[4] 0 is in use and 1 is not in use.
BSS.R1disallowed Multi-AP Profile-1 [4] (R1) disallowed status; readOnly R2
true: disallowed, false: allowed. In [4] 0 is
allowed and 1 is disallowed.
BSS.R2disallowed Multi-AP Profile-2 [4] (R2) disallowed status; readOnly R2
true: disallowed, false: allowed. In [4] 0 is
allowed and 1 is disallowed.
BSS.MultiBSSID Multiple BSSID Set; true: configured, false: not- readOnly R2
configured. In [4], 1 is configured and 0 is not-
configured.
BSS.TransmittedBSSID Transmitted BSSID; true: transmitted, false: readOnly R2
non-transmitted. In [4], 1 is transmitted and 0 is
non-transmitted.
BSS.FronthaulAKMsAllowed Authentication and Key Management (AKM) readWrite R2.1
suites/security modes allowed at this BSS for
fronthaul. enum(psk, dpp, sae, psk+sae,
dpp+sae, dpp+psk+sae, SuiteSelector) as
defined in [4].
BSS.BackhaulAKMsAllowed Authentication and Key Management (AKM) readWrite R2.1
suites/security modes allowed at this BSS for
backhaul. enum(psk, dpp, sae, psk+sae,
dpp+sae, dpp+psk+sae, SuiteSelector) as
defined in [4].
BSS.QMDescriptor Array of QMDescriptor readOnly R2.1
Returns the currently in-force descriptors for
MSCS/SCS/DSCP Policy. For MSCS/SCS if
there was a “Change” or “Remove”, the old
descriptor that this changed/removed is no
longer returned. For DSCP Policy, only the
descriptors that are currently in-force with the
STA (i.e., STA accepted, and there was not any
subsequent teardown) are included.

DataElements:STA This object describes a single STA. R1

STA.MACAddress The MAC address of an associated STA. readOnly R1

STA.TimeStamp The time this group was collected. readOnly R1

STA.HTCapabilities HT capabilities of the associated STA. readOnly R1

STA.VHTCapabilities VHT capabilities of the associated STA. readOnly R1

[Deprecated] HE capabilities of the associated readOnly R1

STA.HECapabilities
STA.
STA.WiFi6Capabilities Wi-Fi 6 capabilities of the associated STA. readOnly R2

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 20 of 46
Data Elements Specification v2.1

Element Description Write Data Elements

Version
STA.ClientCapabilities The frame body of the most recently received readOnly R2
(Re)Association Request frame from this client,
as defined in Table 9-34 and Table 9-36 of [1] in
the order of the underlying referenced standard.
The data transmit rate in Kbps that was most readOnly R1
STA.LastDataDownlinkRate recently used for transmission of data PPDUs
from the access point to the associated STA.
The data transmit rate in Kbps that was most readOnly R1
STA.LastDataUplinkRate recently used for transmission of data PPDUs
from the associated STA to the AP.
The amount of time the radio has spent on the readOnly R1
STA.UtilizationReceive channel receiving data from this STA in
milliseconds.
The amount of time the radio has spent on the readOnly R1
STA.UtilizationTransmit channel transmitting data to this STA in
milliseconds.
Estimate of the MAC layer throughput in Mbps readOnly R1
achievable in the downlink if 100% of channel
STA.EstMACDataRateDownlink
airtime and BSS operating bandwidth were to
be available - as defined in section 10.3.1 of [4].
Estimate of the MAC layer throughput in Mbps readOnly R1
achievable in the uplink if 100% of channel
STA.EstMACDataRateUplink
airtime and BSS operating bandwidth were to
be available - as defined in section 10.3.1 of [4].
An indicator of radio signal strength of the uplink readOnly R1
from the associated STA to the access point -
measured in dBm. RCPI threshold (encoded per
STA.SignalStrength
Table 9-176 of [1] and described in Section
10.3.1 of [4]). Reserved: 221 - 255.
(See NOTE at the bottom of this table)
The time in seconds since the STA was readOnly R1
STA.LastConnectTime
associated.
The total number of bytes transmitted to the readOnly R1
STA.BytesSent
associated STA.
The total number of bytes received from the readOnly R1
STA.BytesReceived
associated STA.
The total number of packets transmitted to the readOnly R1
STA.PacketsSent
associated STA.
The total number of packets received from the readOnly R1
STA.PacketsReceived
associated STA.
The total number of outbound packets that readOnly R1
could not be transmitted to the associated STA
STA.ErrorsSent because of errors. These might be due to the
number of retransmissions exceeding the retry
limit or from other causes.
The total number of inbound packets from the readOnly R1
associated STA that contained errors
STA.ErrorsReceived
preventing them from being delivered to a
higher-layer protocol.
The total number of transmitted packets to the readOnly R1
STA.RetransCount
associated STA which were retransmissions.

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 21 of 46
Data Elements Specification v2.1

Element Description Write Data Elements

Version
Two retransmissions of the same packet results
in this counter incrementing by two.
Array of Measurement Report element(s) that readOnly R1
was received from the STA that constitute the
STA.MeasurementReport
latest Beacon report as defined in Figure 9-230
of [1].

STA.NumberOfMeasureReports The number of measurement report elements. readOnly R1

STA.IPV4Address IPV4 address assigned to the client. readOnly R1

STA.IPV6Address IPV6 address assigned to the client. readOnly R1

STA.Hostname Hostname assigned to the client. readOnly R1

STA.TIDQueueSizes List of traffic identifiers (TIDs) and queue size readOnly R2

for each TID.
STA.CellularDataPreference This is the Cellular Data Preference for an Agile readWrite R2.1
Multiband (AMB) capable STA This specifies
the use of the cellular data connection. [14]
Enumeration of: Excluded, Should not use,
should use.
STA.ReAssociationDelay Re-association Delay [14]. The time, readWrite R2.1
in seconds, after a BTM steer from AP1 to AP2
during which the station cannot go back and re-
associate with AP1.
This object describes the list of neighboring APs readOnly R1
DataElements:ScanResult discovered by a radio organized per OpClass
and Channel tuple.

ScanResult.OpClassScanList The list of Operating Classes scanned. readOnly R1

The number of Operating Classes scanned in readOnly R1

ScanResult.NumberOfOpClassScans
the last scan.

ScanResult.TimeStamp The timestamp of the last scan. readOnly R1

This object describes the result of an readOnly R1

DataElements:OpClassScan
OpClassChannelScan.
The operating class (selected from Table E-4 of readOnly R1
[1]) of the OpClass and Channel number Index
tuple scanned by the radio. For 2.4 and 5 GHz
OpClassScan.OperatingClass
bands, only 20 MHz operating classes are valid.
Note that the operating class identifies the band
and channel width.
The list of Channels scanned in this operating readOnly R1
OpClassScan.ChannelScanList
class.
The number of channels scanned in this readOnly R1
OpClassScan.NumberOfChannelScans
operating class.
This object describes the result of a readOnly R1
DataElements:ChannelScan
ChannelScan
The channel number of the channel scanned by readOnly R1
ChannelScan.Channel
the radio given the operating class.

ChannelScan.TimeStamp The timestamp of the last scan of the channel. readOnly R1

The current channel utilization measured by the readOnly R1

ChannelScan.Utilization radio on the scanned 20 MHz channel - as
defined by Section 9.4.2.27 in [1].

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 22 of 46
Data Elements Specification v2.1

Element Description Write Data Elements

Version
An indicator of the average radio noise plus readOnly R1
interference power measured on the channel
ChannelScan.Noise during a channel scan. Encoding as defined as
for ANPI in section 11.10.9.4 in [1] Reserved:
221-224.
The number of neighbor BSS discovered on this readOnly R1
ChannelScan.NumberOfNeighbors
channel.
The list of neighbor BSS discovered in this readOnly R1
ChannelScan.NeighborList
scan.
This object describes a neighbor BSS detected readOnly R1
DataElements:NeighborBSS
by channel scan.

NeighborBSS.BSSID The BSSID indicated by the neighboring BSS. readOnly R1

NeighborBSS.SSID The SSID indicated by the neighboring BSS. readOnly R1

An indicator of radio signal strength (RSSI) of readOnly R1

the Beacon or Probe Response frames of the
neighboring BSS as received by the radio
NeighborBSS.SignalStrength
measured in dBm. (RSSI is encoded per Table
9-176 of [1]). Reserved: 221 - 255.
(See NOTE at the bottom of this table)
Indicates the maximum bandwidth at which the readOnly R1
NeighborBSS.ChannelBandwidth neighbor BSS is operating, e.g., "20" or "40" or
"80" or "80+80" or "160" MHz.
The channel utilization reported by the readOnly R1
neighboring BSS per the BSS Load element if
NeighborBSS.ChannelUtilization
present in Beacon or Probe Response frames -
as defined by section 9.4.2.27 in [1].
The number of associated stations reported by readOnly R1
the neighboring BSS per the BSS Load element
NeighborBSS.StationCount
if present n Beacon or Probe Response frames
as defined by Section 9.4.2.27 in [1].
This object describes a single currently readOnly R1
DataElements:UnassociatedSTA
unassociated STA.
The MAC address of a Non-AP STA that has readOnly R1
been discovered by the radio but is not
UnassociatedSTA.MACAddress
associated to any of the BSS operating on the
radio.
An indicator of radio signal strength (RCPI) of readOnly R1
the uplink from the Non-AP STA - measured in
UnassociatedSTA.SignalStrength dBm. (RCPI threshold is encoded per Table 9-
176 of [1] and described in Section 10.3.2 of
[4]). Reserved: 221 - 255.
This object describes a Wi-Fi backhaul link used readOnly R1
DataElements:BackhaulSTA
in a EasyMesh Agent.
The MAC address of the logical STA sharing readOnly R1
BackhaulSTA.MACAddress
the radio for Wi-Fi backhaul.
This object describes the default 802.1Q readWrite R2.1 (was
DataElements:Default8021Q settings used in a EasyMesh Agent. readOnly in R2)
readWrite R2.1 (was
Default8021Q.PrimaryVID The primary 802.1Q C-TAG. readOnly in R2)
readWrite R2.1 (was
Default8021Q.DefaultPCP The default Priority Code Point (PCP). readOnly in R2)

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 23 of 46
Data Elements Specification v2.1

Element Description Write Data Elements

Version
This object describes the channel scan readOnly R2
DataElements:ScanCapability
capabilities of a EasyMesh Agent.
“On boot only” flag, indicates whether the readOnly R2
specified radio is capable only of “On boot”
scans. If true, then the radio shall perform a
Channel Scan at boot on each of operating
class and channel combinations specified in its
Channel Scan Capabilities and shall store the
ScanCapability.OnBootOnly scan results
Scan Impact of using this radio to perform a readOnly R2
scan. 0: No impact; 1: Reduced number of
spatial streams; 2: Time slicing impairment; 3:
ScanCapability.Impact Radio unavailable for >= 2 seconds.
Minimum Scan Interval, the minimum interval in readOnly R2
seconds between the start of two consecutive
ScanCapability.MinimumInterval channel scans on this radio.
A list of the operating classes (selected from readOnly R2
Table E-4 of [1]) and channel numbers that the
radio is capable of scanning. For 2.4 and 5 GHz
bands, only 20 MHz operating classes are valid.
Note that the operating class identifies the band
ScanCapability.OpClassList and channel width.
List objects describe CAC capabilities of a readOnly R2
radio. List of CAC method information for each
type of CAC that the radio can perform. Each
DataElements:CACCapability
type is defined by a method and time to
complete. For each type, the classes and
channels allowed are enumerated.
CAC method supported. 0: Continuous CAC; 1: readOnly R2
CACMethod.Method Continuous with dedicated radio; 2: MIMO
dimension reduced; 3: Time sliced CAC.
Number of seconds required to complete this readOnly R2
CACMethod.NumberOfSeconds
method of CAC.
The list of Operating Classes and Channels readOnly R2
CACMethod.OpClassList
supported for this method of CAC.
This object describes an operating class and readOnly R2
DataElements:OpClassChannels
the list of channels for that operating class.
Operating class for which the capability is being readOnly R2
OpClassChannels.OpClass
described, from Table E-4 in Annex E of [1].
Each list element describes a single channel readOnly R2
number in the Operating Class which is
OpClassChannels.ChannelList supported. An empty list indicates that the
Agent is capable of supporting all channels in
the Operating Class.
This object describes an operating class and readWrite R2.1
DataElements:DisAllowedOpClassChannels
the list of channels for that operating class.
Enables or disables disallowed operating readWrite R2.1
DisAllowedOpClassChannels.Enable
classes and channels.
Operating class for which the capability is being readWrite R2.1
DisAllowedOpClassChannels.OpClass
described, from Table E-4 in Annex E of [1].

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 24 of 46
Data Elements Specification v2.1

Element Description Write Data Elements

Version
Each list element describes a single channel readWrite R2.1
DisAllowedOpClassChannels.ChannelList number in the Operating Class which is
disallowed.
This object describes available channels readOnly R2
DataElements:CACAvailableChannel
identified by CAC.
Operating class of an Available Channel, from readOnly R2
CACAvailableChannel.OpClass Table E-4 in Annex E of [1]
Single channel number of an Available Channel readOnly R2
CACAvailableChannel.Channel in the given Operating class.
Minutes since CAC was completed identifying readOnly R2
Available Channel. Equals zero for non-DFS
CACAvailableChannel.Minutes channels.
This object describes channels identified by readOnly R2
DataElements:CACNonOccupancyChannel
CAC that may not be occupied.
Operating class of channel that is in the non- readOnly R2
CACNonOccupancyChannel.OpClass occupancy list, from Table E-4 in Annex E of [1]
Single channel number in the operating class on readOnly R2
CACNonOccupancyChannel.Channel which the radar was detected.
Seconds remaining in the non-occupancy readOnly R2
duration for the channel specified by the
CACNonOccupancyChannel.Seconds operating class and channel pair.

DataElements:CACActiveChannel This object describes ongoing CACs. readOnly R2

Operating class of channel that has ongoing readOnly R2

CACActiveChannel.OpClass CAC, from Table E-4 in Annex E of [1].
Single channel number in the operating class readOnly R2
CACActiveChannel.Channel that has an ongoing CAC.

CACActiveChannel.Countdown Seconds remaining to complete the CAC. readOnly R2

DataElements:CACStatus This object describes CAC status. readOnly R2

List of channels the EasyMesh Agent indicates readOnly R2

CACStatus.AvailableChannelList
as Available Channels.

CACStatus.NonOccupancyChannelList List of channels in the non-occupancy list. readOnly R2

List of class and channel pairs that have an readOnly R2

CACStatus.ActiveChannelList
active CAC ongoing.

CACStatus.TimeStamp The time this group was collected. readOnly R2

This object describes SSID to VLAN ID (VID) readOnly R2

DataElements:SSIDtoVIDMapping mappings.

SSIDtoVIDMapping.SSID SSID. readOnly R2

SSIDtoVIDMapping.VID VLAN ID. readOnly R2

DataElements.IEEE1905Security This object describes IEEE 1905 security readOnly R2

capabilities.
IEEE1905Security.OnboardingProtocol Onboarding protocols supported; 0: 1905 readOnly R2
Device Provisioning Protocol.
IEEE1905Security.IntegrityAlgorithm Message integrity algorithms supported. 0: readOnly R2
HMAC-SHA256.
IEEE1905Security.EncryptionAlgorithm Message encryption algorithms supported. 0: readOnly R2
AES-SIV.

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 25 of 46
Data Elements Specification v2.1

Element Description Write Data Elements

Version
DataElements.SPRule This object describes a Service Prioritization readOnly R2
Rule.
SPRule.ID Service Prioritization Rule Identifier. readOnly R2

SPRule.Precedence Rule Precedence – higher number means readOnly R2

higher priority. 0x00 – 0xFE.
SPRule.Output Rule Output. The value of, or method used to readOnly R2
select, the 802.1Q C-TAG PCP output value.
0x00 – 0x09.
SPRule.AlwaysMatch Rule Always Matches. readOnly R2

DataElements.WiFi6 This object describes Wi-Fi 6 High Efficiency readOnly R2

(HE) capabilities.
WiFi6.HE160 Support for HE 160 MHz. readOnly R2

WiFi6.HE8080 Support for HE 80+80 MHz. readOnly R2

WiFi6.MCSNSS Supported HE-MCS And NSS Set field as readOnly R2

defined in Figure 9-788d of [2]., Supported HE-
MCS And NSS Set field format. HE-MCS And
NSS Set field for 160MHz is present if 160MHz
is supported. HE-MCS And NSS Set field for
80+80MHz is present if 80+80MHz is
supported.
WiFi6.SUBeamformer Support for SU beamformer. readOnly R2

WiFi6.SUBeamformee Support for SU beamformee. readOnly R2

WiFi6.MUBeamformer Support for MU beamformer. readOnly R2

WiFi6.Beamformee80orLess Support for Beamformee STS ≤ 80 MHz. readOnly R2

WiFi6.BeamformeeAbove80 Support for Beamformee STS > 80 MHz. readOnly R2

WiFi6.ULMUMIMO Support for UL MU-MIMO. readOnly R2

WiFi6.ULOFDMA Support for UL OFDMA. readOnly R2

WiFi6.DLOFDMA Support for DL OFDMA. readOnly R2

WiFi6.MaxDLMUMIMO Max number of users supported per DL MU- readOnly R2

MIMO TX in an AP role.
WiFi6.MaxULMUMIMO Max number of users supported per UL MU- readOnly R2
MIMO RX in an AP role.
WiFi6.MaxDLOFDMA Max number of users supported per DL OFDMA readOnly R2
TX in an AP role.
WiFi6.MaxULOFDMA Max number of users supported per UL OFDMA readOnly R2
RX in an AP role.
WiFi6.RTS Support for RTS. readOnly R2

WiFi6.MURTS Support for MU RTS. readOnly R2

WiFi6.MultiBSSID Support for Multi-BSSID. readOnly R2

WiFi6.MUEDCA Support for MU EDCA. readOnly R2

WiFi6.TWTRequestor Support for TWT Requester. readOnly R2

WiFi6.TWTResponder Support for TWT Responder. readOnly R2

Support for EasyMesh configuration and readOnly R2.1

WiFi6.SpatialReuse reporting of BSS Color / Spatial Reuse

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 26 of 46
Data Elements Specification v2.1

Element Description Write Data Elements

Version
Support for Anticipated Channel Usage (ACU) readOnly R2.1
WiFi6.AnticipatedChannelUsage reporting
DataElements.AKMSuite This object describes AKM Suite Capabilities. readOnly R2

AKMSuite.OUI Any OUI value specified in Table 9-151 of [1]. readOnly R2

AKMSuite.Type Any suite type value specified in Table 9-151 of readOnly R2

[1].
DataElements.TIDQueue This object describes the queue size readOnly R2
capabilities of each TID.
TIDQueue.TID The TID of the corresponding Queue Size field. readOnly R2

TIDQueue.Size Queue Size for this TID. Its format is defined in readOnly R2
Table 9-10—QoS Control field [1].
DataElements.QMDescriptor QM Descriptor readOnly R2

QMDescriptor.BSSID BSSID of BSS for which this descriptor applies readOnly R2.1

QMDescriptor.ClientMac MAC address of STA for which this descriptor readOnly R2.1
applies
QMDescriptor.DescriptorElement Descriptor Element readOnly R2.1
One of:
• MSCS Descriptor element as described in
Section 9.4.2.243 of [1] or
• SCS Descriptor element as described in
Section 9.4.2.121 of [1] or
• QoS Management element (as described in
Section 9.4.2.94 of [1] and Section 6.3 of IETF
RFC 8325 [13])
Returns the currently in-force descriptors for
MSCS/SCS (i.e., if there was a “Change” or
“Remove”, the old descriptor that this
changed/removed is no longer returned)
DataElements:AnticipatedChannelUsage Anticipated Channel Usage grouping [2] readOnly R2.1

AnticipatedChannelUsage.OpClass The operating class per Table E-4 [1] readOnly R2.1

AnticipatedChannelUsage.Channel The channel number in the given operating readOnly R2.1

class of the channel on which the anticipated
channel usage is reported.
AnticipatedChannelUsage.ReferenceBSSID Reference BSSID. Start Time values in this readOnly R2.1
object are referenced to the Time Sync Function
(TSF) timer value indicated in the Timestamp
field in Beacon frames transmitted by this
BSSID on the channel.
DataElements:AnticipatedChannelUsageEntry This object reports an entry in the anticipated readOnly R2.1
channel usage grouping [2]
AnticipatedChannelUsage Entry.BurstStartTime Least significant 4 octets of the TSF timer of the readOnly R2.1
Reference BSSID, at the start of the anticipated
first burst of channel usage.
Note: a burst is a continuous or quasi-
continuous period of channel usage. For IEEE
802.11 transmissions, a burst might comprise
only one PPDU, or multiple closely spaced
PPDUs."

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 27 of 46
Data Elements Specification v2.1

Element Description Write Data Elements

Version
AnticipatedChannelUsageEntry.BurstLength Duration of each burst of channel usage in readOnly R2.1
microseconds.
AnticipatedChannelUsageEntry.Repetitions Number of repetitions of the burst of channel readOnly R2.1
usage; 0 = single burst, 2^32-1 =
indefinite/unknown
AnticipatedChannelUsageEntry.BurstInterval Interval between two successive bursts of readOnly R2.1
channel usage in microseconds; set to zero if
Repetitions field is zero
AnticipatedChannelUsageEntry.RUBitmask Bitmask of 26-tone Resource Units (RUs) readOnly R2.1
defined in Section 27.3.2.2 of [2], where the (i-
1)th bit position is set to one if the nominal
bandwidth of the channel usage corresponding
to this entry fully or partially overlaps with the
RUi, and is otherwise set to zero.
AnticipatedChannelUsageEntry.TransmitterIdentifier One of: readOnly R2.1
MAC address: if the entry corresponds to
channel usage by a single client STA
associated to an AP of the Agent;
BSSID: if the entry corresponds to channel
usage by multiple or unspecified client STAs
associated to an AP of the Agent
BSS Color: (first 42-bits are zero) if the channel
usage is caused by a source external to the
BSSs operated by the Agent and the BSSID
can’t be decoded (since frame sent at high
MCS) but the BSS Color in the PHY headers
could still be identified
Zero: if the channel usage is caused by a
source external to the BSSs operated by the
Agent
AnticipatedChannelUsageEntry.PowerLevel 2s complement signed integer indicating readOnly R2.1
maximum transmit power during each channel
usage burst in units of dBm; equal to 255 when
unknown or when the entry corresponds to
multiple transmitters with different transmit
powers
AnticipatedChannelUsageEntry.ChannelUsageReason The reason for this channel usage readOnly R2.1
0 = TWT schedule,
1 = TSPEC or other traffic stream with
predictable characteristics,
2 = Scheduler policy (if uplink, using Wi-Fi 6
trigger-based scheduling),
3 = IEEE 802.11 transmitter external to the
BSSs operated by the reporting Agent,
4 = Non-802.11 or unknown source,
255 = BSS non-usage (in this special case, a
burst is defined as a continuous period in which
the Agent ensures no transmissions by any of
its BSSs on the channel).
DataElements:SpatialReuse Spatial Reuse [2] readOnly R2.1

SpatialReuse.PartialBSSColor The value of the Partial BSS Color subfield of readOnly R2.1
the HEOperations.BSSColorInformation field

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 28 of 46
Data Elements Specification v2.1

Element Description Write Data Elements

Version
being transmitted by BSSs operating on this
radio.
SpatialReuse.BSSColor The value of the BSS Color subfield of the readOnly R2.1
HEOperations.BSSColorInformation field being
transmitted by BSSs operating on this radio.
SpatialReuse.HESIGASpatialReuseValue15Allowed Indicates if the Agent is allowed to set readOnly R2.1
HESIGA.SpatialReuse field to value 15
(PSR_AND_NON_SRG_OBSS_PD_PROHIBIT
ED) in HE PPDU transmissions of this radio.
SpatialReuse.SRGInformationValid This field indicates whether the SRG readOnly R2.1
Information fields (SRG OBSS PD Min Offset,
SRG OBSS PD Max Offset, SRG BSS Color
Bitmap and SRG Partial BSSID Bitmap) in this
TLV are valid.
SpatialReuse.NonSRGOffsetValid Indicates whether the Non-SRG OBSSPD Max readOnly R2.1
Offset field in this TLV is valid.
SpatialReuse.PSRDisallowed Indicates if the Agent is allowed to use readOnly R2.1
Parameterized Spatial Reuse (PSR)-based
Spatial Reuse for transmissions by the specified
radio.
SpatialReuse.NonSRGOBSSPDMaxOffset The value of readOnly R2.1
dot11NonSRGAPOBSSPDMaxOffset (i.e the
Non-SRG OBSSPD Max Offset value being
used to control the transmissions of the
specified radio).
This field is valid only if NonSRGOffsetValid
field is true.
SpatialReuse.SRGOBSSPDMinOffset The value of dot11SRGAPOBSSPDMinOffset readOnly R2.1
(i.e., the SRG OBSSPD Min Offset value being
used to control the transmissions of the
specified radio).
This field is valid only if SRGInformationValid is
true.
SpatialReuse.SRGOBSSPDMaxOffset The value of dot11SRGAPOBSSPDMaxOffset readOnly R2.1
(i.e., the SRG OBSSPD Max Offset value being
used to control the transmissions of the
specified radio).
This field is valid only if SRGInformationValid is
true.
SpatialReuse.SRGBSSColorBitmap The value of dot11SRGAPBSSColorBitmap readOnly R2.1
(i.e., the SRG BSS Color Bitmap being used to
control the tranmissions of the specified radio).
This field is valid only if SRGInformationValid is
true.
Note: See rules in section 26.10.2.3 of [17]
regarding the members of an SRG.
SpatialReuse.SRGPartialBSSIDBitmap The value of dot11SRGAPBSSIDBitmap (i.e., readOnly R2.1
the SRG Partial BSSID Color Bitmap being
used to control the transmissions of the
specified radio).
This field is valid only if SRGInformationValid is
true.

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 29 of 46
Data Elements Specification v2.1

Element Description Write Data Elements

Version
Note: See rules in section 26.10.2.3 of [17]
regarding the members of an SRG.
SpatialReuse.NeighborBSSColorInUseBitmap Bitmap of BSS colors of OBSSs that the HE AP readOnly R2.1
has identified by itself or via the autonomous
BSS Color collision reports received from
associated non-AP HE STAs
DataElements:NetworkSSID Network-wide fronthaul SSID(s) readOnly R2.1

NetworkSSID.SSID The SSID for fronthaul use across this Wi-Fi readOnly R2.1
Multi-AP network.
NetworkSSID.Band The band(s) (GHz) for which this SSID applies. readOnly R2.1
A list of enums; each list item is an enumeration
of:
• All (Applies to all bands)
• 2.4 (2.4 GHz band)
• 5 (The entire 5 GHz band)
• 6 (The entire 6 GHz band)
• 5_UNII_1 (5 GHz UNII-1 band, 5.15 to 5.25
GHz)
• 5_UNII_2 (5 GHz UNII-2 band, 5.25 to
5.725 GHz)
• 5_UNII_3 (5 GHz UNII-3 band, 5.725 to
5.85 GHz)
• 5_UNII_4 (5 GHz UNII-4 band, 5.85 to
5.925 GHz)
• 6_UNII_5 (6 GHz UNII-5 band, 5.925 to
6.425 GHz)
• 6_UNII_6 (6 GHz UNII-6 band, 6.425 to
6.525 GHz)
• 6_UNII_7 (6 GHz UNII-7 band, 6.525 to
6.875 GHz)
• 6_UNII_8 (6 GHz UNII-8 band, 6.875 to
7.125 GHz)
NOTE: STA.SignalStrength, NeighborBSS.SignalStrength, UnassociatedSTA.SignalStrength are defined in the relevant PHY
clause of 802.11 [1] and represent the strength of the received signal, noise and interference power.

3.2.2 AssociationEvent data model

Table 4. Elements of the AssociationEvent data model

Element Description Data

Elements
Version

DataElements:AssociationEvent This object describes an event generated when a STA associates to a BSS. R1

AssociationEvent.AssocData The data provided in the event when an association event is generated. R1

DataElements:AssociationEventData This object describes the data elements provided with an association event. R1

AssociationEventData.BSSID The MAC address of the logical BSS (BSSID) which is reporting the association event. R1

AssociationEventData.MACAddress The MAC address of an associated STA. R1

The status code sent to the STA in the latest Association Response frame as defined R1
AssociationEventData.StatusCode
by Table 9-50 in [1].

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 30 of 46
Data Elements Specification v2.1

Element Description Data

Elements
Version

AssociationEventData.HTCapabilities HT capabilities of the associated STA. R1

AssociationEventData.VHTCapabilities VHT capabilities of the associated STA. R1

AssociationEventData.HECapabilities [Deprecated] HE capabilities of the associated STA. R1

AssociationEventData.WiFi6Capabilities Wi-Fi 6 capabilities of the associated STA. R2

AssociationEventData.ClientCapabilities The frame body of the most recently received (Re)Association Request frame from this R2
client, as defined in Table 9-34 and Table 9-36 of [1] in the order of the underlying
referenced standard.

3.2.3 DissassociationEvent data model

Table 5. Elements of the DisassociationEvent data model

Element Description Data

Elements
Version

DataElements:DisassociationEvent This object describes an event generated when a STA disassociates from a BSS. R1

DisassociationEvent.DisassocData The data provided in the event when a disassociation event is generated. R1

DataElements:DisassociationEventData This object describes the data elements provided with a disassociation event. R1

The MAC address of the logical BSS (BSSID) which is reporting the disassociation R1
DisassociationEventData.BSSID
event.

DisassociationEventData.MACAddress The MAC address of the STA. R1

The latest reason code received by the AP from the STA in the most recent R1
DisassociationEventData.ReasonCode Disassociation or Deauthentication frame or sent by the AP to the Station in the most
recent Dissasociation or Deauthentication frame as defined in Table 9--49 in [1]

DisassociationEventData.BytesSent The total number of bytes transmitted to the STA. R1

DisassociationEventData.BytesReceived The total number of bytes received from the STA. R1

DisassociationEventData.PacketsSent The total number of packets transmitted to the STA. R1

DisassociationEventData.PacketsReceived The total number of packets received from the STA. R1

The total number of outbound packets that could not be transmitted to the STA R1
DisassociationEventData.ErrorsSent because of errors. These might be due to the number of retransmissions exceeding
the retry limit or from other causes.
The total number of inbound packets from the STA that contained errors preventing R1
DisassociationEventData.ErrorsReceived
them from being delivered to a higher-layer protocol.
The total number of transmitted packets to the STA which were retransmissions. N R1
DisassociationEventData.RetransCount
retransmissions of the same packet results in this counter incrementing by N.

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 31 of 46
Data Elements Specification v2.1

3.2.4 FailedConnectionEvent data model

Table 6. Elements of the FailedConnectionEvent data model

Element Description Data

Elements
Version

DataElements:FailedConnectionEvent This object describes an event generated when a STA fails to connect to a BSS. R2

FailedConnectionEvent.FailedData The data provided when a failed connection event is generated. R2

DataElements:FailedConnectionEventData This object describes the data elements provided with a failed connection event. R2

FailedConnectionEventData.MACAddress STA MAC Address identifying the client that has attempted to connect. R2

Status Code set to a non-zero value that indicates the reason for association or R2
FailedConnectionEventData.StatusCode authentication failure as defined in Table 9-50 of [1] or Status Code set to zero and
Reason Code provided.
Reason Code indicating the reason the STA was disassociated or deauthenticated as R2
FailedConnectionEventData.ReasonCode
defined in Table 9-49 of [1].

3.2.5 Encoding of the data model elements

Table 7. Encoding of the data model elements

Element Type/encoding Size (octets) Yang type [11]

DataElements:Network Container

Network.ID String variable String

Network.TimeStamp As defined in section 3.1 variable String

Network.ControllerID String variable String

Network.NumberOfDevices UInt 2 uint16

Network.DeviceList Array of DataElements:Device variable List

Network.MSCSDisallowedStaList Array of EUI-48 variable List

Network.SCSDisallowedStaList Array of EUI-48 variable List

NetworkSSID Array of DataElements:NetworkSSID variable List

DataElements:Device Grouping

Device.ID EUI-48 6 mac-address

Device.MultiAPCapabilities base64 encoded binary (see Section 6.6 of [7]) 1 binary

Device.NumberOfRadios Uint 2 uint16

Device.RadioList Array of DataElements:Radio variable List

Device.CollectionInterval Uint 4 uint32

Device.ReportUnsuccessfulAssociations boolean 1 boolean

Device.MaxReportingRate Uint 4 uint32

Device.MultiAPProfile Uint 1 uint8

Device.APMetricsReportingInterval Uint 1 uint8

Device.Manufacturer String 64 string

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 32 of 46
Data Elements Specification v2.1

Element Type/encoding Size (octets) Yang type [11]

Device.SerialNumber String 64 string

Device.ManufacturerModel String 64 string

Device.SoftwareVersion String 64 string

Device.ExecutionEnv String 64 string

Device.LocalSteeringDisallowedSTAList Array of EUI-48 variable List

Device.BTMSteeringDisallowedSTAList Array of EUI-48 variable List

Device.Default8021Q DataElements:Default8021Q variable container

Device.TrafficSeparationPolicy Array of DataElement:SSIDtoVIDMapping variable List

Device.CACStatus DataElements:CACStatus variable Grouping

Device.Priortization Array of DataElement.SPRule variable List

Device.DSCPMap base64 encoded binary 64 binary

Device.MaxPrioritizationRules Uint 1 uint8

Device.PrioritizationSupport boolean 1 boolean

Device.MaxVIDs Uint 1 uint8

Device.IEEE1905Security DataElements.IEEE1905secuirty 3 container

Device.CountryCode String 2 string

Device.ReportIndependentScans boolean 1 boolean

Device.AnticipatedChannelUsage Array of DataElements:AnticipatedChannelUsage variable List

An entry in
Device.AnticipatedChannelUsageEntry DataElements:AnticipatedChannelUsage variable Grouping

Device.TrafficSeparationAllowed boolean 1 boolean

Device.ServicePrioritizationAllowed boolean 1 boolean

Device.STASteeringDisallowed boolean 1 boolean

Device.DFSEnable boolean 1 boolean

Device.MaxUnsuccessfulAssociationReportingRate Uint 4 unt32

Device.STASteeringState boolean 1 boolean

Device.CoordinatedCACAllowed boolean 1 boolean

DataElements:Radio Grouping

Radio.ID base64 encoded binary 6 binary

Radio.Enabled boolean 1 boolean

Array of
Radio.CurrentOperatingClasses variable List
DataElements:CurrentOperatingClassProfile

Radio.NumberOfCurrOpClass Uint 1 uint8

Radio.Noise Uint 1 uint8

Radio.Utilization Uint 1 uint8

Radio.Transmit Uint 1 uint8

Radio.ReceiveSelf Uint 1 uint8

Radio.ReceiveOther Uint 1 uint8

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 33 of 46
Data Elements Specification v2.1

Element Type/encoding Size (octets) Yang type [11]

Radio.TrafficSeparationCombinedFronthaul boolean 1 boolean

Radio.TrafficSeparationCombinedBackhaul boolean 1 boolean

Radio.SteeringPolicy Uint 1 Uint8

Radio.ChannelUtilizationThreshold Uint 1 uint8

Radio.RCPISteeringThreshold Uint 1 uint8

Radio.STAReportingRCPIThreshold Uint 1 uint8

Radio.STAReportingRCPIHysteresisMarginOverride Uint 1 uint8

Radio.ChannelUtilizationReportingThreshold Uint 1 uint8

Radio.AssociatedSTATrafficStatsInclusionPolicy boolean 1 boolean

Radio.AssociatedSTALinkMetricsInclusionPolicy boolean 1 boolean

Radio.ChipsetVendor String 64 string

Radio.NumberOfBSS Uint 2 uint16

Radio.BSSList Array of DataElements:BSS variable List

Radio.Capabilities DataElements:Capabilities variable Container

Radio.BackhaulSta DataElements:BackhaulSTA variable Container

Radio.ScanResultList DataElements:ScanResult variable Container

Radio.UnassociatedStaList Array of DataElements:UnassociatedSTA variable List

Radio.NumberOfUnassocSta Uint 2 uint16

Radio.ScanCapability DataElements.ScanCapabilty variable Container

Radio.CACCapability Array of CACMethod variable List

Radio.APMetricsWiFi6 boolean 1 boolean

Array of
Radio.DisAllowedOpClassChannels DataElements:DisAllowedOpClassChannels variable List

Radio.SpatialReuse DataElements:SpatialReuse variable container

Radio.TransmitPowerLimit Integer 1 int8

DataElements:Capabilities Grouping

Capabilities.HTCapabilities base64 encoded binary 1 binary

Capabilities.VHTCapabilities base64 encoded binary 6 binary

[Deprecated] Capabilities.HECapabilities base64 encoded binary (2 to 12) +2 binary

Capabilities.WiFi6APRole DataElements.WiFi6 variable Grouping

Capabilities.WiFi6bSTARole DataElements.WiFi6 variable Grouping

Capabilities.AKMFrontHaul Array of DataElements.AKMSuite variable Grouping

Capabilities.AKMBackhaul Array of DataElements.AKMSuite variable Grouping

Array of
Capabilities.OperatingClasses variable List
DataElements:CapableOperatingClassProfile

Capabilities.NumberOfOpClass Uint 1 uint8

DataElements:CapableOperatingClassProfile Grouping

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 34 of 46
Data Elements Specification v2.1

Element Type/encoding Size (octets) Yang type [11]

CapableOperatingClassProfile.Class Uint 1 uint8

CapableOperatingClassProfile.MaxTxPower Integer 1 int8

CapableOperatingClassProfile.NonOperable Array of Uints variable leaf-list

CapableOperatingClassProfile.NumberOfNonOperChan Uint 1 uint8

DataElements:CurrentOperatingClassProfile Grouping

CurrentOperatingClassProfile.TimeStamp As defined in section 3.1 variable String

CurrentOperatingClassProfile.Class Uint 1 uint8

CurrentOperatingClassProfile.Channel Uint variable uint8

CurrentOperatingClassProfile.TxPower Integer 1 int8

DataElements:BSS Grouping

BSS.BSSID EUI-48 6 mac-address

BSS.SSID String variable string

BSS.Enabled boolean 1 boolean

zero-based-
BSS.LastChange Uint 4
counter 32

BSS.TimeStamp As defined in section 3.1 variable string

zero-based-
BSS.UnicastBytesSent Uint 4
counter32
zero-based-
BSS.UnicastBytesReceived Uint 4
counter32
zero-based-
BSS.MulticastBytesSent Uint 4
counter32
zero-based-
BSS.MulticastBytesReceived Uint 4
counter32
zero-based-
BSS.BroadcastBytesSent Uint 4
counter32
zero-based-
BSS.BroadcastBytesReceived Uint 4
counter32

BSS.ByteCounterUnits Uint 1 unt8

BSS.Profile1bSTAsDisallowed boolean 1 boolean

BSS.Profile2bSTAsDisallowed boolean 1 boolean

BSS.AssociationAllowanceStatus Uint 1 uint8

BSS.STAList Array of DataElements:STA variable list

BSS.NumberOfSTA Uint 2 uint16

BSS.EstServiceParametersBE base64 encoded binary 3 binary

BSS.EstServiceParametersBK base64 encoded binary 3 binary

BSS.EstServiceParametersVI base64 encoded binary 3 binary

BSS.EstServiceParametersVO base64 encoded binary 3 binary

BSS.BackhaulUse boolean 1 boolean

BSS.FronthaulUse boolean 1 boolean

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 35 of 46
Data Elements Specification v2.1

Element Type/encoding Size (octets) Yang type [11]

BSS.R1disallowed boolean 1 boolean

BSS.R2disallowed boolean 1 boolean

BSS.MultiBSSID boolean 1 boolean

BSS.TransmittedBSSID boolean 1 boolean

BSS.FrontHaulAKMsAllowed List of enums variable List of enums

BSS.BackhaulAKMsAllowed List of enums variable List of enums

BSS.QMDescriptor Array of DataElement.QMDescriptoRule variable List

DataElements:STA Grouping

STA.MACAddress EUI-48 6 mac-address

STA.TimeStamp As defined in section 3.1 variable string

STA.HTCapabilities base64 encoded binary 1 binary

STA.VHTCapabilities base64 encoded binary 6 binary

[Deprecated] STA.HECapabilities base64 encoded binary (2 to 12) +2 binary

STA.WiFi6Capabilities DataElements.WiFi6 variable Grouping

STA.ClientCapabilities base64 encoded binary variable binary

STA.LastDataDownlinkRate Uint 4 gauge32

STA.LastDataUplinkRate Uint 4 gauge32

STA.UtilizationReceive Uint 4 counter32

STA.UtilizationTransmit Uint 4 counter32

STA.EstMACDataRateDownlink Uint 4 gauge32

STA.EstMACDataRateUplink Uint 4 gauge32

STA.SignalStrength Uint 1 uint8

zero-based-
STA.LastConnectTime Uint 4
counter32
zero-based-
STA.BytesSent Uint (wrapping) 4
counter32
zero-based-
STA.BytesReceived Uint (wrapping) 4
counter32
zero-based-
STA.PacketsSent Uint (wrapping) 4
counter32
zero-based-
STA.PacketsReceived Uint (wrapping) 4
counter32
zero-based-
STA.ErrorsSent Uint (wrapping) 4
counter32
zero-based-
STA.ErrorsReceived Uint (wrapping) 4
counter32
zero-based-
STA.RetransCount Uint (wrapping) 4
counter32

STA.MeasurementReport Array of base64 encoded binary Variable leaf-list

STA.NumberOfMeasureReports Uint 1 uint8

STA.IPV4Address String variable ipv4-address

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 36 of 46
Data Elements Specification v2.1

Element Type/encoding Size (octets) Yang type [11]

STA.IPV6Address String variable ipv6-address

STA.Hostname String variable host

STA.TIDQueueSizes Array of DataElements.TIDQueue variable list

STA.CellularDataPreference Enum variable string

STA.ReAssociationDelay uint 2 uint16

DataElements:ScanResult Grouping

ScanResult.NumberOfOpClassScans Uint 1 uint8

ScanResult.OpClassScanList Array of DataElements:OpClassScan variable List

ScanResult.TimeStamp As defined in section 3.1 variable string

DataElements:OpClassScan Grouping

OpClassScan.OperatingClass Uint 1 uint8

OpClassScan.ChannelScanList Array of DataElements:ChannelScan variable List

The number of channels scanned in this operating

OpClassScan.NumberOfChannelScans 1 uint8
class
DataElements:ChannelScan Grouping

ChannelScan.Channel Uint 1 uint8

ChannelScan.TimeStamp As defined in section 3.1 variable string

ChannelScan.Utilization Uint 1 uint8

ChannelScan.Noise Uint 1 uint8

ChannelScan.NumberOfNeighbors Uint 1 uint16

ChannelScan.NeighborList Array of DataElements:NeighborBSS variable List

DataElements:NeighborBSS Grouping

NeighborBSS.BSSID EUI-48 6 mac-address

NeighborBSS.SSID String variable string

NeighborBSS.SignalStrength Uint 1 uint8

NeighborBSS.ChannelBandwidth String variable string

NeighborBSS.ChannelUtilization Uint 1 uint8

NeighborBSS.StationCount Uint 2 uint16

DataElements:UnassociatedSTA Grouping

UnassociatedSTA.MACAddress EUI-48 6 mac-address

UnassociatedSTA.SignalStrength Uint 1 uint8

DataElements:BackhaulSTA Grouping

BackhaulSTA.MACAddress EUI-48 6 mac-address

DataElements:Default8021Q Grouping

Default8021Q.PrimaryVID Uint 2 uint16

Default8021Q.DefaultPCP Uint 1 uint8

DataElements:ScanCapability Grouping

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 37 of 46
Data Elements Specification v2.1

Element Type/encoding Size (octets) Yang type [11]

ScanCapability.OnBootOnly Boolean 1 boolean

ScanCapability.Impact Uint 1 uint8

ScanCapability.MinimumInterval Uint 4 uint32

ScanCapability.OpClassList Array of DataElements:OpClassChannels variable List

DataElements:CACMethod List

CACMethod.Method Uint 1 uint8

CACMethod.NumberOfSeconds Uint 4 uint32

CACMethod.OpClassList Array of DataElements:OpClassChannels variable List

DataElements:OpClassChannels Grouping

OpClassChannels.OpClass Uint 1 uint8

OpClassChannels.ChannelList Array of uint8 variable List

DataElements:DisAllowedOpClassChannels Grouping

DisAllowedOpClassChannels.Enable boolean 1 boolean

DisAllowedOpClassChannels.OpClass Uint 1 uint8

DisAllowedOpClassChannels.ChannelList Array of uint8 variable List

DataElements:CACAvailableChannel Grouping

CACAvailableChannel.OpClass Uint 1 uint8

CACAvailableChannel.Channel Uint 1 uint8

CACAvailableChannel.Minutes Uint 2 uint16

DataElements:CACNonOccupancyChannel Grouping

CACNonOccupancyChannel.OpClass Uint 1 uint8

CACNonOccupancyChannel.Channel Uint 1 uint8

CACNonOccupancyChannel.Seconds Uint 2 uint16

DataElements:CACActiveChannel Grouping

CACActiveChannel.OpClass Uint 1 uint8

CACActiveChannel.Channel Uint 1 uint8

CACActiveChannel.Countdown Uint 4 uint32

DataElements:CACStatus Grouping

CACStatus.AvailableChannelList Array of DataElements.CACAvailableChannel variable List

Array of
CACStatus.NonOccupancyChannelList variable List
DataElements.CACNonOccupancyChannel

CACStatus.ActiveChannelList Array of DataElement.CACActiveChannel variable List

CACStatus.TimeStamp As per section 3.1 variable String

DataElements:SSIDtoVIDMapping Grouping

SSIDtoVIDMapping.SSID String variable string

SSIDtoVIDMapping.VID Uint 2 uint16

DataElements.IEEE1905Security Grouping

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 38 of 46
Data Elements Specification v2.1

Element Type/encoding Size (octets) Yang type [11]

IEEE1905Security.OnboardingProtocol Uint 1 uint8

IEEE1905Security.IntegrityAlgorithm Uint 1 uint8

IEEE1905Security.EncryptionAlgorithm Uint 1 uint8

DataElements.SPRule Grouping

SPRule.ID Uint 4 uint32

SPRule.Precedence Uint 1 uint8

SPRule.Output Uint 1 uint8

SPRule.AlwaysMatch boolean 1 boolean

DataElements.WiFi6 Grouping

WiFi6.HE160 boolean 1 boolean

WiFi6.HE8080 boolean 1 boolean

4 or 8 or 12 base64 encoded
base64 encoded binary
WiFi6.MCSNSS octets binary

WiFi6.SUBeamformer boolean 1 boolean

WiFi6.SUBeamformee boolean 1 boolean

WiFi6.MUBeamformer boolean 1 boolean

WiFi6.Beamformee80orLess boolean 1 boolean

WiFi6.BeamformeeAbove80 boolean 1 boolean

WiFi6.ULMUMIMO boolean 1 boolean

WiFi6.ULOFDMA boolean 1 boolean

WiFi6.DLOFDMA boolean 1 boolean

WiFi6.MaxDLMUMIMO Uint 1 uint8

WiFi6.MaxULMUMIMO Uint 1 uint8

WiFi6.MaxDLOFDMA Uint 1 uint8

WiFi6.MaxULOFDMA Uint 1 uint8

WiFi6.RTS boolean 1 boolean

WiFi6.MURTS boolean 1 boolean

WiFi6.MultiBSSID boolean 1 boolean

WiFi6.MUEDCA boolean 1 boolean

WiFi6.TWTRequestor boolean 1 boolean

WiFi6.TWTResponder boolean 1 boolean

WiFi6.SpatialReuse boolean 1 boolean

WiFi6.AnticipatedChannelUsage boolean 1 boolean

DataElements.AKMSuite Grouping

AKMSuite.OUI binary 3 binary

AKMSuite.Type Uint 1 uint8

DataElements.TIDQueue Grouping

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 39 of 46
Data Elements Specification v2.1

Element Type/encoding Size (octets) Yang type [11]

TIDQueue.TID Uint 1 uint8

TIDQueue.Size Uint 1 uint8

DataElements.QMDescriptor Grouping

QMDescriptor.BSSID EUI-48 6 mac-address

QMDescriptor.ClientMac EUI-48 6 mac-address

QMDescriptor.DescriptorElement base64 encoded binary variable binary

DataElements:AnticipatedChannelUsage Grouping
AnticipatedChannelUsage.OperatingClass uint 1 uint8

AnticipatedChannelUsage.Channel uint 1 uint8

AnticipatedChannelUsage.ReferenceBSSID EUI-48 6 mac-address

Array of
AnticipatedChannelUsage.Entry DataElements.AnticipatedChannelUsageEntry variable List

AnticipatedChannelUsageEntry Grouping

AnticipatedChannelUsageEntry.BurstStartTime base64 encoded binary 4 binary

AnticipatedChannelUsageEntry.BurstLength UnsignedInt 4 Uint32

AnticipatedChannelUsageEntry.Repetitions unsignedInt 4 Uint32

AnticipatedChannelUsageEntryBurstInterval unsignedInt 4 Uint32

AnticipatedChannelUsageEntry.RUBitmask base64 encoded binary 2, 3, 5, or 10 binary

AnticipatedChannelUsageEntry.TransmitterIdentifier EUI-48 6 binary

AnticipatedChannelUsageEntry.PowerLevel SignedInt 1 Int8

AnticipatedChannelUsageEntry.ChannelUsageReason enum 1 enum

DataElements:SpatialReuse Grouping

SpatialReuse.PartialBSSColor Uint 1 uint8

SpatialReuse.BSSColor Uint 1 uint8

SpatialReuse.HESIGASpatialReuseValue15Allowed boolean 1 boolean

SpatialReuse.SRGInformationValid boolean 1 boolean

SpatialReuse.NonSRGOffsetValid boolean 1 boolean

SpatialReuse.PSRDisallowed boolean 1 boolean

SpatialReuse.NonSRGOBSSPDMaxOffset Uint 1 Uint8

SpatialReuse.SRGOBSSPDMinOffset Uint 1 Uint8

SpatialReuse.SRGOBSSPDMaxOffset Uint 1 Uint8

SpatialReuse.SRGBSSColorBitmap base64 encoded binary 8 binary

SpatialReuse.SRGPartialBSSIDBitmap base64 encoded binary 8 binary

SpatialReuse.NeighborBSSColorInUseBitmap base64 encoded binary 8 binary

DataElements:NetworkSSID Grouping

NetworkSSID.SSID string String

NetworkSSID.Band List of enums variable List

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 40 of 46
Data Elements Specification v2.1

Element Type/encoding Size (octets) Yang type [11]

DataElements:AssociationEvent Event Event

AssociationEvent.AssocData DataElements:AssociationEventData variable container

DataElements:AssociationEventData Grouping

AssociationEventData.BSSID EUI-48 6 mac-address

AssociationEventData.MACAddress EUI-48 6 mac-address

AssociationEventData.StatusCode Uint 2 uint16

AssociationEventData.HTCapabilities base64 encoded binary 1 binary

AssociationEventData.VHTCapabilities base64 encoded binary 6 binary

[Deprecated] AssociationEventData.HECapabilities base64 encoded binary (2 to 12) +2 binary

AssociationEventData.WiFi6Capabilities DataElements.WiFi6 variable Grouping

AssociationEventData.ClientCapabilities base64 encoded binary variable binary

DataElements:DisassociationEvent Event Event

DisassociationEvent.DisassocData DataElements:DisassociationEventData variable container

DataElements:DisassociationEventData Grouping

DisassociationEventData.BSSID EUI-48 6 mac-address

DisassociationEventData.MACAddress EUI-48 6 mac-address

DisassociationEventData.ReasonCode Uint 2 uint16

zero-based-
DisassociationEventData.BytesSent Uint (wrapping) 4
counter32
zero-based-
DisassociationEventData.BytesReceived Uint (wrapping) 4
counter32
zero-based-
DisassociationEventData.PacketsSent Uint (wrapping) 4
counter32
zero-based-
DisassociationEventData.PacketsReceived Uint (wrapping) 4
counter32
zero-based-
DisassociationEventData.ErrorsSent Uint (wrapping) 4
counter32
zero-based-
DisassociationEventData.ErrorsReceived Uint (wrapping) 4
counter32
zero-based-
DisassociationEventData.RetransCount Uint (wrapping) 4
counter32

DataElements:FailedConnectionEvent Event Event

FailedConnectionEvent.Data variable Container

DataElements:FailedConnectionEventData Grouping

FailedConnectionEventData.MACAddress EUI-48 6 mac-address

FailedConnectionEventData.StatusCode Uint 2 uint16

FailedConnectionEventData.ReasonCode Uint 2 uint16

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 41 of 46
Data Elements Specification v2.1

3.2.6 Data Elements JSON Schema

The informative Data Elements JSON Schema specified in [9] has been derived from the normative YANG Schema [8].
The Data Elements JSON Schema conforms to the JSON Schema draft 0.7 specification [8].

3.2.7 Data Elements commands

Remote configuration can be enacted in two ways: by invoking a command, or by writing to a readWrite parameter
[15][16][17]. Commands are defined for major configuration changes, and a command can accept various input
arguments. A command may affect read parameter(s), as denoted in the description of the command.
Table 8 shows the HTML representation of the Data Elements commands in the TR-181 data model. This HTML
representation is described in Appendix I of TR-106 [17]. The Version column in Table 8 is the version of TR-181 [16]. A "-
' in the Write column indicates readOnly, a "W" indicates readWrite. The TR-181 version corresponding to the Data
Elements version is shown in Table 8.
Table 8. Correspondence between versioning
Data Elements version TR-181 version Description

1.0 2.13 The original read-only

Data Elements

2.0 2.14 Additional read-only Data

Elements

2.1 2.15 Adds remote configuration

Table 9. Remote Configuration Commands

See tr-181-2-15-1-usp.xml (broadband-forum.org), at URL https://usp-data-models.broadband-forum.org/tr-181-2-15-1-
usp.html#D.Device:2.Device.WiFi.DataElements. for the complete description of all Data Elements including commands.
Object names containing “MultiAP” are not part of Data Elements, they are instead Broadband Forum additions.
The complete descriptions of each command are given in the references below:https://usp-data-models.broadband-
forum.org/tr-181-2-15-1-usp.html#D.Device:2.Device.WiFi.DataElements.Network.SetTrafficSeparation()
https://usp-data-models.broadband-forum.org/tr-181-2-15-1-
usp.html#D.Device:2.Device.WiFi.DataElements.Network.SetServicePrioritization()
https://usp-data-models.broadband-forum.org/tr-181-2-15-1-
usp.html#D.Device:2.Device.WiFi.DataElements.Network.SetPreferredBackhauls()
https://usp-data-models.broadband-forum.org/tr-181-2-15-1-
usp.html#D.Device:2.Device.WiFi.DataElements.Network.SetSSID()
https://usp-data-models.broadband-forum.org/tr-181-2-15-1-
usp.html#D.Device:2.Device.WiFi.DataElements.Network.SetMSCSDisallowed()
https://usp-data-models.broadband-forum.org/tr-181-2-15-1-
usp.html#D.Device:2.Device.WiFi.DataElements.Network.SetSCSDisallowed()
https://usp-data-models.broadband-forum.org/tr-181-2-15-1-
usp.html#D.Device:2.Device.WiFi.DataElements.Network.Device.{i}.SetSTASteeringState()
https://usp-data-models.broadband-forum.org/tr-181-2-15-1-
usp.html#D.Device:2.Device.WiFi.DataElements.Network.Device.{i}.SetDFSState()

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 42 of 46
Data Elements Specification v2.1

https://usp-data-models.broadband-forum.org/tr-181-2-15-1-
usp.html#D.Device:2.Device.WiFi.DataElements.Network.Device.{i}.SetAnticipatedChannelPreference()
https://usp-data-models.broadband-forum.org/tr-181-2-15-1-
usp.html#D.Device:2.Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ChannelScanRequest()
https://usp-data-models.broadband-forum.org/tr-181-2-15-1-
usp.html#D.Device:2.Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.RadioEnable()
https://usp-data-models.broadband-forum.org/tr-181-2-15-1-
usp.html#D.Device:2.Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.SetTxPowerLimit()
https://usp-data-models.broadband-forum.org/tr-181-2-15-1-
usp.html#D.Device:2.Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.SetSpatialReuse()
https://usp-data-models.broadband-forum.org/tr-181-2-15-1-
usp.html#D.Device:2.Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.WiFiRestart()
https://usp-data-models.broadband-forum.org/tr-181-2-15-1-
usp.html#D.Device:2.Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.SetQMDescriptors()

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 43 of 46
Data Elements Specification v2.1

4 Data Elements protocol

4.1 Retrieval of data model elements (excluding event data)
If a Data Elements Agent receives a request for elements of the Data Elements Network object using an HTTP 1.1 GET
request, with Accept: application/yang-data+json, with the following URL format:
<Data Elements Agent Host IP:Port>/<Agent Prefix>/wfa-dataelements:Network

where
<Data Elements Agent Host IP:Port> is the IP address and port number on which the Data Elements Agent is
listening, and is defined through an out of band mechanism
<Agent Prefix> is a URL prefix defined by the Data Elements Agent and discovered through an out of band
mechanism
then the Data Elements Agent shall respond to this request with an HTTP 1.1 Response message containing the full data
model, excluding event data, with Content-Type: application/yang-data+json, as defined in section 3.2 (Table 7) and
formatted in JSON as defined in [7]. This JSON representation shall be the IETC RFC 7951 [7] transformation of the Data
Elements YANG representation [6].
The response by the Data Elements Agent implicitly indicates if the co-located device is a Single-AP or an EasyMesh
Controller in the Device.MultiAPCapabilities element and the set of elements that are returned.
If a condition arises such that a Data Elements Agent is temporarily unable to provide a valid in-range value for a
Mandatory or Conditionally Mandatory element (including an element pointing to a list), then the Data Elements Agent
shall either set the value to literal name token "null" or omit the element to indicate that the element cannot be provided at
that time. Otherwise, a Data Elements Agent shall provide elements with in-range values per Table 7.
If an element is Conditionally Mandatory and the conditions for reporting the element as specified in section 3.1.1 are
satisfied, then a Data Elements Agent shall provide the element with a valid in range value. If the conditions specified in
section 3.1.1 for reporting an element are not satisfied, then a Data Elements Agent shall either set the value to literal
name token "null" or omit the element.
For each element, a Data Elements Agent shall either set the value to a valid in-range value (per Table 7), to literal name
token "null", or omit the element.
If an element is a list whose current value is an empty list with a list length of zero, then the Data Elements Agent shall set
the value to a JSON empty array and shall set any associated list length element value to zero.
EUI-48 (mac address) strings shall have 12 hex digits that may be separated into pairs of hex digits with a ":"

4.2 Retrieval of event data

If a Data Elements Agent receives a request of the most recent Data Elements Event using an HTTP 1.1 GET request,
with Accept: application/yang-data+json, on the following URL:
<Data Element Agent Host IP:Port>/<Agent Prefix>/wfa-dataelements:Last-Event

then the Data Elements Agent shall respond with an HTTP 1.1 Response message with Content-Type: application/yang-
data+json containing a single notification including the eventTime element as defined in section 7.14 of [10]. The
notification shall contain either the last Data Elements AssociationEvent or last Data Elements DisassociationEvent or last
FailedConnectionEvent as defined in section 3.2 (Table 4 or Table 5 or Table 6) and formatted in JSON as defined in [7].
This JSON representation shall be the IETC RFC 7951 [7] transformation of the Data Elements YANG representation [6].
The response shall not include the elements of the Data Elements Network data model (Table 3). Although a Data
Elements Agent may have collected previous events, it shall only provide the latest event.
If an element is Conditionally Mandatory and the conditions for reporting the element as specified in section 3.1.1 are
satisfied, then a Data Elements Agent shall provide the element with a valid in range value. If the conditions specified in

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 44 of 46
Data Elements Specification v2.1

section 3.1.1 for reporting an element are not satisfied, then a Data Elements Agent shall either set the value to literal
name token "null" or omit the element.
If there is no AssociationEvent or DisassociationEvent or FailedConnectionEvent currently available, then a Data
Elements Agent shall either set the value of the notification to the literal name token "null" or omit the notification.
The event data represents information valid at the time the event was created and may bear no relation to the current
state of the data model.

4.3 Collection frequency

A Data Elements Collector may retrieve data from the Data Elements Agent at any time and at any frequency. The
element DataElements:Device.CollectionInterval indicates the interval between the collection of consecutive
measurements of the most frequently updated Data Element from the corresponding device. A value of zero indicates that
measurements are collected when a Data Elements Agent receives a request for elements. These values may be used as
a guide by a Data Elements Collector on how frequently it should request updates from a Data Elements Agent.

4.4 Remote Configuration

In contrast to the "read only" elements of the Data Elements model (see section 4.1 and 4.2), "readWrite" elements and
"Commands" are facilitated through USP TR-369 [15][17] and XML formatted TR-181 [16][15].

Figure 3. Example Remote Configuration Operation Handling

Figure 3 depicts remote configuration operation handling. In the case of a single AP, there are no EasyMesh agents in the
figure and so there are also no requests or responses to and from EasyMesh agents.
If a Data Elements Agent receives a request to write to a readWrite element of the Data Elements Network object using
USP with the TR-181 XML format, then the Data Elements Agent shall respond to this request with a Set Response as
defined in Section 13.4.4.3 of TR-369 [17].

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 45 of 46
Data Elements Specification v2.1

If a Data Elements Agent receives a request for an async Command using USP with the TR-181 XML format, then the
Data Elements Agent shall respond to this request with an Operate Response as defined in Section 13.7.7.2 of TR-369
[17].
A command performing configuration implies persistence of the configured objects/parameters. However, an
asynchronous command that was issued just before a reboot may not persist, see
https://usp.technology/specification/07-index-messages.html#sec:defined-operations-mechanism.

© 2022 Wi-Fi Alliance. All Rights Reserved.

Used with the permission of Wi-Fi Alliance under the terms as stated in this document.
Page 46 of 46