Versions Compared

Old Version 48

changes.mady.by.user Kabil Akpinar

Saved on

compared with

New Version 49

changes.mady.by.user Kabil Akpinar

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.


Device.WiFi.DataElements.Network.Device.WiFi.DataElements.Network.SSID.{i}.Device.WiFi.DataElements.Network.Device.{i}.⇒ Channel.{i}.ChannelDevice.WiFi.DataElements.Network.Device.{i}.MultiAPDevice.Backhaul.Stats.Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.CapableOperatingClassProfile.{i}.Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.X_AIRTIES_ClientAssocControl()Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.X_AIRTIES_BeaconMetricsQuery()⇒ OperatingClass⇒ InputDevice.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.MultiAPSTA.SteeringHistory.{i}.Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.MultiAPSTA.SteeringSummaryStats.FullScan()ChannelScan()⇐ SupportedDataTransferRates⇐ DTIMPeriodDevice.WiFi.DataElements.Network.Device.{i}.X_AIRTIES_DeviceInfo.Device.WiFi.DataElements.AssociationEvent.AssociationEventDataNumberOfEntries⇒ BSSID⇒ StatusCodeDevice.WiFi.DataElements.AssociationEvent.AssociationEventData.{i}.Device.WiFi.DataElements.DisassociationEvent.FailedConnection!⇒ BSSIDDevice.WiFi.DataElements.FailedConnectionEvent.FailedConnectionEventData.{i}.
NameType

Notes

object
IDstring
TimeStampstringDeviceNumberOfEntries
uint32
SSIDNumberOfEntriesuint32
SetSSID()command⇒ Input


⇒ SSID

string⇒ AddRemove
string

⇒ PassPhrase

string⇒ Band
string[]⇐ Output⇐ Status








string
objectSSID
stringEnabled
boolean
Bandstring
AdvertisementEnabledboolean
PassphrasestringAKMsAllowed
string
Referencestring
Directionstring
X_AIRTIES_VIDint32VLAN ID to be set for this instance of SSID
object


IDstring
Manufacturerstring
SerialNumberstringManufacturerModel
string
SoftwareVersionstring
ExecutionEnvstringCountryCode
string
MultiAPProfileuint32RadioNumberOfEntries
uint32CACStatusNumberOfEntries
uint32
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

UnsignedIntChannel number in a Channel list object instance
⇒ Channel.{i}.STA.{i}objectA list of Station entries⇒ Channel.{i}.STA.{i}.MAC
stringMAC 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
⇐ OpClass
UnsignedIntThe 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}.Channel
UnsignedIntChannel for the station
⇐ STA.{i}.MACAddressstringMAC address of the station⇐ STA.{i}.SignalStrength
UnsignedIntSignal strength of the station
Device.WiFi.DataElements.Network.Device.{i}.MultiAPDevice.Backhaul.object
LinkTypestringBackhaulMACAddress
string
BackhaulDeviceIDstring
MACAddressstring
objectBytesReceived
uint64
BytesSentuint64PacketsReceived
uint64PacketsSent
uint64
ErrorsReceiveduint64
ErrorsSentuint64
SignalStrengthuint32LastDataDownlinkRate
uint32
LastDataUplinkRateuint32
TimeStampstring
Device.WiFi.DataElements.Network.Device.{i}.CACStatus.{i}.object
TimeStampstring
CACAvailableChannelNumberOfEntriesuint32
CACNonOccupancyChannelNumberOfEntriesuint32CACActiveChannelNumberOfEntries
uint32
Device.WiFi.DataElements.Network.Device.{i}.CACStatus.{i}.CACAvailableChannel.{i}.object
OpClassuint32
Channeluint32Minutes
uint32
object
IDstringEnabled
boolean
Noiseuint32
Utilizationuint32
Transmituint32ReceiveSelf
uint32ReceiveOther
uint32
X_AIRTIES_Temperatureuint32
BSSNumberOfEntriesuint32CurrentOperatingClassProfileNumberOfEntries
uint32ScanResultNumberOfEntries
uint32UnassociatedSTANumberOfEntries
uint32
ChannelScanRequest()command


⇒ Input⇒ OpClassuint32⇒ ChannelList
string⇐ Output


⇐ Statusstring
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BackhaulSta.object
MACAddressstring
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.objectHTCapabilities
string
VHTCapabilitiesstring
HECapabilitiesstringCapableOperatingClassProfileNumberOfEntries
uint32
object
Classuint32MaxTxPower
int32
NonOperablestring
NumberOfNonOperChanuint32
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.CurrentOperatingClassProfile.{i}.objectClass
uint32
Channeluint32
TxPowerint32
TimeStampstring
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}.objectOperatingClass
uint32
ChannelScanNumberOfEntriesuint32
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.object
Channeluint32
TimeStampstringUtilization
uint32Noise
int32
NeighborBSSNumberOfEntriesint32
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.NeighborBSS.{i}.object
BSSIDstringSSID
stringSignalStre
int32ChannelBan
stringChannelUti
uint32
StationCouuint32
objectBSSID
stringSSID
string
Enabledboolean
LastChangeuint32TimeStamp
string
UnicastBytesReceiveduint64
UnicastBytesSentuint64
MulticastBytesReceiveduint64MulticastBytesSent
uint64
BroadcastBytesReceiveduint64
BroadcastBytesSentuint64BackhaulUse
boolean
FronthaulUseboolean
FronthaulAKMsAllowedstringBackhaulAKMsAllowed
stringSTANumberOfEntries
uint32
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)
object
MACAddressstringTimeStamp
stringHTCapabilities
stringVHTCapabilities
stringHECapabilities
string
ClientCapabilitiesstringLastDataDownlinkRate
uint32LastDataUplinkRate
uint32UtilizationReceive
uint32
UtilizationTransmituint32
EstMACDataRateDownlinkuint32EstMACDataRateUplink
uint32
SignalStrengthuint32
LastConnectTimeuint32
BytesReceiveduint64BytesSent
uint64
PacketsReceiveduint64
PacketsSentuint64ErrorsReceived
uint64
ErrorsSentuint64
RetransCountuint64MeasurementReport
stringNumberOfMeasureReports
uint32
command[ASYNC] Initiates an operation to collect BSS information by a station.⇒ Input


