Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

GET RFStats

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

xml

json

User Group

NBI Read

HTTP Methods

GET

Resource URL

/webacs/api/v4/data/RFStats

Updated

Since version 4 types of attributes macAddress, ethernetMac, slotId and collectionTime have been changed.

Response Parameters

Attribute Description

channelNumber ChannelNumberEnum

Channel number that the radio is operating on

  • UNKNOWN
  • _1
  • _2
  • _3
  • _4
  • _5
  • _6
  • _7
  • _8
  • _9
  • _10
  • _11
  • _12
  • _13
  • _14
  • _20
  • _21
  • _22
  • _23
  • _24
  • _25
  • _26
  • _34
  • _36
  • _38
  • _40
  • _42
  • _44
  • _46
  • _48
  • _52
  • _56
  • _60
  • _64
  • _100
  • _104
  • _108
  • _112
  • _116
  • _120
  • _124
  • _128
  • _132
  • _136
  • _140
  • _144
  • _149
  • _153
  • _157
  • _161
  • _165
  • _169
  • _173

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

  • FAILED
  • PASSED

ethernetMac MacAddress

MAC address of the ethernet interface on the AP

interferenceProfile RFProfileEnum

Interference profile

  • FAILED
  • PASSED

loadProfile RFProfileEnum

Load profile

  • FAILED
  • PASSED

macAddress MacAddress

Base radio MAC address

noiseProfile RFProfileEnum

Noise profile

  • FAILED
  • PASSED

operStatus RadioOperStatusEnum

Operational Status

  • DOWN
  • UP
  • NOTASSOCIATED
  • UNKNOWN

powerLevel int

Power level of the radio

slotId int

Slot ID of the radio

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://172.20.127.108/webacs/api/v4/data/RFStats/15

<?xml version="1.0" ?>
<queryResponse type="RFStats" responseType="getEntity" requestUrl="https://172.20.127.108/webacs/api/v4/data/RFStats/15" rootUrl="https://172.20.127.108/webacs/api/v4/data">
  <entity dtoType="rFStatsDTO" type="RFStats" url="https://172.20.127.108/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:00Z</collectionTime>
      <ethernetMac>
        <octets>000a959d6816</octets>
      </ethernetMac>
      <macAddress>
        <octets>000a959d6816</octets>
      </macAddress>
      <slotId>1</slotId>
      <txPowerOutput>15</txPowerOutput>
    </rfStatsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://172.20.127.108/webacs/api/v4/data/RFStats/15.json

{
  "queryResponse" : {
    "@type" : "RFStats",
    "@requestUrl" : "https://172.20.127.108/webacs/api/v4/data/RFStats/15",
    "@responseType" : "getEntity",
    "@rootUrl" : "https://172.20.127.108/webacs/api/v4/data",
    "entity" : [ {
      "@dtoType" : "rFStatsDTO",
      "@type" : "RFStats",
      "@url" : "https://172.20.127.108/webacs/api/v4/data/RFStats/15",
      "rfStatsDTO" : {
        "@displayName" : "String value",
        "@id" : 15,
        "@uuid" : "String value",
        "channelNumber" : "UNKNOWN",
        "clientCount" : 1,
        "collectionTime" : "1986-07-24T00: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
      }
    } ]
  }
}