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
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
API version v1 is deprecated
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/RFStats
Deprecated
This version has been deprecated due to poor performance in large-scale environments. Please use v4/data/RFStats and v4/data/RFLoadStats.
Response Parameters
channelNumber
ChannelNumberEnum
|
Channel number that the radio is operating on
|
channelUtilization
int
|
|
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
|
|
loadProfile
RFProfileEnum
|
|
macAddress
String
|
|
noiseProfile
RFProfileEnum
|
|
operStatus
RadioOperStatusEnum
|
|
poorCoverageClients
int
|
|
powerLevel
int
|
|
rxUtilization
int
|
|
slotId
String
|
|
txPowerOutput
Integer
|
The txPower currently being used to transmit data, in dBm
|
txUtilization
int
|
|
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>
<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://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",
"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
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/data/RFStats
Unmodified
This resource has not been modified since the previous API version.
Deprecated
This version has been deprecated due to poor performance in large-scale environments. Please use v4/data/RFStats and v4/data/RFLoadStats.
Response Parameters
channelNumber
ChannelNumberEnum
|
Channel number that the radio is operating on
|
channelUtilization
int
|
|
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
|
|
loadProfile
RFProfileEnum
|
|
macAddress
String
|
|
noiseProfile
RFProfileEnum
|
|
operStatus
RadioOperStatusEnum
|
|
poorCoverageClients
int
|
|
powerLevel
int
|
|
rxUtilization
int
|
|
slotId
String
|
|
txPowerOutput
Integer
|
The txPower currently being used to transmit data, in dBm
|
txUtilization
int
|
|
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/v2/data/RFStats/15
<?xml version="1.0" ?>
<queryResponse type="RFStats" responseType="getEntity" requestUrl="https://localhost/webacs/api/v2/data/RFStats/15" rootUrl="https://localhost/webacs/api/v2/data">
<entity dtoType="rFStatsDTO" type="RFStats" url="https://localhost/webacs/api/v2/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://localhost/webacs/api/v2/data/RFStats/15.json
{
"queryResponse" : {
"@type" : "RFStats",
"@requestUrl" : "https://localhost/webacs/api/v2/data/RFStats/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "rFStatsDTO",
"@type" : "RFStats",
"@url" : "https://localhost/webacs/api/v2/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
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/data/RFStats
Updated
Since version 3 this API does not contain load statistics. Please use data/RFLoadStats.
Deprecated
This version has been deprecated. Please use v4.
Response Parameters
channelNumber
ChannelNumberEnum
|
Channel number that the radio is operating on
|
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
|
|
loadProfile
RFProfileEnum
|
|
macAddress
String
|
|
noiseProfile
RFProfileEnum
|
|
operStatus
RadioOperStatusEnum
|
|
powerLevel
int
|
|
slotId
String
|
|
txPowerOutput
Integer
|
The txPower currently being used to transmit data, in dBm
|
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/v3/data/RFStats/15
<?xml version="1.0" ?>
<queryResponse type="RFStats" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/RFStats/15" rootUrl="https://localhost/webacs/api/v3/data">
<entity dtoType="rFStatsDTO" type="RFStats" url="https://localhost/webacs/api/v3/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>
<collectionTime>String value</collectionTime>
<ethernetMac>String value</ethernetMac>
<macAddress>String value</macAddress>
<slotId>String value</slotId>
<txPowerOutput>15</txPowerOutput>
</rfStatsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v3/data/RFStats/15.json
{
"queryResponse" : {
"@type" : "RFStats",
"@requestUrl" : "https://localhost/webacs/api/v3/data/RFStats/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "rFStatsDTO",
"@type" : "RFStats",
"@url" : "https://localhost/webacs/api/v3/data/RFStats/15",
"rfStatsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"channelNumber" : "UNKNOWN",
"clientCount" : 1,
"collectionTime" : "String value",
"coverageProfile" : "FAILED",
"ethernetMac" : "String value",
"interferenceProfile" : "FAILED",
"loadProfile" : "FAILED",
"macAddress" : "String value",
"noiseProfile" : "FAILED",
"operStatus" : "DOWN",
"powerLevel" : 1,
"slotId" : "String value",
"txPowerOutput" : 15
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/data/RFStats
Updated
Since version 4 types of attributes macAddress, ethernetMac, slotId and collectionTime have been changed.
Response Parameters
channelNumber
ChannelNumberEnum
|
Channel number that the radio is operating on
|
clientCount
int
|
Number of associated clients
|
collectionTime
Date
|
The time collection of this record was finished.
Note: The date has an incorrect UTC offset. Please see
the FAQ for details.
|
coverageProfile
RFProfileEnum
|
|
ethernetMac
MacAddress
|
MAC address of the ethernet interface on the AP
|
interferenceProfile
RFProfileEnum
|
|
loadProfile
RFProfileEnum
|
|
macAddress
MacAddress
|
|
noiseProfile
RFProfileEnum
|
|
operStatus
RadioOperStatusEnum
|
|
powerLevel
int
|
|
slotId
int
|
|
txPowerOutput
Integer
|
The txPower currently being used to transmit data, in dBm
|
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/v4/data/RFStats/15
<?xml version="1.0" ?>
<queryResponse type="RFStats" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/RFStats/15" rootUrl="https://localhost/webacs/api/v4/data">
<entity dtoType="rFStatsDTO" type="RFStats" url="https://localhost/webacs/api/v4/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>
<collectionTime>1986-07-24T00:00:00+08:00</collectionTime>
<ethernetMac>
<octets>000a959d6816</octets>
</ethernetMac>
<macAddress>
<octets>000a959d6816</octets>
</macAddress>
<slotId>1</slotId>
<txPowerOutput>15</txPowerOutput>
</rfStatsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/data/RFStats/15.json
{
"queryResponse" : {
"@type" : "RFStats",
"@requestUrl" : "https://localhost/webacs/api/v4/data/RFStats/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "rFStatsDTO",
"@type" : "RFStats",
"@url" : "https://localhost/webacs/api/v4/data/RFStats/15",
"rfStatsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"channelNumber" : "UNKNOWN",
"clientCount" : 1,
"collectionTime" : "1986-07-23T16:00:00.000Z",
"coverageProfile" : "FAILED",
"ethernetMac" : {
"octets" : "000a959d6816"
},
"interferenceProfile" : "FAILED",
"loadProfile" : "FAILED",
"macAddress" : {
"octets" : "000a959d6816"
},
"noiseProfile" : "FAILED",
"operStatus" : "DOWN",
"powerLevel" : 1,
"slotId" : 1,
"txPowerOutput" : 15
}
} ]
}
}