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
-
Jump To
- AAA/TACACS+ Servers Operations Service (4)
- AP Onboarding Profile Management Service (4)
- API Health Service (6)
- Access Point Operations (5)
- Alarms Management Service (5)
- Application Visibility and Control Service (1)
- CLI Template Configuration (12)
- Clients (7)
- Compliance Service (5)
- Configuration Archive Service (7)
- Credential Profile Management Service (5)
- Credentials Service (1)
- Device Details (9)
- Device Operations (9)
- Group Management Service (8)
- Group Summary Service (8)
- Guest User Management Service (8)
- Job Operations (6)
- MAC Filters Management Service (5)
- Manage and Monitor Info Service (5)
- Managed Servers Operations (for Operations Center) (6)
- Plug and Play (11)
- Rate Limits Management Service (2)
- Report Service (4)
- Site Map Service (3)
- Software Updates (2)
- Statistics (91)
- System Settings (26)
- Trap Receivers (4)
- User Defined Field Management (3)
- User Management Service (5)
- VNF Provisioning (16)
- Virtual Domains Management Service (10)
- Virtual Image Repository (8)
- WLAN Provisioning (16)
- Wireless Device Details (22)
- v1
- v2
- v3
- v4
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.
This resource was introduced in API version 3.
This resource was introduced in API version 3.
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/RFLoadStats DeprecatedThis 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://localhost/webacs/api/v3/data/RFLoadStats/15
<?xml version="1.0" ?>
<queryResponse type="RFLoadStats" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/RFLoadStats/15" rootUrl="https://localhost/webacs/api/v3/data">
<entity dtoType="rFLoadStatsDTO" type="RFLoadStats" url="https://localhost/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://localhost/webacs/api/v3/data/RFLoadStats/15.json
{
"queryResponse" : {
"@type" : "RFLoadStats",
"@requestUrl" : "https://localhost/webacs/api/v3/data/RFLoadStats/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "rFLoadStatsDTO",
"@type" : "RFLoadStats",
"@url" : "https://localhost/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
}
} ]
}
}
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/v4/data/RFLoadStats UpdatedSince version 4 types of attributes macAddress, ethernetMac, slotId and collectionTime have been changed.
Response Parameters
Attribute | Description |
---|---|
channelUtilization int |
Channel Utilization (%) |
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. |
ethernetMac MacAddress |
MAC address of the ethernet interface on the AP |
macAddress MacAddress |
Base radio MAC address |
poorCoverageClients int |
Poor coverage clients |
rxUtilization int |
Rx Utilization (%) |
slotId int |
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://localhost/webacs/api/v4/data/RFLoadStats/15
<?xml version="1.0" ?>
<queryResponse type="RFLoadStats" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/RFLoadStats/15" rootUrl="https://localhost/webacs/api/v4/data">
<entity dtoType="rFLoadStatsDTO" type="RFLoadStats" url="https://localhost/webacs/api/v4/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>2019-08-20T09:03:25.133Z</collectionTime>
<ethernetMac>
<octets>000a959d6816</octets>
</ethernetMac>
<macAddress>
<octets>000a959d6816</octets>
</macAddress>
<slotId>1</slotId>
</rfLoadStatsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/data/RFLoadStats/15.json
{
"queryResponse" : {
"@type" : "RFLoadStats",
"@requestUrl" : "https://localhost/webacs/api/v4/data/RFLoadStats/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "rFLoadStatsDTO",
"@type" : "RFLoadStats",
"@url" : "https://localhost/webacs/api/v4/data/RFLoadStats/15",
"rfLoadStatsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"channelUtilization" : 1,
"clientCount" : 1,
"collectionTime" : "2019-08-20T09:03:25.133Z",
"ethernetMac" : {
"octets" : "000a959d6816"
},
"macAddress" : {
"octets" : "000a959d6816"
},
"poorCoverageClients" : 1,
"rxUtilization" : 1,
"slotId" : 1,
"txUtilization" : 1
}
} ]
}
}