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. 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. 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/HistoricalRFLoadStats API resource may have more data.

Since Product Version: 3.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

Resource URL

/webacs/api/v4/data/RFLoadStats

Updated

Since 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. Add the appliance UTC offset to get the correct date.

ethernetMac MacAddress

MAC address of the ethernet interface on the AP

instanceOrigin InstanceOriginEnum

Allowed values:

  • UNCONCERNED
  • APPLICATION
  • NETWORK

instanceTenantId Integer

This is a tenant id for this instance.

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" instanceTenantId="String value" uuid="String value">
      <channelUtilization>1</channelUtilization>
      <clientCount>1</clientCount>
      <poorCoverageClients>1</poorCoverageClients>
      <rxUtilization>1</rxUtilization>
      <txUtilization>1</txUtilization>
      <collectionTime>2018-12-21T12:10:22.989+07:00</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,
        "@instanceTenantId" : "String value",
        "@uuid" : "String value",
        "channelUtilization" : 1,
        "clientCount" : 1,
        "collectionTime" : "2018-12-21T05:10:22.989Z",
        "ethernetMac" : {
          "octets" : "000a959d6816"
        },
        "macAddress" : {
          "octets" : "000a959d6816"
        },
        "poorCoverageClients" : 1,
        "rxUtilization" : 1,
        "slotId" : 1,
        "txUtilization" : 1
      }
    } ]
  }
}