Represents the latest load statistics information for radio interfaces of lightweight wireless access points collected from WLAN controllers. Note that when access points are in a dissociated state, the radio interface statistics presented by the RFLoadStats resource is not collected from WLAN controllers. When queried, the API presents information from the latest successful data collection event.
Since Product Version: 3.2
Resource Information
Rate Limiting? |
Yes |
Sorting? |
Yes |
Paging? |
Yes |
Filtering? |
Yes |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v3/data/RFLoadStatsDeprecated
This version has been deprecated. Please use v4.
Response Parameters
Attribute | Description |
---|---|
channelUtilization int |
Channel Utilization (%) |
clientCount int |
Number of associated clients |
collectionTime String |
The time collection of this record was finished, measured in milliseconds since the Unix epoch. |
ethernetMac String |
MAC address of the ethernet interface on the AP |
macAddress String |
Base radio MAC address |
poorCoverageClients int |
Poor coverage clients |
rxUtilization int |
Rx Utilization (%) |
slotId String |
Slot ID of the radio |
txUtilization int |
Tx Utilization (%) |
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://172.20.127.108/webacs/api/v3/data/RFLoadStats/15
<?xml version="1.0" ?>
<queryResponse type="RFLoadStats" responseType="getEntity" requestUrl="https://172.20.127.108/webacs/api/v3/data/RFLoadStats/15" rootUrl="https://172.20.127.108/webacs/api/v3/data">
<entity dtoType="rFLoadStatsDTO" type="RFLoadStats" url="https://172.20.127.108/webacs/api/v3/data/RFLoadStats/15">
<rfLoadStatsDTO displayName="String value" id="15" uuid="String value">
<channelUtilization>1</channelUtilization>
<clientCount>1</clientCount>
<poorCoverageClients>1</poorCoverageClients>
<rxUtilization>1</rxUtilization>
<txUtilization>1</txUtilization>
<collectionTime>String value</collectionTime>
<ethernetMac>String value</ethernetMac>
<macAddress>String value</macAddress>
<slotId>String value</slotId>
</rfLoadStatsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://172.20.127.108/webacs/api/v3/data/RFLoadStats/15.json
{
"queryResponse" : {
"@type" : "RFLoadStats",
"@requestUrl" : "https://172.20.127.108/webacs/api/v3/data/RFLoadStats/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://172.20.127.108/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "rFLoadStatsDTO",
"@type" : "RFLoadStats",
"@url" : "https://172.20.127.108/webacs/api/v3/data/RFLoadStats/15",
"rfLoadStatsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"channelUtilization" : 1,
"clientCount" : 1,
"collectionTime" : "String value",
"ethernetMac" : "String value",
"macAddress" : "String value",
"poorCoverageClients" : 1,
"rxUtilization" : 1,
"slotId" : "String value",
"txUtilization" : 1
}
} ]
}
}