Represents the latest 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 RFStats resource is not collected from WLAN controllers. When queried, RFStats presents information from the latest successful data collection event. Because radio interface statistics were not collected, the API will present an empty result for disassociated access point radio interfaces. If the dissociation(s) occurred within the last 24 hours, the data/HistoricalRFStats API resource may have more data.
Since Product Version: 1.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 |
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/data/RFStatsDeprecated
This version has been deprecated due to poor performance in large-scale environments. Please use v4/data/RFStats and v4/data/RFLoadStats.
Response Parameters
Attribute | Description |
---|---|
channelNumber ChannelNumberEnum |
Channel number that the radio is operating on
|
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. |
coverageProfile RFProfileEnum |
|
ethernetMac String |
MAC address of the ethernet interface on the AP |
interferenceProfile RFProfileEnum |
Interference profile
|
loadProfile RFProfileEnum |
Load profile
|
macAddress String |
Base radio MAC address |
noiseProfile RFProfileEnum |
Noise profile
|
operStatus RadioOperStatusEnum |
Operational Status
|
poorCoverageClients int |
Poor coverage clients |
powerLevel int |
Power level of the radio |
rxUtilization int |
Rx Utilization (%) |
slotId String |
Slot ID of the radio |
txPowerOutput Integer |
The txPower currently being used to transmit data, in dBm |
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://10.64.88.203/webacs/api/v1/data/RFStats/15
<?xml version="1.0" ?>
<queryResponse type="RFStats" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v1/data/RFStats/15" rootUrl="https://10.64.88.203/webacs/api/v1/data">
<entity dtoType="rFStatsDTO" type="RFStats" url="https://10.64.88.203/webacs/api/v1/data/RFStats/15">
<rfStatsDTO displayName="String value" id="15" uuid="String value">
<channelNumber>UNKNOWN</channelNumber>
<clientCount>1</clientCount>
<coverageProfile>FAILED</coverageProfile>
<interferenceProfile>FAILED</interferenceProfile>
<loadProfile>FAILED</loadProfile>
<noiseProfile>FAILED</noiseProfile>
<operStatus>DOWN</operStatus>
<powerLevel>1</powerLevel>
<channelUtilization>1</channelUtilization>
<collectionTime>String value</collectionTime>
<ethernetMac>String value</ethernetMac>
<macAddress>String value</macAddress>
<poorCoverageClients>1</poorCoverageClients>
<rxUtilization>1</rxUtilization>
<slotId>String value</slotId>
<txPowerOutput>15</txPowerOutput>
<txUtilization>1</txUtilization>
</rfStatsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.64.88.203/webacs/api/v1/data/RFStats/15.json
{
"queryResponse" : {
"@type" : "RFStats",
"@responseType" : "getEntity",
"@requestUrl" : "https : //10.64.88.203/webacs/api/v1/data/RFStats/15",
"@rootUrl" : "https : //10.64.88.203/webacs/api/v1/data",
"entity" : {
"@dtoType" : "rFStatsDTO",
"@type" : "RFStats",
"@url" : "https : //10.64.88.203/webacs/api/v1/data/RFStats/15",
"rfStatsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"channelNumber" : "UNKNOWN",
"clientCount" : 1,
"coverageProfile" : "FAILED",
"interferenceProfile" : "FAILED",
"loadProfile" : "FAILED",
"noiseProfile" : "FAILED",
"operStatus" : "DOWN",
"powerLevel" : 1,
"channelUtilization" : 1,
"collectionTime" : "String value",
"ethernetMac" : "String value",
"macAddress" : "String value",
"poorCoverageClients" : 1,
"rxUtilization" : 1,
"slotId" : "String value",
"txPowerOutput" : 15,
"txUtilization" : 1
}
}
}
}