Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET RFLoadStats

Represents the latest load statistics information for radio interfaces of lightweight wireless access points collected from WLAN controllers.

Since Product Version: 3.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/v3/data/RFLoadStats

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>
      <collectionTime>String value</collectionTime>
      <ethernetMac>String value</ethernetMac>
      <macAddress>String value</macAddress>
      <poorCoverageClients>1</poorCoverageClients>
      <rxUtilization>1</rxUtilization>
      <slotId>String value</slotId>
      <txUtilization>1</txUtilization>
    </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
      }
    } ]
  }
}