RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
...
Name | Type | Notes |
---|---|---|
Device.WiFi.DataElements.Network. | object | |
ID | string | |
TimeStamp | string | |
DeviceNumberOfEntries | uint32 | |
SSIDNumberOfEntries | uint32 | |
SetSSID() | command | |
⇒ Input | ||
⇒ SSID | string | |
⇒ AddRemove | string | |
⇒ PassPhrase | string | |
⇒ Band | string[] | |
⇐ Output | ||
⇐ Status | string | |
Device.WiFi.DataElements.Network.SSID.{i}. | object | |
SSID | string | |
Enabled | boolean | |
Band | string | |
AdvertisementEnabled | boolean | |
Passphrase | string | |
AKMsAllowed | string | |
Reference | string | |
Direction | string | |
X_AIRTIES_VID | int32 | VLAN ID to be set for this instance of SSID |
Device.WiFi.DataElements.Network.Device.{i}. | object | |
ID | string | |
Manufacturer | string | |
SerialNumber | string | |
ManufacturerModel | string | |
SoftwareVersion | string | |
ExecutionEnv | string | |
CountryCode | string | |
MultiAPProfile | uint32 | |
RadioNumberOfEntries | uint32 | |
CACStatusNumberOfEntries | uint32 | |
X_AIRTIES_UnassociatedStaLinkMetricsQuery() | command | [ASYNC] Initiates to collect signal strength level of unassociated stations per device |
⇒ Input | ||
⇒ OpClass | UnsignedInt | [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}.Channel | UnsignedInt | Channel number in a Channel list object instance |
⇒ Channel.{i}.STA.{i} | object | A list of Station entries |
⇒ Channel.{i}.STA.{i}.MAC | string | MAC address of the station |
⇐ Output | ||
⇐ Status | string | Indicates the type of outcome of the request to enable or disable this radio. Enumeration of:
|
⇐ OpClass | UnsignedInt | The Operating Class per [Table E-4/802.11-2020] For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid. |
⇐ STA.{i}. | object | A list of information for each station seen by the Device |
⇐ STA.{i}.Channel | UnsignedInt | Channel for the station |
⇐ STA.{i}.MACAddress | string | MAC address of the station |
⇐ STA.{i}.SignalStrength | UnsignedInt | Signal strength of the station |
Device.WiFi.DataElements.Network.Device.{i}.MultiAPDevice.Backhaul. | object | |
LinkType | string | |
BackhaulMACAddress | string | |
BackhaulDeviceID | string | |
MACAddress | string | |
Device.WiFi.DataElements.Network.Device.{i}.MultiAPDevice.Backhaul.Stats. | object | |
BytesReceived | uint64 | |
BytesSent | uint64 | |
PacketsReceived | uint64 | |
PacketsSent | uint64 | |
ErrorsReceived | uint64 | |
ErrorsSent | uint64 | |
SignalStrength | uint32 | |
LastDataDownlinkRate | uint32 | |
LastDataUplinkRate | uint32 | |
TimeStamp | string | |
Device.WiFi.DataElements.Network.Device.{i}.CACStatus.{i}. | object | |
TimeStamp | string | |
CACAvailableChannelNumberOfEntries | uint32 | |
CACNonOccupancyChannelNumberOfEntries | uint32 | |
CACActiveChannelNumberOfEntries | uint32 | |
Device.WiFi.DataElements.Network.Device.{i}.CACStatus.{i}.CACAvailableChannel.{i}. | object | |
OpClass | uint32 | |
Channel | uint32 | |
Minutes | uint32 | |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}. | object | |
ID | string | |
Enabled | boolean | |
Noise | uint32 | |
Utilization | uint32 | |
Transmit | uint32 | |
ReceiveSelf | uint32 | |
ReceiveOther | uint32 | |
X_AIRTIES_Temperature | uint32 | |
BSSNumberOfEntries | uint32 | |
CurrentOperatingClassProfileNumberOfEntries | uint32 | |
ScanResultNumberOfEntries | uint32 | |
UnassociatedSTANumberOfEntries | uint32 | |
ChannelScanRequest() | command | |
⇒ Input | ||
⇒ OpClass | uint32 | |
⇒ ChannelList | string | |
⇐ Output | ||
⇐ Status | string | |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BackhaulSta. | object | |
MACAddress | string | |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities. | object | |
HTCapabilities | string | |
VHTCapabilities | string | |
HECapabilities | string | |
CapableOperatingClassProfileNumberOfEntries | uint32 | |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.CapableOperatingClassProfile.{i}. | object | |
Class | uint32 | |
MaxTxPower | int32 | |
NonOperable | string | |
NumberOfNonOperChan | uint32 | |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.CurrentOperatingClassProfile.{i}. | object | |
Class | uint32 | |
Channel | uint32 | |
TxPower | int32 | |
TimeStamp | string | |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}. | object | |
TimeStamp | string | |
OpClassScanNumberOfEntries | uint32 | |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}. | object | |
OperatingClass | uint32 | |
ChannelScanNumberOfEntries | uint32 | |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}. | object | |
Channel | uint32 | |
TimeStamp | string | |
Utilization | uint32 | |
Noise | int32 | |
NeighborBSSNumberOfEntries | int32 | |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.NeighborBSS.{i}. | object | |
BSSID | string | |
SSID | string | |
SignalStre | int32 | |
ChannelBan | string | |
ChannelUti | uint32 | |
StationCou | uint32 | |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}. | object | |
BSSID | string | |
SSID | string | |
Enabled | boolean | |
LastChange | uint32 | |
TimeStamp | string | |
UnicastBytesReceived | uint64 | |
UnicastBytesSent | uint64 | |
MulticastBytesReceived | uint64 | |
MulticastBytesSent | uint64 | |
BroadcastBytesReceived | uint64 | |
BroadcastBytesSent | uint64 | |
BackhaulUse | boolean | |
FronthaulUse | boolean | |
FronthaulAKMsAllowed | string | |
BackhaulAKMsAllowed | string | |
STANumberOfEntries | uint32 | |
X_AIRTIES_ClientAssocControl() | command | [SYNC] Unblocks or blocks stations for a period of time |
⇒ Input | ||
⇒ StationsList | string | [MANDATORY] Comma separated list of station MAC addresses |
⇒ Block | Boolean | [OPTIONAL] If true station MAC addresses in StationsList will be blocked. Otherwise they will be unblocked. |
⇒ Period | unsignedInt | [OPTIONAL] Period in milliseconds to block stations given in StationsList. Required if Block parameter is given. |
⇐ Output | ||
⇐ Status | string | Enumeration of:
|
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}. | object | |
MACAddress | string | |
TimeStamp | string | |
HTCapabilities | string | |
VHTCapabilities | string | |
HECapabilities | string | |
ClientCapabilities | string | |
LastDataDownlinkRate | uint32 | |
LastDataUplinkRate | uint32 | |
UtilizationReceive | uint32 | |
UtilizationTransmit | uint32 | |
EstMACDataRateDownlink | uint32 | |
EstMACDataRateUplink | uint32 | |
SignalStrength | uint32 | |
LastConnectTime | uint32 | |
BytesReceived | uint64 | |
BytesSent | uint64 | |
PacketsReceived | uint64 | |
PacketsSent | uint64 | |
ErrorsReceived | uint64 | |
ErrorsSent | uint64 | |
RetransCount | uint64 | |
MeasurementReport | string | |
NumberOfMeasureReports | uint32 | |
X_AIRTIES_BeaconMetricsQuery() | command | [ASYNC] Initiates an operation to collect BSS information by a station. |
⇒ Input | ||
⇒ OperatingClass | unsignedInt | [OPTIONAL] Operating Class per [Table E-4/802.11-2020]. |
⇒ Channel | unsignedInt | [OPTIONAL] |
⇒ ReportingDetail | unsignedInt | [OPTIONAL] |
⇒ BSSID | string | [OPTIONAL] BSSID for a |
⇒ SSID | string | [OPTIONAL] SSID of an BSS |
⇐ Output | ||
⇐ Status | string | Enumeration of:
|
ClientSteer() | command | [ASYNC] Initiates an EasyMesh [EasyMesh] Controller initiated steering mandate request to steer a STA from one EasyMesh agent to another. |
⇒ Input. | arguments | Input arguments. |
⇒ TargetBSS | string(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. |
⇒ RequestMode | string | The request mode. Enumeration of: |
⇒ BTMDisassociationImminent | boolean | BTM disassociation imminent. |
⇒ BTMAbridged | boolean | BTM 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. |
⇒ BTMDisassociationTimer | unsignedInt | Time period in TUs of the disassociation timer in the BTM Request. |
⇒ TargetBSSOperatingClass | unsignedInt(:255) | The Target BSS Operating Class per [Table E-4/802.11-2020]. |
⇒ TargetBSSChannel | unsignedInt(:255) | Target BSS channel number for channel on which the Target BSS is transmitting Beacon frames. |
⇒ ReasonCode | unsignedInt(:255) | |
⇐ Output. | arguments | Output arguments. |
⇐ Status | string | Indicates the response to the Wi-Fi client steering request. Enumeration of: |
⇐ BTMStatusCode | unsignedInt | Indicates the value of the BTM Status Code as reported by the STA in the BTM Response (per [Table 9-428/802.11-2020]). |
⇐ TargetBSSID | string(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]). |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.MultiAPSTA. | object | |
SteeringHistoryNumberOfEntries | uint64 | |
Disassociate() | command | |
⇒ Input | ||
⇒ DisassociationTimer | unsignedInt | |
⇒ ReasonCode | unsignedInt | |
⇒ Silent | boolean | |
⇐ Output | ||
⇐ Status | string | |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.MultiAPSTA.SteeringHistory.{i}. | object | |
Time | dateTime | |
APOrigin | string | |
TriggerEvent | string | |
SteeringApproach | string | |
APDestination | string | |
SteeringDuration | unsignedInt | |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.MultiAPSTA.SteeringSummaryStats. | object | |
NoCandidateAPFailures | uint64 | |
BlacklistAttempts | uint64 | |
BlacklistSuccesses | uint64 | |
BlacklistFailures | uint64 | |
BTMAttempts | uint64 | |
BTMSuccesses | uint64 | |
BTMFailures | uint64 | |
BTMQueryResponses | uint64 | |
LastSteerTime | uint32 | |
Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.MultiAPRadio. | object | |
FullScan() | command | |
⇒ Input | ||
⇒ DwellTime | uint32 | |
⇒ ChannelList | uint32 | |
⇒ DFSDwellTime | uint32 | |
⇒ HomeTime | uint32 | |
⇒ SSID | string | |
⇐ Output | ||
⇐ Status | string | |
ChannelScan() | command | |
⇒ Input | ||
⇒ OpClass.{i}. | object | |
⇒ OperatingClass | unsignedInt | |
⇒ Channel | unsignedInt | |
⇒ DwellTime | unsignedInt | |
⇒ DFSDwellTime | unsignedInt | |
⇒ HomeTime | unsignedInt | |
⇒ SSID | string | |
⇐ Output | ||
⇐ Status | string | |
⇐ ScanResult.{i}. | object | |
⇐ TimeStamp | string | |
⇐ ScanResult.{i}.OpClassScan.{i}. | object | |
⇐ OperatingClass | unsignedInt | |
⇐ ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}. | object | |
⇐ Channel | unsignedInt | |
⇐ TimeStamp | string | |
⇐ Utilization | unsignedInt | |
⇐ ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.NeighborBSS.{i}. | object | |
⇐ BSSID | string | |
⇐ SSID | string | |
⇐ SignalStrength | unsignedInt | |
⇐ ChannelBandwidth | string | |
⇐ ChannelUtilization | unsignedInt | |
⇐ StationCount | unsignedInt | |
⇐ SecurityModeEnabled | string | |
⇐ EncryptionMode | string[] | |
⇐ SupportedStandards | string[] | |
⇐ OperatingStandards | string[] | |
⇐ BasicDataTransferRates | string[] | |
⇐ SupportedDataTransferRates | string[] | |
⇐ SupportedNSS | unsignedInt | |
⇐ DTIMPeriod | unsignedInt | |
⇐ BeaconPeriod | unsignedInt | |
DeviceNumberOfEntries | uint32 | |
Device.WiFi.DataElements.Network.Device.{i}.X_AIRTIES_Ethernet.Interface.{i}.Device.{i}. | object | |
MACAddress | string | |
Device.WiFi.DataElements.Network.Device.{i}.X_AIRTIES_DeviceInfo. | object | |
Uptime | uint32 | |
Device.WiFi.DataElements.Network.Device.{i}.X_AIRTIES_DeviceInfo.MemoryStatus. | object | |
Total | uint32 | |
Free | uint32 | |
Cached | uint32 | |
Device.WiFi.DataElements.Network.Device.{i}.X_AIRTIES_DeviceInfo.ProcessStatus. | object | |
CPUUsage | uint32 | |
CPUTemperature | uint32 | |
Device.WiFi.DataElements.AssociationEvent. | object | |
AssociationEventDataNumberOfEntries | uint32 | |
Associated! | event | |
⇒ MACAddress | ||
⇒ BSSID | ||
⇒ StatusCode | ||
⇒ TimeStamp | ||
Device.WiFi.DataElements.AssociationEvent.AssociationEventData.{i}. | object | |
MACAddress | string | |
BSSID | string | |
StatusCode | uint32 | |
TimeStamp | string | |
Device.WiFi.DataElements.DisassociationEvent. | object | |
DisassociationEventDataNumberOfEntries | uint32 | |
Disassociated! | event | |
⇒ BSSID | string | |
⇒ MACAddress | string | |
⇒ ReasonCode | unsignedInt | |
Device.WiFi.DataElements.DisassociationEvent.DisassociationEventData.{i}. | object | |
MACAddress | string | |
BSSID | string | |
ReasonCode | uint32 | |
TimeStamp | string | |
Device.WiFi.DataElements.FailedConnectionEvent. | object | |
FailedConnectionEventDataNumberOfEntries | uint32 | |
FailedConnection! | event | |
⇒ BSSID | string | |
⇒ MACAddress | string | |
⇒ StatusCode | uint32 | |
⇒ ReasonCode | uint32 | |
⇒ TimeStamp | string | |
Device.WiFi.DataElements.FailedConnectionEvent.FailedConnectionEventData.{i}. | object | |
BSSID | string | |
MACAddress | string | |
ReasonCode | uint32 | |
StatusCode | uint32 | |
TimeStamp | string |