Represents the latest statistics information for radio interfaces of lightweight wireless access points collected from WLAN controllers.
Since Product Version: 1.2
Resource Information
Rate Limiting? |
Yes |
Sorting? |
Yes |
Paging? |
Yes |
Filtering? |
Yes |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
DevNet Discussions
Resource URL
/webacs/api/v1/data/RFStats DeprecatedThis version has been deprecated due to poor performance in large-scale environments. Please use v3/data/RFStats and v3/data/RFLoadStats.
Response Parameters
Attribute | Description |
---|---|
channelNumber ChannelNumberEnum |
Channel number that the radio is operating on Allowed values: |
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 |
Allowed values: |
ethernetMac String |
MAC address of the ethernet interface on the AP |
interferenceProfile RFProfileEnum |
Interference profile Allowed values: |
loadProfile RFProfileEnum |
Load profile Allowed values: |
macAddress String |
Base radio MAC address |
noiseProfile RFProfileEnum |
Noise profile Allowed values: |
operStatus RadioOperStatusEnum |
Operational Status Allowed values: |
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://localhost/webacs/api/v1/data/RFStats/15
<?xml version="1.0" ?>
<queryResponse type="RFStats" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/RFStats/15" rootUrl="https://localhost/webacs/api/v1/data">
<entity dtoType="rFStatsDTO" type="RFStats" url="https://localhost/webacs/api/v1/data/RFStats/15">
<rfStatsDTO displayName="String value" id="15" uuid="String value">
<channelNumber>UNKNOWN</channelNumber>
<channelUtilization>1</channelUtilization>
<clientCount>1</clientCount>
<collectionTime>String value</collectionTime>
<coverageProfile>FAILED</coverageProfile>
<ethernetMac>String value</ethernetMac>
<interferenceProfile>FAILED</interferenceProfile>
<loadProfile>FAILED</loadProfile>
<macAddress>String value</macAddress>
<noiseProfile>FAILED</noiseProfile>
<operStatus>DOWN</operStatus>
<poorCoverageClients>1</poorCoverageClients>
<powerLevel>1</powerLevel>
<rxUtilization>1</rxUtilization>
<slotId>String value</slotId>
<txPowerOutput>15</txPowerOutput>
<txUtilization>1</txUtilization>
</rfStatsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v1/data/RFStats/15.json
{
"queryResponse" : {
"@type" : "RFStats",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/RFStats\/15",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "rFStatsDTO",
"@type" : "RFStats",
"@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/RFStats\/15",
"rfStatsDTO" : {
"@displayName" : "String value",
"@id" : "15",
"@uuid" : "String value",
"channelNumber" : "UNKNOWN",
"channelUtilization" : 1,
"clientCount" : 1,
"collectionTime" : "String value",
"coverageProfile" : "FAILED",
"ethernetMac" : "String value",
"interferenceProfile" : "FAILED",
"loadProfile" : "FAILED",
"macAddress" : "String value",
"noiseProfile" : "FAILED",
"operStatus" : "DOWN",
"poorCoverageClients" : 1,
"powerLevel" : 1,
"rxUtilization" : 1,
"slotId" : "String value",
"txPowerOutput" : 15,
"txUtilization" : 1
}
}
}
}