Cisco Prime Infrastructure API
Prime Infrastructure API Documentation
GET_RFCounters

GET RFCounters

Resource Information

Rate Limiting?

 Yes

Sorting?

 Yes

Paging?

 Yes

Filtering?

 Yes

Response Formats

xml

json

HTTP Methods

GET

Represents the latest 802.11 counters for radio interfaces of lightweight wireless access points collected from controllers.

Resource URL

/webacs/api/v1/data/RFCounters

Since : 1.2

Response Parameters

Type Attribute Name Description

long

ackFailureCount

ACK failure count

String

collectionTime

unix binary time on the server when the collection was performed.

long

failedCount

Failed count

long

fcsErrorCount

FCS error count

long

frameDuplicateCount

Frame duplicate count

String

macAddress

Base radio MAC address

long

multipleRetryCount

Multiple retry count

long

retryCount

Retry count

long

rtsFailureCount

RTS failure count

long

rtsSuccessCount

RTS success count

long

rxFragmentCount

Rx fragement count

long

rxMulticastFrameCount

Rx multicast frame count

String

slotId

Radio slot ID

long

txFragmentCount

Tx fragment count

long

txFrameCount

Tx frame count

long

txMulticastFrameCount

Tx multicast frame count

long

wepUndecryptableCount

WEP undescryptable count

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://192.168.116.207/webacs/api/v1/data/RFCounters/42

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<queryResponse rootUrl="/webacs/data" requestUrl="https://192.168.116.207/webacs/api/v1/data/RFCounters/42" responseType="getEntity">
    <entity url="/webacs/data/className/15" type="className" dtoType="rFCountersDTO_$$_javassist_5979">
        <rfCountersDTO id="15" displayName="String value">
            <ackFailureCount>2</ackFailureCount>
            <collectionTime>String value</collectionTime>
            <failedCount>2</failedCount>
            <fcsErrorCount>2</fcsErrorCount>
            <frameDuplicateCount>2</frameDuplicateCount>
            <macAddress>String value</macAddress>
            <multipleRetryCount>2</multipleRetryCount>
            <retryCount>2</retryCount>
            <rtsFailureCount>2</rtsFailureCount>
            <rtsSuccessCount>2</rtsSuccessCount>
            <rxFragmentCount>2</rxFragmentCount>
            <rxMulticastFrameCount>2</rxMulticastFrameCount>
            <slotId>String value</slotId>
            <txFragmentCount>2</txFragmentCount>
            <txFrameCount>2</txFrameCount>
            <txMulticastFrameCount>2</txMulticastFrameCount>
            <wepUndecryptableCount>2</wepUndecryptableCount>
        </rfCountersDTO>
    </entity>
</queryResponse>

Sample JSON Payload

https://192.168.116.207/webacs/api/v1/data/RFCounters/42.json

{
  "queryResponse" : {
    "@rootUrl" : "\/webacs\/data",
    "@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/data\/RFCounters\/42",
    "@responseType" : "getEntity",
    "entity" : {
      "@url" : "\/webacs\/data\/className\/15",
      "@type" : "className",
      "@dtoType" : "rFCountersDTO_$$_javassist_5979",
      "rfCountersDTO" : {
        "@id" : "15",
        "@displayName" : "String value",
        "ackFailureCount" : 2,
        "collectionTime" : "String value",
        "failedCount" : 2,
        "fcsErrorCount" : 2,
        "frameDuplicateCount" : 2,
        "macAddress" : "String value",
        "multipleRetryCount" : 2,
        "retryCount" : 2,
        "rtsFailureCount" : 2,
        "rtsSuccessCount" : 2,
        "rxFragmentCount" : 2,
        "rxMulticastFrameCount" : 2,
        "slotId" : "String value",
        "txFragmentCount" : 2,
        "txFrameCount" : 2,
        "txMulticastFrameCount" : 2,
        "wepUndecryptableCount" : 2
      }
    }
  }
}