Scroll page details

Airties Easy Mesh controller supports the below Data model parameters, commands, events. Please see https://usp-data-models.broadband-forum.org/tr-181-2-16-0-usp.html#D.Device:2.Device.WiFi.DataElements. page for details of each DM parameters.


NameType

Notes

Device.WiFi.DataElements.Network.object
IDstring
TimeStampstring
DeviceNumberOfEntriesuint32
SSIDNumberOfEntriesuint32
SetSSID()command
⇒ Input

⇒ SSID

string
⇒ AddRemovestring

⇒ PassPhrase

string
⇒ Bandstring[]
⇒ AKMsAllowedstring[]
⇒ Enabledboolean
⇒ AdvertisementEnabledboolean
⇒ Referencestring
⇒ Directionstring
⇒ X_AIRTIES_VIDint32
⇐ Output

⇐ Statusstring
Device.WiFi.DataElements.Network.SSID.{i}.object
SSIDstring
Enabledboolean
Bandstring
AdvertisementEnabledboolean
Passphrasestring
AKMsAllowedstring
Referencestring
Directionstring
X_AIRTIES_VIDint32VLAN ID to be set for this instance of SSID
Device.WiFi.DataElements.Network.Device.{i}.object


IDstring
Manufacturerstring
SerialNumberstring
ManufacturerModelstring
SoftwareVersionstring
ExecutionEnvstring
CountryCodestring
MultiAPProfileuint32

BTMSteeringDisallowedSTAList

string

[R/W] Modification will trigger steering policy TLV to be sent

LocalSteeringDisallowedSTAList

string

[R/W] Modification will trigger steering policy TLV to be sent

RadioNumberOfEntriesuint32
CACStatusNumberOfEntriesuint32
X_AIRTIES_UnassociatedStaLinkMetricsQuery()command[ASYNC] Initiates to collect signal strength level of unassociated stations per device
⇒ Input

⇒ OpClassUnsignedInt[MANDATORY] The Operating Class per [Table E-4/802.11-2020] For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid.
⇒ Channel.{i}object

A list of Channel

 ⇒   Channel: UnsignedInt
 ⇒   Channel.{i}.STA.{i}: Object
 ⇒     MAC: String

⇒ Channel.{i}.ChannelUnsignedIntChannel number in a Channel list object instance
⇒ Channel.{i}.STA.{i}objectA list of Station entries
⇒ Channel.{i}.STA.{i}.MACstringMAC address of the station
⇐ Output

⇐ Status  string

