Cisco Prime Infrastructure API
Prime Infrastructure API Documentation
GET_ClientCounts

GET ClientCounts

Resource Information

Rate Limiting?

 Yes

Sorting?

 Yes

Paging?

 Yes

Filtering?

 Yes

Response Formats

xml

json

HTTP Methods

GET

Represents number of clients counted in NCS during last polling cycle. The combination of type, key and subtype represents number of clients associated with the entity.

Resource URL

/webacs/api/v1/data/ClientCounts

Since : 1.2

Response Parameters

Type Attribute Name Description

int

authCount

total authenticated client count on the element in last collection time

long

collectionTime

binary time stamp representing the last collection time

int

count

total client count on the element in last collection time

int

dot11aAuthCount

number of authenticated clients using 802.11a

int

dot11aCount

number of clients using 802.11a

int

dot11bAuthCount

number of authenticated clients using 802.11b

int

dot11bCount

number of clients using 802.11b

int

dot11gAuthCount

number of authenticated clients using 802.11g

int

dot11gCount

number of clients using 802.11g

int

dot11n2_4AuthCount

number of authenticated clients using 802.11n on 2.4 GHz band

int

dot11n2_4Count

number of clients using 802.11n in 2.4 GHz band

int

dot11n5AuthCount

number of authenticated clients using 802.11n on 5 GHz band

int

dot11n5Count

number of clients using 802.11n in 5GHz band

String

key

key represents the element

String

subkey

subkey is used to further categorize client count

ClientCountTypeEnum

type

Type of count element

Allowed values:

  • DEVICE
  • ACCESSPOINT
  • MAPLOCATION
  • SSID
  • VIRTUALDOMAIN
  • GUEST

int

wgbAuthCount

number of authenticated clients connected as WGB or wired guest

int

wgbCount

number of clients connected as WGB or wired guest

int

wired100MAuthCount

number of authenticated wired clients connected to wired switch on 100Mbps port

int

wired100MCount

number of wired clients connected to wired switch on 100Mbps port

int

wired10MAuthCount

number of authenticated wired clients connected to wired switch on 10Mbps port

int

wired10MCount

number of wired clients connected to wired switch on 10Mbps port

int

wired1GAuthCount

number of authenticated wired clients connected to wired switch on 1Gbps port

int

wired1GCount

number of wired clients connected to wired switch on 1Gbps port

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/ClientCounts/42

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<queryResponse rootUrl="/webacs/data" requestUrl="https://192.168.116.207/webacs/api/v1/data/ClientCounts/42" responseType="getEntity">
    <entity url="/webacs/data/className/15" type="className" dtoType="clientCountsDTO_$$_javassist_5995">
        <clientCountsDTO id="15" displayName="String value">
            <authCount>1</authCount>
            <collectionTime>2</collectionTime>
            <count>1</count>
            <dot11aAuthCount>1</dot11aAuthCount>
            <dot11aCount>1</dot11aCount>
            <dot11bAuthCount>1</dot11bAuthCount>
            <dot11bCount>1</dot11bCount>
            <dot11gAuthCount>1</dot11gAuthCount>
            <dot11gCount>1</dot11gCount>
            <dot11n2_4AuthCount>1</dot11n2_4AuthCount>
            <dot11n2_4Count>1</dot11n2_4Count>
            <dot11n5AuthCount>1</dot11n5AuthCount>
            <dot11n5Count>1</dot11n5Count>
            <key>String value</key>
            <subkey>String value</subkey>
            <type>DEVICE</type>
            <wgbAuthCount>1</wgbAuthCount>
            <wgbCount>1</wgbCount>
            <wired100MAuthCount>1</wired100MAuthCount>
            <wired100MCount>1</wired100MCount>
            <wired10MAuthCount>1</wired10MAuthCount>
            <wired10MCount>1</wired10MCount>
            <wired1GAuthCount>1</wired1GAuthCount>
            <wired1GCount>1</wired1GCount>
        </clientCountsDTO>
    </entity>
</queryResponse>

Sample JSON Payload

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

{
  "queryResponse" : {
    "@rootUrl" : "\/webacs\/data",
    "@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/data\/ClientCounts\/42",
    "@responseType" : "getEntity",
    "entity" : {
      "@url" : "\/webacs\/data\/className\/15",
      "@type" : "className",
      "@dtoType" : "clientCountsDTO_$$_javassist_5995",
      "clientCountsDTO" : {
        "@id" : "15",
        "@displayName" : "String value",
        "authCount" : 1,
        "collectionTime" : 2,
        "count" : 1,
        "dot11aAuthCount" : 1,
        "dot11aCount" : 1,
        "dot11bAuthCount" : 1,
        "dot11bCount" : 1,
        "dot11gAuthCount" : 1,
        "dot11gCount" : 1,
        "dot11n2_4AuthCount" : 1,
        "dot11n2_4Count" : 1,
        "dot11n5AuthCount" : 1,
        "dot11n5Count" : 1,
        "key" : "String value",
        "subkey" : "String value",
        "type" : "DEVICE",
        "wgbAuthCount" : 1,
        "wgbCount" : 1,
        "wired100MAuthCount" : 1,
        "wired100MCount" : 1,
        "wired10MAuthCount" : 1,
        "wired10MCount" : 1,
        "wired1GAuthCount" : 1,
        "wired1GCount" : 1
      }
    }
  }
}