unsignedInt[OPTIONAL] Operating Class per [Table E-4/802.11-2020].⇒ Channel
unsignedInt[OPTIONAL]
⇒ ReportingDetailunsignedInt[OPTIONAL]⇒ BSSID
string[OPTIONAL] BSSID for a
⇒ SSIDstring[OPTIONAL] SSID of an BSS


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

[ASYNC] Initiates an EasyMesh [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.

.

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.

⇒ BTMAbridged

booleanBTM abridged.⇒ LinkRemovalImminent
boolean

Link removal imminent.

⇒ SteeringOpportunityWindow

unsignedInt

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.⇐ Status
string

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⇒ ReasonCode
unsignedInt⇒ Silent
boolean


⇐ Output⇐ Statusstring
object
TimedateTime
APOriginstringTriggerEvent
string
SteeringApproachstring
APDestinationstring
SteeringDurationunsignedInt
objectNoCandidateAPFailures
uint64BlacklistAttempts
uint64
BlacklistSuccessesuint64
BlacklistFailuresuint64BTMAttempts
uint64
BTMSuccessesuint64
BTMFailuresuint64
BTMQueryResponsesuint64LastSteerTime
uint32
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.MultiAPRadio.object
command


⇒ Input⇒ Dwell­Timeuint32⇒ ChannelList
uint32⇒ DFSDwell­Time
uint32
⇒ Home­Timeuint32
⇒ SSIDstring


⇐ Output⇐ Statusstring
command


⇒ Input⇒ OpClass.{i}.object  ⇒ OperatingClass

unsignedInt


  ⇒ Channel

unsignedInt

  ⇒ DwellTime
unsignedInt
  ⇒ DFSDwellTimeunsignedInt  ⇒ HomeTime
unsignedInt
  ⇒ SSIDstring⇐ Output⇐ Status


string

⇐ ScanResult.{i}.

object  ⇐ TimeStamp
string  ⇐ ScanResult.{i}.OpClassScan.{i}.
object
    ⇐ OperatingClassunsignedInt
    ⇐ ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.object
      ⇐ ChannelunsignedInt      ⇐ TimeStamp
string
      ⇐ UtilizationunsignedInt      ⇐ ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.NeighborBSS.{i}.
object
        ⇐ BSSIDstring        ⇐ SSID
string

        ⇐ SignalStrength

unsignedInt        ⇐ ChannelBandwidth
string        ⇐ ChannelUtilization
unsignedInt
        ⇐ StationCountunsignedInt        ⇐ SecurityModeEnabled
string
        ⇐ EncryptionModestring[]        ⇐ SupportedStandards
string[]
        ⇐ OperatingStandardsstring[]        ⇐ BasicDataTransferRates
string[]
string[]⇐ SupportedNSS
unsignedInt
unsignedInt
⇐ BeaconPeriodunsignedInt
DeviceNumberOfEntriesuint32
Device.WiFi.DataElements.Network.Device.{i}.X_AIRTIES_Ethernet.Interface.{i}.Device.{i}.object
MACAddressstring
object
Uptimeuint32
Device.WiFi.DataElements.Network.Device.{i}.X_AIRTIES_DeviceInfo.MemoryStatus.object
Totaluint32
Freeuint32Cached
uint32
Device.WiFi.DataElements.Network.Device.{i}.X_AIRTIES_DeviceInfo.ProcessStatus.objectCPUUsage
uint32
CPUTemperatureuint32
object

uint32


Associated!

event


⇒ MACAddress

string


string


uint32

⇒ TimeStamp




object
MACAddressstringBSSID
stringStatusCode
uint32TimeStamp
string
object
DisassociationEventDataNumberOfEntriesuint32
Disassociated!event
⇒ BSSIDstring

⇒ MACAddress


string⇒ ReasonCode
unsignedInt

⇒ TimeStamp




Device.WiFi.DataElements.DisassociationEvent.DisassociationEventData.{i}.object
MACAddressstring
BSSIDstring
ReasonCodeuint32TimeStamp
string
Device.WiFi.DataElements.FailedConnectionEvent.object
FailedConnectionEventDataNumberOfEntriesuint32
event

string


⇒ MACAddressstring
⇒ StatusCodeuint32⇒ ReasonCode
uint32⇒ TimeStamp
string
object

BSSID

string


MACAddressstring
ReasonCodeuint32StatusCode
uint32TimeStamp
string