Indicates the type of outcome of the request to enable or disable this radio. Enumeration of:

  • Success
  • Error_Invalid_Input
  • Error_Timeout
  • Error_Other (OPTIONAL
⇐ OpClassUnsignedIntThe Operating Class per [Table E-4/802.11-2020] For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid.
⇐ STA.{i}.objectA list of information for each station seen by the Device
⇐ STA.{i}.ChannelUnsignedIntChannel for the station
⇐ STA.{i}.MACAddressstringMAC address of the station
⇐ STA.{i}.SignalStrengthUnsignedIntSignal strength of the station
Device.WiFi.DataElements.Network.Device.{i}.MultiAPDevice.Backhaul.object
LinkTypestring
BackhaulMACAddressstring
BackhaulDeviceIDstring
MACAddressstring
SteerWiFiBackhaul​()command

[ASYNC] This command requests the Wi-Fi backhaul link to be steered to associate to a different BSS when the device is working as a bridge in a mesh network. The device needs to already have the necessary credentials for the switch to happen.

The TargetBSS should be an instance of a Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.BSSID.

⇒ Input

⇒TargetBSSstring
⇒ ChannelunsignedInt
⇒TimeOutunsignedInt
⇐ Output

⇐ Statusstring
Device.WiFi.DataElements.Network.Device.{i}.MultiAPDevice.Backhaul.Stats.object
BytesReceiveduint64
BytesSentuint64
PacketsReceiveduint64
PacketsSentuint64
ErrorsReceiveduint64
ErrorsSentuint64
SignalStrengthuint32
LastDataDownlinkRateuint32
LastDataUplinkRateuint32
TimeStampstring
Device.WiFi.DataElements.Network.Device.{i}.CACStatus.{i}.object
TimeStampstring
CACAvailableChannelNumberOfEntriesuint32
CACNonOccupancyChannelNumberOfEntriesuint32
CACActiveChannelNumberOfEntriesuint32
Device.WiFi.DataElements.Network.Device.{i}.CACStatus.{i}.CACAvailableChannel.{i}.object
OpClassuint32
Channeluint32
Minutesuint32
Device.WiFi.DataElements.Network.Device.{i}.CACStatus.{i}.CACNonOccupancyChannel.{i}.

OpClassuint32
Channeluint32
Secondsuint32
Device.WiFi.DataElements.Network.Device.{i}.CACStatus.{i}.CACActiveChannel.{i}.

OpClassuint32
Channeluint32
Countdownuint32
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.object
IDstring
Enabledboolean
Noiseuint32
Utilizationuint32
Transmituint32
ReceiveSelfuint32
ReceiveOtheruint32
X_AIRTIES_Temperatureuint32
BSSNumberOfEntriesuint32
CurrentOperatingClassProfileNumberOfEntriesuint32
ScanResultNumberOfEntriesuint32
UnassociatedSTANumberOfEntriesuint32
DisAllowedOpClassChannelsNumberOfEntriesuint32
ChannelScanRequest()command
⇒ Input

⇒ OpClassuint32
⇒ ChannelListstring
⇐ Output

⇐ Statusstring
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BackhaulSta.object
MACAddressstring
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.object
HTCapabilitiesstring
VHTCapabilitiesstring
HECapabilitiesstring
CapableOperatingClassProfileNumberOfEntriesuint32
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.CapableOperatingClassProfile.{i}.object
Classuint32
MaxTxPowerint32
NonOperablestring
NumberOfNonOperChanuint32
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.MultiAPRadio.object
FullScan()command
⇒ Input

⇒ Dwell­Timeuint32
⇒ ChannelListuint32
⇒ DFSDwell­Timeuint32
⇒ Home­Timeuint32
⇒ SSIDstring
⇐ Output

⇐ Statusstring

⇐ ScanResult.{i}.

object
  ⇐ TimeStampstring
  ⇐ ScanResult.{i}.OpClassScan.{i}.object
    ⇐ OperatingClassunsignedInt
    ⇐ ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.object
      ⇐ ChannelunsignedInt
      ⇐ TimeStampstring
      ⇐ UtilizationunsignedInt
      ⇐ ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.NeighborBSS.{i}.object
        ⇐ BSSIDstring
        ⇐ SSIDstring

        ⇐ SignalStrength

unsignedInt
        ⇐ ChannelBandwidthstring
        ⇐ ChannelUtilizationunsignedInt
        ⇐ StationCountunsignedInt
ChannelScan()command
⇒ Input

⇒ OpClass.{i}.object
  ⇒ OperatingClass

unsignedInt


  ⇒ Channel

unsignedInt


  ⇒ DwellTimeunsignedInt
  ⇒ DFSDwellTimeunsignedInt
  ⇒ HomeTimeunsignedInt
  ⇒ SSIDstring
⇐ Output

⇐ Statusstring

⇐ ScanResult.{i}.

object
  ⇐ TimeStampstring
  ⇐ ScanResult.{i}.OpClassScan.{i}.object
    ⇐ OperatingClassunsignedInt
    ⇐ ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.object
      ⇐ ChannelunsignedInt
      ⇐ TimeStampstring
      ⇐ UtilizationunsignedInt
      ⇐ ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.NeighborBSS.{i}.object
        ⇐ BSSIDstring
        ⇐ SSIDstring

        ⇐ SignalStrength

unsignedInt
        ⇐ ChannelBandwidthstring
        ⇐ ChannelUtilizationunsignedInt
        ⇐ StationCountunsignedInt
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.CurrentOperatingClassProfile.{i}.object
Classuint32
Channeluint32
TxPowerint32
TimeStampstring
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.DisAllowedOpClassChannels.{i}.object
Enableboolean
OpClassuint32
ChannelListstring
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.object
TimeStampstring
OpClassScanNumberOfEntriesuint32
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.object
OperatingClassuint32
ChannelScanNumberOfEntriesuint32
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.object
Channeluint32
TimeStampstring
Utilizationuint32
Noiseint32
NeighborBSSNumberOfEntriesint32
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.NeighborBSS.{i}.object
BSSIDstring
SSIDstring
SignalStreint32
ChannelBanstring
ChannelUtiuint32
StationCouuint32
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.object
BSSIDstring
SSIDstring
Enabledboolean
LastChangeuint32
TimeStampstring
UnicastBytesReceiveduint64
UnicastBytesSentuint64
MulticastBytesReceiveduint64
MulticastBytesSentuint64
BroadcastBytesReceiveduint64
BroadcastBytesSentuint64
BackhaulUseboolean
FronthaulUseboolean
FronthaulAKMsAllowedstring
BackhaulAKMsAllowedstring
STANumberOfEntriesuint32
X_AIRTIES_ClientAssocControl()command[SYNC] Unblocks or blocks stations for a period of time
⇒ Input

⇒ StationsListstring

[MANDATORY] Comma separated list of station MAC addresses

⇒ BlockBoolean[OPTIONAL] If true station MAC addresses in StationsList will be blocked. Otherwise they will be unblocked.
⇒ PeriodunsignedInt[OPTIONAL] Period in milliseconds to block stations given in StationsList. Required if Block parameter is given.
⇐ Output

⇐ StatusstringEnumeration of:
  • Success
  • Error_Invalid_Input
  • Error_Timeout
  • Error_Other (OPTIONAL)
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.object
MACAddressstring
TimeStampstring
HTCapabilitiesstring
VHTCapabilitiesstring
HECapabilitiesstring
ClientCapabilitiesstring
LastDataDownlinkRateuint32
LastDataUplinkRateuint32
UtilizationReceiveuint32
UtilizationTransmituint32
EstMACDataRateDownlinkuint32
EstMACDataRateUplinkuint32
SignalStrengthuint32
LastConnectTimeuint32
BytesReceiveduint64
BytesSentuint64
PacketsReceiveduint64
PacketsSentuint64
ErrorsReceiveduint64
ErrorsSentuint64
RetransCountuint64
MeasurementReportstring
NumberOfMeasureReportsuint32
X_AIRTIES_BeaconMetricsQuery()command[ASYNC] Initiates an operation to collect BSS information by a station.
⇒ Input

⇒ OperatingClassunsignedInt[OPTIONAL] Operating Class per [Table E-4/802.11-2020].
⇒ ChannelunsignedInt[OPTIONAL]
⇒ ReportingDetailunsignedInt[OPTIONAL]
⇒ BSSIDstring[OPTIONAL] BSSID for a
⇒ SSIDstring[OPTIONAL] SSID of an BSS
⇐ Output

⇐ StatusstringEnumeration of:
  • Success
  • Error_Invalid_Input
  • Error_Timeout
  • Error_Other (OPTIONAL)
⇐ NumberOfMeasureReportsuint32
⇐ MeasurementReportstring
ClientSteer​()command

[ASYNC] Initiates an EasyMesh Controller initiated steering mandate request to steer a STA from one EasyMesh agent to another.
The steering mechanism is determined by the EasyMesh controller. Application of BTM or non BTM steering, timing, failsafes, and command rejection are determined by the EasyMesh controller.
The TargetBSS should be an instance of a BSSID.

⇒ Input.argumentsInput arguments.
⇒ TargetBSSstring​(17)

[MACAddress] Basic Service Set Identifier (BSSID) or AP MLD MAC Address of the target BSS which the associated device(s) is to be steered to.
Wildcard BSSID is represented by FFFFFFFFFFFF.

⇒ RequestModestring

The request mode. Enumeration of:
Steering_Opportunity (Request is a Steering Opportunity, indicated by 0 in [Table 49/EasyMesh])
Steering_Mandate (Request is a Steering Mandate to trigger steering for specific client STA(s), indicated by 1 in [Table 49/EasyMesh])

⇒ BTMDisassociationImminentboolean

BTM disassociation imminent.

⇒ BTMAbridgedbooleanBTM abridged.
⇒ LinkRemovalImminentboolean

Link removal imminent.

⇒ SteeringOpportunityWindowunsignedInt

Time period in seconds (from reception of the Steering Request message) for which the request is valid. If RequestMode is Steering_Mandate, then this is ignored.

⇒ BTMDisassociationTimerunsignedInt

Time period in TUs of the disassociation timer in the BTM Request.

⇒ TargetBSSOperatingClassunsignedInt​(:255)

The Target BSS Operating Class per [Table E-4/802.11-2020].
If the TargetBSS is set to "Wildcard BSSID", then this is ignored.

⇒ TargetBSSChannelunsignedInt​(:255)

Target BSS channel number for channel on which the Target BSS is transmitting Beacon frames.
If the TargetBSS is set to "Wildcard BSSID", then then this is ignored.

⇒ ReasonCodeunsignedInt​(:255)

Reason code for steering as specified in [Table 18/AMB].

⇐ Output.argumentsOutput arguments.
⇐ Statusstring

Indicates the response to the Wi-Fi client steering request. Enumeration of:
Success
Error_Invalid_Input
Error_Timeout
Error_Other (OPTIONAL)

⇐ BTMStatusCodeunsignedInt

Indicates the value of the BTM Status Code as reported by the STA in the BTM Response (per [Table 9-428/802.11-2020]).

⇐ TargetBSSIDstring​(17)

[MACAddress] Basic Service Set Identifier (BSSID) of the target BSS which the Indicates the value of the Target Basic Service Set Identifier (BSSID) field (if present) in the BTM Response received from the STA (see [Section 9.6.13.10/802.11-2020]).
Note: This indicates the BSSID that the STA intends to roam to, which may not align with the Target BSSID specified in the BTM Request.

Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.MultiAPSTA.object
SteeringHistoryNumberOfEntriesuint64
Disassociate()command
⇒ Input

⇒ DisassociationTimerunsignedInt
⇒ ReasonCodeunsignedInt
⇒ Silentboolean
⇐ Output

⇐ Statusstring
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.MultiAPSTA.SteeringHistory.{i}.object
TimedateTime
APOriginstring
TriggerEventstring
SteeringApproachstring
APDestinationstring
SteeringDurationunsignedInt
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.MultiAPSTA.SteeringSummaryStats.object
NoCandidateAPFailuresuint64
BlacklistAttemptsuint64
BlacklistSuccessesuint64
BlacklistFailuresuint64
BTMAttemptsuint64
BTMSuccessesuint64
BTMFailuresuint64
BTMQueryResponsesuint64
LastSteerTimeuint32
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.UnassociatedSTA.{i}.object
MACAddressstring
SignalStrengthuint32
TimeStampstring
Device.WiFi.DataElements.Network.Device.{i}.X_AIRTIES_Ethernet.object
InterfaceNumberOfEntriesuint32
Device.WiFi.DataElements.Network.Device.{i}.X_AIRTIES_Ethernet.Interface.{i}.object
MACAddressstring
DeviceNumberOfEntriesuint32
Device.WiFi.DataElements.Network.Device.{i}.X_AIRTIES_Ethernet.Interface.{i}.Device.{i}.object
MACAddressstring
Device.WiFi.DataElements.Network.Device.{i}.X_AIRTIES_DeviceInfo.object
Uptimeuint32
Device.WiFi.DataElements.Network.Device.{i}.X_AIRTIES_DeviceInfo.MemoryStatus.object
Totaluint32
Freeuint32
Cacheduint32
Device.WiFi.DataElements.Network.Device.{i}.X_AIRTIES_DeviceInfo.ProcessStatus.object
CPUUsageuint32
CPUTemperatureuint32
Device.WiFi.DataElements.AssociationEvent.object

AssociationEventDataNumberOfEntries

uint32


Associated!

event


⇒ MACAddress

string


⇒ BSSID

string


⇒ StatusCode

uint32


⇒ TimeStamp

string
Device.WiFi.DataElements.AssociationEvent.AssociationEventData.{i}.object
MACAddressstring
BSSIDstring
StatusCodeuint32
TimeStampstring
Device.WiFi.DataElements.DisassociationEvent.object
DisassociationEventDataNumberOfEntriesuint32
Disassociated!event
⇒ BSSIDstring

⇒ MACAddress

string

⇒ ReasonCode

unsignedInt

⇒ TimeStamp



Device.WiFi.DataElements.DisassociationEvent.DisassociationEventData.{i}.object
MACAddressstring
BSSIDstring
ReasonCodeuint32
TimeStampstring
Device.WiFi.DataElements.FailedConnectionEvent.object
FailedConnectionEventDataNumberOfEntriesuint32
FailedConnection!event

⇒ BSSID

string


⇒ MACAddressstring
⇒ StatusCodeuint32
⇒ ReasonCodeuint32
⇒ TimeStampstring
Device.WiFi.DataElements.FailedConnectionEvent.FailedConnectionEventData.{i}.object

BSSID

string


MACAddressstring
ReasonCodeuint32
StatusCodeuint32
TimeStampstring
  • No labels

8 Comments

  1. Kabil Akpinar

    RDK Support Team please move this page under EasyMesh Controller page.

    1. Kiran Kumar S

      Hi Unknown User (kabil.akpinar) ,

      It is moved .

  2. Kabil Akpinar

    Thanks Unknown User (kirankumar_s09) can you please give me edit permissions for this page?

  3. Kiran Kumar S

    Unknown User (kabil.akpinar) There are no edit restrictions for this page. You should be able to edit it.

    1. Kabil Akpinar

      While I can modify the page on the fly, I cant see Edit button. Also when I try to access Edit link of the page I get a message:

      You can't edit pages in this space

      Ask a space admin or the person...

      1. Kabil Akpinar

        Could it be parent page permission issue?

  4. Stephen [kiwin] PALM

    Unknown User (kabil.akpinar) Instead of using private X_AIRTIES extensions, please consider submitting directly to the Wi-Fi Data Elements group (https://groups.wi-fi.org/apps/org/workgroup/wfa-dataelements/)

    Also, Issue 2.17 that adds Wi-Fi 7, MLO, MU stats and more has been approved and will be published soon.

    1. Bilal Hatipoglu

      Thanks Kiwin for you comment. By the time this has been mature, there was no time for DE R3 release window. We are indeed planning to bring this to the table for DE R4.

DISCLAIMER: Please note that the use of the RDK Wiki is subject to its Privacy Policy & Terms of Use. In addition, this Wiki may be accessed by all RDK licensees and their contractors.